software.amazon.awssdk.services.sagemaker.model.InferenceComponentSpecification Maven / Gradle / Ivy
Show all versions of sagemaker Show documentation
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package software.amazon.awssdk.services.sagemaker.model;
import java.io.Serializable;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Consumer;
import java.util.function.Function;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* Details about the resources to deploy with this inference component, including the model, container, and compute
* resources.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class InferenceComponentSpecification implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField MODEL_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("ModelName").getter(getter(InferenceComponentSpecification::modelName))
.setter(setter(Builder::modelName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ModelName").build()).build();
private static final SdkField CONTAINER_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("Container")
.getter(getter(InferenceComponentSpecification::container)).setter(setter(Builder::container))
.constructor(InferenceComponentContainerSpecification::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Container").build()).build();
private static final SdkField STARTUP_PARAMETERS_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("StartupParameters")
.getter(getter(InferenceComponentSpecification::startupParameters)).setter(setter(Builder::startupParameters))
.constructor(InferenceComponentStartupParameters::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("StartupParameters").build()).build();
private static final SdkField COMPUTE_RESOURCE_REQUIREMENTS_FIELD = SdkField
. builder(MarshallingType.SDK_POJO)
.memberName("ComputeResourceRequirements")
.getter(getter(InferenceComponentSpecification::computeResourceRequirements))
.setter(setter(Builder::computeResourceRequirements))
.constructor(InferenceComponentComputeResourceRequirements::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ComputeResourceRequirements")
.build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(MODEL_NAME_FIELD,
CONTAINER_FIELD, STARTUP_PARAMETERS_FIELD, COMPUTE_RESOURCE_REQUIREMENTS_FIELD));
private static final long serialVersionUID = 1L;
private final String modelName;
private final InferenceComponentContainerSpecification container;
private final InferenceComponentStartupParameters startupParameters;
private final InferenceComponentComputeResourceRequirements computeResourceRequirements;
private InferenceComponentSpecification(BuilderImpl builder) {
this.modelName = builder.modelName;
this.container = builder.container;
this.startupParameters = builder.startupParameters;
this.computeResourceRequirements = builder.computeResourceRequirements;
}
/**
*
* The name of an existing SageMaker model object in your account that you want to deploy with the inference
* component.
*
*
* @return The name of an existing SageMaker model object in your account that you want to deploy with the inference
* component.
*/
public final String modelName() {
return modelName;
}
/**
*
* Defines a container that provides the runtime environment for a model that you deploy with an inference
* component.
*
*
* @return Defines a container that provides the runtime environment for a model that you deploy with an inference
* component.
*/
public final InferenceComponentContainerSpecification container() {
return container;
}
/**
*
* Settings that take effect while the model container starts up.
*
*
* @return Settings that take effect while the model container starts up.
*/
public final InferenceComponentStartupParameters startupParameters() {
return startupParameters;
}
/**
*
* The compute resources allocated to run the model assigned to the inference component.
*
*
* @return The compute resources allocated to run the model assigned to the inference component.
*/
public final InferenceComponentComputeResourceRequirements computeResourceRequirements() {
return computeResourceRequirements;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + Objects.hashCode(modelName());
hashCode = 31 * hashCode + Objects.hashCode(container());
hashCode = 31 * hashCode + Objects.hashCode(startupParameters());
hashCode = 31 * hashCode + Objects.hashCode(computeResourceRequirements());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof InferenceComponentSpecification)) {
return false;
}
InferenceComponentSpecification other = (InferenceComponentSpecification) obj;
return Objects.equals(modelName(), other.modelName()) && Objects.equals(container(), other.container())
&& Objects.equals(startupParameters(), other.startupParameters())
&& Objects.equals(computeResourceRequirements(), other.computeResourceRequirements());
}
/**
* Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be
* redacted from this string using a placeholder value.
*/
@Override
public final String toString() {
return ToString.builder("InferenceComponentSpecification").add("ModelName", modelName()).add("Container", container())
.add("StartupParameters", startupParameters()).add("ComputeResourceRequirements", computeResourceRequirements())
.build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "ModelName":
return Optional.ofNullable(clazz.cast(modelName()));
case "Container":
return Optional.ofNullable(clazz.cast(container()));
case "StartupParameters":
return Optional.ofNullable(clazz.cast(startupParameters()));
case "ComputeResourceRequirements":
return Optional.ofNullable(clazz.cast(computeResourceRequirements()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((InferenceComponentSpecification) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The name of an existing SageMaker model object in your account that you want to deploy with the inference
* component.
*
*
* @param modelName
* The name of an existing SageMaker model object in your account that you want to deploy with the
* inference component.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder modelName(String modelName);
/**
*
* Defines a container that provides the runtime environment for a model that you deploy with an inference
* component.
*
*
* @param container
* Defines a container that provides the runtime environment for a model that you deploy with an
* inference component.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder container(InferenceComponentContainerSpecification container);
/**
*
* Defines a container that provides the runtime environment for a model that you deploy with an inference
* component.
*
* This is a convenience method that creates an instance of the
* {@link InferenceComponentContainerSpecification.Builder} avoiding the need to create one manually via
* {@link InferenceComponentContainerSpecification#builder()}.
*
*
* When the {@link Consumer} completes, {@link InferenceComponentContainerSpecification.Builder#build()} is
* called immediately and its result is passed to {@link #container(InferenceComponentContainerSpecification)}.
*
* @param container
* a consumer that will call methods on {@link InferenceComponentContainerSpecification.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #container(InferenceComponentContainerSpecification)
*/
default Builder container(Consumer container) {
return container(InferenceComponentContainerSpecification.builder().applyMutation(container).build());
}
/**
*
* Settings that take effect while the model container starts up.
*
*
* @param startupParameters
* Settings that take effect while the model container starts up.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder startupParameters(InferenceComponentStartupParameters startupParameters);
/**
*
* Settings that take effect while the model container starts up.
*
* This is a convenience method that creates an instance of the
* {@link InferenceComponentStartupParameters.Builder} avoiding the need to create one manually via
* {@link InferenceComponentStartupParameters#builder()}.
*
*
* When the {@link Consumer} completes, {@link InferenceComponentStartupParameters.Builder#build()} is called
* immediately and its result is passed to {@link #startupParameters(InferenceComponentStartupParameters)}.
*
* @param startupParameters
* a consumer that will call methods on {@link InferenceComponentStartupParameters.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #startupParameters(InferenceComponentStartupParameters)
*/
default Builder startupParameters(Consumer startupParameters) {
return startupParameters(InferenceComponentStartupParameters.builder().applyMutation(startupParameters).build());
}
/**
*
* The compute resources allocated to run the model assigned to the inference component.
*
*
* @param computeResourceRequirements
* The compute resources allocated to run the model assigned to the inference component.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder computeResourceRequirements(InferenceComponentComputeResourceRequirements computeResourceRequirements);
/**
*
* The compute resources allocated to run the model assigned to the inference component.
*
* This is a convenience method that creates an instance of the
* {@link InferenceComponentComputeResourceRequirements.Builder} avoiding the need to create one manually via
* {@link InferenceComponentComputeResourceRequirements#builder()}.
*
*
* When the {@link Consumer} completes, {@link InferenceComponentComputeResourceRequirements.Builder#build()} is
* called immediately and its result is passed to
* {@link #computeResourceRequirements(InferenceComponentComputeResourceRequirements)}.
*
* @param computeResourceRequirements
* a consumer that will call methods on {@link InferenceComponentComputeResourceRequirements.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #computeResourceRequirements(InferenceComponentComputeResourceRequirements)
*/
default Builder computeResourceRequirements(
Consumer computeResourceRequirements) {
return computeResourceRequirements(InferenceComponentComputeResourceRequirements.builder()
.applyMutation(computeResourceRequirements).build());
}
}
static final class BuilderImpl implements Builder {
private String modelName;
private InferenceComponentContainerSpecification container;
private InferenceComponentStartupParameters startupParameters;
private InferenceComponentComputeResourceRequirements computeResourceRequirements;
private BuilderImpl() {
}
private BuilderImpl(InferenceComponentSpecification model) {
modelName(model.modelName);
container(model.container);
startupParameters(model.startupParameters);
computeResourceRequirements(model.computeResourceRequirements);
}
public final String getModelName() {
return modelName;
}
public final void setModelName(String modelName) {
this.modelName = modelName;
}
@Override
public final Builder modelName(String modelName) {
this.modelName = modelName;
return this;
}
public final InferenceComponentContainerSpecification.Builder getContainer() {
return container != null ? container.toBuilder() : null;
}
public final void setContainer(InferenceComponentContainerSpecification.BuilderImpl container) {
this.container = container != null ? container.build() : null;
}
@Override
public final Builder container(InferenceComponentContainerSpecification container) {
this.container = container;
return this;
}
public final InferenceComponentStartupParameters.Builder getStartupParameters() {
return startupParameters != null ? startupParameters.toBuilder() : null;
}
public final void setStartupParameters(InferenceComponentStartupParameters.BuilderImpl startupParameters) {
this.startupParameters = startupParameters != null ? startupParameters.build() : null;
}
@Override
public final Builder startupParameters(InferenceComponentStartupParameters startupParameters) {
this.startupParameters = startupParameters;
return this;
}
public final InferenceComponentComputeResourceRequirements.Builder getComputeResourceRequirements() {
return computeResourceRequirements != null ? computeResourceRequirements.toBuilder() : null;
}
public final void setComputeResourceRequirements(
InferenceComponentComputeResourceRequirements.BuilderImpl computeResourceRequirements) {
this.computeResourceRequirements = computeResourceRequirements != null ? computeResourceRequirements.build() : null;
}
@Override
public final Builder computeResourceRequirements(InferenceComponentComputeResourceRequirements computeResourceRequirements) {
this.computeResourceRequirements = computeResourceRequirements;
return this;
}
@Override
public InferenceComponentSpecification build() {
return new InferenceComponentSpecification(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}