software.amazon.awssdk.services.sagemaker.model.DescribeModelResponse Maven / Gradle / Ivy
/*
* 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.time.Instant;
import java.util.Arrays;
import java.util.Collection;
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 java.util.stream.Collectors;
import java.util.stream.Stream;
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.ListTrait;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructList;
import software.amazon.awssdk.core.util.SdkAutoConstructList;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*/
@Generated("software.amazon.awssdk:codegen")
public final class DescribeModelResponse extends SageMakerResponse implements
ToCopyableBuilder {
private static final SdkField MODEL_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("ModelName").getter(getter(DescribeModelResponse::modelName)).setter(setter(Builder::modelName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ModelName").build()).build();
private static final SdkField PRIMARY_CONTAINER_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("PrimaryContainer")
.getter(getter(DescribeModelResponse::primaryContainer)).setter(setter(Builder::primaryContainer))
.constructor(ContainerDefinition::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("PrimaryContainer").build()).build();
private static final SdkField> CONTAINERS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Containers")
.getter(getter(DescribeModelResponse::containers))
.setter(setter(Builder::containers))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Containers").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(ContainerDefinition::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField INFERENCE_EXECUTION_CONFIG_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("InferenceExecutionConfig")
.getter(getter(DescribeModelResponse::inferenceExecutionConfig)).setter(setter(Builder::inferenceExecutionConfig))
.constructor(InferenceExecutionConfig::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("InferenceExecutionConfig").build())
.build();
private static final SdkField EXECUTION_ROLE_ARN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("ExecutionRoleArn").getter(getter(DescribeModelResponse::executionRoleArn))
.setter(setter(Builder::executionRoleArn))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ExecutionRoleArn").build()).build();
private static final SdkField VPC_CONFIG_FIELD = SdkField. builder(MarshallingType.SDK_POJO)
.memberName("VpcConfig").getter(getter(DescribeModelResponse::vpcConfig)).setter(setter(Builder::vpcConfig))
.constructor(VpcConfig::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("VpcConfig").build()).build();
private static final SdkField CREATION_TIME_FIELD = SdkField. builder(MarshallingType.INSTANT)
.memberName("CreationTime").getter(getter(DescribeModelResponse::creationTime)).setter(setter(Builder::creationTime))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("CreationTime").build()).build();
private static final SdkField MODEL_ARN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("ModelArn").getter(getter(DescribeModelResponse::modelArn)).setter(setter(Builder::modelArn))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ModelArn").build()).build();
private static final SdkField ENABLE_NETWORK_ISOLATION_FIELD = SdkField. builder(MarshallingType.BOOLEAN)
.memberName("EnableNetworkIsolation").getter(getter(DescribeModelResponse::enableNetworkIsolation))
.setter(setter(Builder::enableNetworkIsolation))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("EnableNetworkIsolation").build())
.build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(MODEL_NAME_FIELD,
PRIMARY_CONTAINER_FIELD, CONTAINERS_FIELD, INFERENCE_EXECUTION_CONFIG_FIELD, EXECUTION_ROLE_ARN_FIELD,
VPC_CONFIG_FIELD, CREATION_TIME_FIELD, MODEL_ARN_FIELD, ENABLE_NETWORK_ISOLATION_FIELD));
private final String modelName;
private final ContainerDefinition primaryContainer;
private final List containers;
private final InferenceExecutionConfig inferenceExecutionConfig;
private final String executionRoleArn;
private final VpcConfig vpcConfig;
private final Instant creationTime;
private final String modelArn;
private final Boolean enableNetworkIsolation;
private DescribeModelResponse(BuilderImpl builder) {
super(builder);
this.modelName = builder.modelName;
this.primaryContainer = builder.primaryContainer;
this.containers = builder.containers;
this.inferenceExecutionConfig = builder.inferenceExecutionConfig;
this.executionRoleArn = builder.executionRoleArn;
this.vpcConfig = builder.vpcConfig;
this.creationTime = builder.creationTime;
this.modelArn = builder.modelArn;
this.enableNetworkIsolation = builder.enableNetworkIsolation;
}
/**
*
* Name of the Amazon SageMaker model.
*
*
* @return Name of the Amazon SageMaker model.
*/
public final String modelName() {
return modelName;
}
/**
*
* The location of the primary inference code, associated artifacts, and custom environment map that the inference
* code uses when it is deployed in production.
*
*
* @return The location of the primary inference code, associated artifacts, and custom environment map that the
* inference code uses when it is deployed in production.
*/
public final ContainerDefinition primaryContainer() {
return primaryContainer;
}
/**
* Returns true if the Containers property was specified by the sender (it may be empty), or false if the sender did
* not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
*/
public final boolean hasContainers() {
return containers != null && !(containers instanceof SdkAutoConstructList);
}
/**
*
* The containers in the inference pipeline.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* You can use {@link #hasContainers()} to see if a value was sent in this field.
*
*
* @return The containers in the inference pipeline.
*/
public final List containers() {
return containers;
}
/**
*
* Specifies details of how containers in a multi-container endpoint are called.
*
*
* @return Specifies details of how containers in a multi-container endpoint are called.
*/
public final InferenceExecutionConfig inferenceExecutionConfig() {
return inferenceExecutionConfig;
}
/**
*
* The Amazon Resource Name (ARN) of the IAM role that you specified for the model.
*
*
* @return The Amazon Resource Name (ARN) of the IAM role that you specified for the model.
*/
public final String executionRoleArn() {
return executionRoleArn;
}
/**
*
* A VpcConfig object that specifies the VPC that this model has access to. For more information, see Protect Endpoints by Using an Amazon Virtual
* Private Cloud
*
*
* @return A VpcConfig object that specifies the VPC that this model has access to. For more information, see
* Protect Endpoints by Using an
* Amazon Virtual Private Cloud
*/
public final VpcConfig vpcConfig() {
return vpcConfig;
}
/**
*
* A timestamp that shows when the model was created.
*
*
* @return A timestamp that shows when the model was created.
*/
public final Instant creationTime() {
return creationTime;
}
/**
*
* The Amazon Resource Name (ARN) of the model.
*
*
* @return The Amazon Resource Name (ARN) of the model.
*/
public final String modelArn() {
return modelArn;
}
/**
*
* If True, no inbound or outbound network calls can be made to or from the model container.
*
*
* @return If True, no inbound or outbound network calls can be made to or from the model container.
*/
public final Boolean enableNetworkIsolation() {
return enableNetworkIsolation;
}
@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 + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(modelName());
hashCode = 31 * hashCode + Objects.hashCode(primaryContainer());
hashCode = 31 * hashCode + Objects.hashCode(hasContainers() ? containers() : null);
hashCode = 31 * hashCode + Objects.hashCode(inferenceExecutionConfig());
hashCode = 31 * hashCode + Objects.hashCode(executionRoleArn());
hashCode = 31 * hashCode + Objects.hashCode(vpcConfig());
hashCode = 31 * hashCode + Objects.hashCode(creationTime());
hashCode = 31 * hashCode + Objects.hashCode(modelArn());
hashCode = 31 * hashCode + Objects.hashCode(enableNetworkIsolation());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return super.equals(obj) && equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof DescribeModelResponse)) {
return false;
}
DescribeModelResponse other = (DescribeModelResponse) obj;
return Objects.equals(modelName(), other.modelName()) && Objects.equals(primaryContainer(), other.primaryContainer())
&& hasContainers() == other.hasContainers() && Objects.equals(containers(), other.containers())
&& Objects.equals(inferenceExecutionConfig(), other.inferenceExecutionConfig())
&& Objects.equals(executionRoleArn(), other.executionRoleArn()) && Objects.equals(vpcConfig(), other.vpcConfig())
&& Objects.equals(creationTime(), other.creationTime()) && Objects.equals(modelArn(), other.modelArn())
&& Objects.equals(enableNetworkIsolation(), other.enableNetworkIsolation());
}
/**
* 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("DescribeModelResponse").add("ModelName", modelName())
.add("PrimaryContainer", primaryContainer()).add("Containers", hasContainers() ? containers() : null)
.add("InferenceExecutionConfig", inferenceExecutionConfig()).add("ExecutionRoleArn", executionRoleArn())
.add("VpcConfig", vpcConfig()).add("CreationTime", creationTime()).add("ModelArn", modelArn())
.add("EnableNetworkIsolation", enableNetworkIsolation()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "ModelName":
return Optional.ofNullable(clazz.cast(modelName()));
case "PrimaryContainer":
return Optional.ofNullable(clazz.cast(primaryContainer()));
case "Containers":
return Optional.ofNullable(clazz.cast(containers()));
case "InferenceExecutionConfig":
return Optional.ofNullable(clazz.cast(inferenceExecutionConfig()));
case "ExecutionRoleArn":
return Optional.ofNullable(clazz.cast(executionRoleArn()));
case "VpcConfig":
return Optional.ofNullable(clazz.cast(vpcConfig()));
case "CreationTime":
return Optional.ofNullable(clazz.cast(creationTime()));
case "ModelArn":
return Optional.ofNullable(clazz.cast(modelArn()));
case "EnableNetworkIsolation":
return Optional.ofNullable(clazz.cast(enableNetworkIsolation()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((DescribeModelResponse) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SageMakerResponse.Builder, SdkPojo, CopyableBuilder {
/**
*
* Name of the Amazon SageMaker model.
*
*
* @param modelName
* Name of the Amazon SageMaker model.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder modelName(String modelName);
/**
*
* The location of the primary inference code, associated artifacts, and custom environment map that the
* inference code uses when it is deployed in production.
*
*
* @param primaryContainer
* The location of the primary inference code, associated artifacts, and custom environment map that the
* inference code uses when it is deployed in production.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder primaryContainer(ContainerDefinition primaryContainer);
/**
*
* The location of the primary inference code, associated artifacts, and custom environment map that the
* inference code uses when it is deployed in production.
*
* This is a convenience that creates an instance of the {@link ContainerDefinition.Builder} avoiding the need
* to create one manually via {@link ContainerDefinition#builder()}.
*
* When the {@link Consumer} completes, {@link ContainerDefinition.Builder#build()} is called immediately and
* its result is passed to {@link #primaryContainer(ContainerDefinition)}.
*
* @param primaryContainer
* a consumer that will call methods on {@link ContainerDefinition.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #primaryContainer(ContainerDefinition)
*/
default Builder primaryContainer(Consumer primaryContainer) {
return primaryContainer(ContainerDefinition.builder().applyMutation(primaryContainer).build());
}
/**
*
* The containers in the inference pipeline.
*
*
* @param containers
* The containers in the inference pipeline.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder containers(Collection containers);
/**
*
* The containers in the inference pipeline.
*
*
* @param containers
* The containers in the inference pipeline.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder containers(ContainerDefinition... containers);
/**
*
* The containers in the inference pipeline.
*
* This is a convenience that creates an instance of the {@link List.Builder} avoiding the
* need to create one manually via {@link List#builder()}.
*
* When the {@link Consumer} completes, {@link List.Builder#build()} is called immediately
* and its result is passed to {@link #containers(List)}.
*
* @param containers
* a consumer that will call methods on {@link List.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #containers(List)
*/
Builder containers(Consumer... containers);
/**
*
* Specifies details of how containers in a multi-container endpoint are called.
*
*
* @param inferenceExecutionConfig
* Specifies details of how containers in a multi-container endpoint are called.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder inferenceExecutionConfig(InferenceExecutionConfig inferenceExecutionConfig);
/**
*
* Specifies details of how containers in a multi-container endpoint are called.
*
* This is a convenience that creates an instance of the {@link InferenceExecutionConfig.Builder} avoiding the
* need to create one manually via {@link InferenceExecutionConfig#builder()}.
*
* When the {@link Consumer} completes, {@link InferenceExecutionConfig.Builder#build()} is called immediately
* and its result is passed to {@link #inferenceExecutionConfig(InferenceExecutionConfig)}.
*
* @param inferenceExecutionConfig
* a consumer that will call methods on {@link InferenceExecutionConfig.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #inferenceExecutionConfig(InferenceExecutionConfig)
*/
default Builder inferenceExecutionConfig(Consumer inferenceExecutionConfig) {
return inferenceExecutionConfig(InferenceExecutionConfig.builder().applyMutation(inferenceExecutionConfig).build());
}
/**
*
* The Amazon Resource Name (ARN) of the IAM role that you specified for the model.
*
*
* @param executionRoleArn
* The Amazon Resource Name (ARN) of the IAM role that you specified for the model.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder executionRoleArn(String executionRoleArn);
/**
*
* A VpcConfig object that specifies the VPC that this model has access to. For more information, see Protect Endpoints by Using an Amazon
* Virtual Private Cloud
*
*
* @param vpcConfig
* A VpcConfig object that specifies the VPC that this model has access to. For more information,
* see Protect Endpoints by Using
* an Amazon Virtual Private Cloud
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder vpcConfig(VpcConfig vpcConfig);
/**
*
* A VpcConfig object that specifies the VPC that this model has access to. For more information, see Protect Endpoints by Using an Amazon
* Virtual Private Cloud
*
* This is a convenience that creates an instance of the {@link VpcConfig.Builder} avoiding the need to create
* one manually via {@link VpcConfig#builder()}.
*
* When the {@link Consumer} completes, {@link VpcConfig.Builder#build()} is called immediately and its result
* is passed to {@link #vpcConfig(VpcConfig)}.
*
* @param vpcConfig
* a consumer that will call methods on {@link VpcConfig.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #vpcConfig(VpcConfig)
*/
default Builder vpcConfig(Consumer vpcConfig) {
return vpcConfig(VpcConfig.builder().applyMutation(vpcConfig).build());
}
/**
*
* A timestamp that shows when the model was created.
*
*
* @param creationTime
* A timestamp that shows when the model was created.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder creationTime(Instant creationTime);
/**
*
* The Amazon Resource Name (ARN) of the model.
*
*
* @param modelArn
* The Amazon Resource Name (ARN) of the model.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder modelArn(String modelArn);
/**
*
* If True, no inbound or outbound network calls can be made to or from the model container.
*
*
* @param enableNetworkIsolation
* If True, no inbound or outbound network calls can be made to or from the model container.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder enableNetworkIsolation(Boolean enableNetworkIsolation);
}
static final class BuilderImpl extends SageMakerResponse.BuilderImpl implements Builder {
private String modelName;
private ContainerDefinition primaryContainer;
private List containers = DefaultSdkAutoConstructList.getInstance();
private InferenceExecutionConfig inferenceExecutionConfig;
private String executionRoleArn;
private VpcConfig vpcConfig;
private Instant creationTime;
private String modelArn;
private Boolean enableNetworkIsolation;
private BuilderImpl() {
}
private BuilderImpl(DescribeModelResponse model) {
super(model);
modelName(model.modelName);
primaryContainer(model.primaryContainer);
containers(model.containers);
inferenceExecutionConfig(model.inferenceExecutionConfig);
executionRoleArn(model.executionRoleArn);
vpcConfig(model.vpcConfig);
creationTime(model.creationTime);
modelArn(model.modelArn);
enableNetworkIsolation(model.enableNetworkIsolation);
}
public final String getModelName() {
return modelName;
}
@Override
public final Builder modelName(String modelName) {
this.modelName = modelName;
return this;
}
public final void setModelName(String modelName) {
this.modelName = modelName;
}
public final ContainerDefinition.Builder getPrimaryContainer() {
return primaryContainer != null ? primaryContainer.toBuilder() : null;
}
@Override
public final Builder primaryContainer(ContainerDefinition primaryContainer) {
this.primaryContainer = primaryContainer;
return this;
}
public final void setPrimaryContainer(ContainerDefinition.BuilderImpl primaryContainer) {
this.primaryContainer = primaryContainer != null ? primaryContainer.build() : null;
}
public final List getContainers() {
List result = ContainerDefinitionListCopier.copyToBuilder(this.containers);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
@Override
public final Builder containers(Collection containers) {
this.containers = ContainerDefinitionListCopier.copy(containers);
return this;
}
@Override
@SafeVarargs
public final Builder containers(ContainerDefinition... containers) {
containers(Arrays.asList(containers));
return this;
}
@Override
@SafeVarargs
public final Builder containers(Consumer... containers) {
containers(Stream.of(containers).map(c -> ContainerDefinition.builder().applyMutation(c).build())
.collect(Collectors.toList()));
return this;
}
public final void setContainers(Collection containers) {
this.containers = ContainerDefinitionListCopier.copyFromBuilder(containers);
}
public final InferenceExecutionConfig.Builder getInferenceExecutionConfig() {
return inferenceExecutionConfig != null ? inferenceExecutionConfig.toBuilder() : null;
}
@Override
public final Builder inferenceExecutionConfig(InferenceExecutionConfig inferenceExecutionConfig) {
this.inferenceExecutionConfig = inferenceExecutionConfig;
return this;
}
public final void setInferenceExecutionConfig(InferenceExecutionConfig.BuilderImpl inferenceExecutionConfig) {
this.inferenceExecutionConfig = inferenceExecutionConfig != null ? inferenceExecutionConfig.build() : null;
}
public final String getExecutionRoleArn() {
return executionRoleArn;
}
@Override
public final Builder executionRoleArn(String executionRoleArn) {
this.executionRoleArn = executionRoleArn;
return this;
}
public final void setExecutionRoleArn(String executionRoleArn) {
this.executionRoleArn = executionRoleArn;
}
public final VpcConfig.Builder getVpcConfig() {
return vpcConfig != null ? vpcConfig.toBuilder() : null;
}
@Override
public final Builder vpcConfig(VpcConfig vpcConfig) {
this.vpcConfig = vpcConfig;
return this;
}
public final void setVpcConfig(VpcConfig.BuilderImpl vpcConfig) {
this.vpcConfig = vpcConfig != null ? vpcConfig.build() : null;
}
public final Instant getCreationTime() {
return creationTime;
}
@Override
public final Builder creationTime(Instant creationTime) {
this.creationTime = creationTime;
return this;
}
public final void setCreationTime(Instant creationTime) {
this.creationTime = creationTime;
}
public final String getModelArn() {
return modelArn;
}
@Override
public final Builder modelArn(String modelArn) {
this.modelArn = modelArn;
return this;
}
public final void setModelArn(String modelArn) {
this.modelArn = modelArn;
}
public final Boolean getEnableNetworkIsolation() {
return enableNetworkIsolation;
}
@Override
public final Builder enableNetworkIsolation(Boolean enableNetworkIsolation) {
this.enableNetworkIsolation = enableNetworkIsolation;
return this;
}
public final void setEnableNetworkIsolation(Boolean enableNetworkIsolation) {
this.enableNetworkIsolation = enableNetworkIsolation;
}
@Override
public DescribeModelResponse build() {
return new DescribeModelResponse(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy