software.amazon.awssdk.services.sagemaker.model

Class DescribeModelResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.sagemaker.model.SageMakerResponse

software.amazon.awssdk.services.sagemaker.model.DescribeModelResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeModelResponse.Builder,DescribeModelResponse>

@Generated(value="software.amazon.awssdk:codegen")
public final class DescribeModelResponse
extends SageMakerResponse
implements ToCopyableBuilder<DescribeModelResponse.Builder,DescribeModelResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DescribeModelResponse.Builder

Method Summary

Modifier and Type	Method and Description
static DescribeModelResponse.Builder	builder()
List<ContainerDefinition>	containers() The containers in the inference pipeline.
Instant	creationTime() A timestamp that shows when the model was created.
DeploymentRecommendation	deploymentRecommendation() A set of recommended deployment configurations for the model.
Boolean	enableNetworkIsolation() If True, no inbound or outbound network calls can be made to or from the model container.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	executionRoleArn() The Amazon Resource Name (ARN) of the IAM role that you specified for the model.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasContainers() For responses, this returns true if the service returned a value for the Containers property.
int	hashCode()
InferenceExecutionConfig	inferenceExecutionConfig() Specifies details of how containers in a multi-container endpoint are called.
String	modelArn() The Amazon Resource Name (ARN) of the model.
String	modelName() Name of the SageMaker model.
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.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeModelResponse.Builder>	serializableBuilderClass()
DescribeModelResponse.Builder	toBuilder()
String	toString() Returns a string representation of this object.
VpcConfig	vpcConfig() A VpcConfig object that specifies the VPC that this model has access to.

Methods inherited from class software.amazon.awssdk.services.sagemaker.model.SageMakerResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

modelName

public final String modelName()

Name of the SageMaker model.

Returns:

Name of the SageMaker model.

primaryContainer

public final 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.

Returns:

The location of the primary inference code, associated artifacts, and custom environment map that the inference code uses when it is deployed in production.

hasContainers

public final boolean hasContainers()

For responses, this returns true if the service returned a value for the Containers property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

containers

public final List<ContainerDefinition> containers()

The containers in the inference pipeline.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasContainers() method.

Returns:

The containers in the inference pipeline.

inferenceExecutionConfig

public final InferenceExecutionConfig inferenceExecutionConfig()

Specifies details of how containers in a multi-container endpoint are called.

Returns:

Specifies details of how containers in a multi-container endpoint are called.

executionRoleArn

public final String executionRoleArn()

The Amazon Resource Name (ARN) of the IAM role that you specified for the model.

Returns:

The Amazon Resource Name (ARN) of the IAM role that you specified for the model.

vpcConfig

public final 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

Returns:

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

creationTime

public final Instant creationTime()

A timestamp that shows when the model was created.

Returns:

A timestamp that shows when the model was created.

modelArn

public final String modelArn()

The Amazon Resource Name (ARN) of the model.

Returns:

The Amazon Resource Name (ARN) of the model.

enableNetworkIsolation

public final Boolean enableNetworkIsolation()

If True, no inbound or outbound network calls can be made to or from the model container.

Returns:

If True, no inbound or outbound network calls can be made to or from the model container.

deploymentRecommendation

public final DeploymentRecommendation deploymentRecommendation()

A set of recommended deployment configurations for the model.

Returns:

A set of recommended deployment configurations for the model.

toBuilder

public DescribeModelResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeModelResponse.Builder,DescribeModelResponse>

Overrides:

toBuilder in class AwsResponse

builder

public static DescribeModelResponse.Builder builder()

serializableBuilderClass

public static Class<? extends DescribeModelResponse.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

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.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkResponse

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo