software.amazon.awssdk.services.sagemaker.model

Class InferenceSpecification

java.lang.Object

software.amazon.awssdk.services.sagemaker.model.InferenceSpecification

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<InferenceSpecification.Builder,InferenceSpecification>

@Generated(value="software.amazon.awssdk:codegen")
public final class InferenceSpecification
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<InferenceSpecification.Builder,InferenceSpecification>

Defines how to perform inference generation after a training job is run.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	InferenceSpecification.Builder

Method Summary

Modifier and Type	Method and Description
static InferenceSpecification.Builder	builder()
List<ModelPackageContainerDefinition>	containers() The Amazon ECR registry path of the Docker image that contains the inference code.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasContainers() 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).
int	hashCode()
boolean	hasSupportedContentTypes() Returns true if the SupportedContentTypes property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
boolean	hasSupportedRealtimeInferenceInstanceTypes() Returns true if the SupportedRealtimeInferenceInstanceTypes property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
boolean	hasSupportedResponseMIMETypes() Returns true if the SupportedResponseMIMETypes property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
boolean	hasSupportedTransformInstanceTypes() Returns true if the SupportedTransformInstanceTypes property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
List<SdkField<?>>	sdkFields()
static Class<? extends InferenceSpecification.Builder>	serializableBuilderClass()
List<String>	supportedContentTypes() The supported MIME types for the input data.
List<ProductionVariantInstanceType>	supportedRealtimeInferenceInstanceTypes() A list of the instance types that are used to generate inferences in real-time.
List<String>	supportedRealtimeInferenceInstanceTypesAsStrings() A list of the instance types that are used to generate inferences in real-time.
List<String>	supportedResponseMIMETypes() The supported MIME types for the output data.
List<TransformInstanceType>	supportedTransformInstanceTypes() A list of the instance types on which a transformation job can be run or on which an endpoint can be deployed.
List<String>	supportedTransformInstanceTypesAsStrings() A list of the instance types on which a transformation job can be run or on which an endpoint can be deployed.
InferenceSpecification.Builder	toBuilder()
String	toString() Returns a string representation of this object.

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

hasContainers

public final boolean hasContainers()

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.

containers

public final List<ModelPackageContainerDefinition> containers()

The Amazon ECR registry path of the Docker image that contains the inference code.

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

You can use hasContainers() to see if a value was sent in this field.

Returns:

The Amazon ECR registry path of the Docker image that contains the inference code.

supportedTransformInstanceTypes

public final List<TransformInstanceType> supportedTransformInstanceTypes()

A list of the instance types on which a transformation job can be run or on which an endpoint can be deployed.

This parameter is required for unversioned models, and optional for versioned models.

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

You can use hasSupportedTransformInstanceTypes() to see if a value was sent in this field.

Returns:

A list of the instance types on which a transformation job can be run or on which an endpoint can be deployed.

This parameter is required for unversioned models, and optional for versioned models.

hasSupportedTransformInstanceTypes

public final boolean hasSupportedTransformInstanceTypes()

Returns true if the SupportedTransformInstanceTypes 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.

supportedTransformInstanceTypesAsStrings

public final List<String> supportedTransformInstanceTypesAsStrings()

A list of the instance types on which a transformation job can be run or on which an endpoint can be deployed.

This parameter is required for unversioned models, and optional for versioned models.

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

You can use hasSupportedTransformInstanceTypes() to see if a value was sent in this field.

Returns:

A list of the instance types on which a transformation job can be run or on which an endpoint can be deployed.

This parameter is required for unversioned models, and optional for versioned models.

supportedRealtimeInferenceInstanceTypes

public final List<ProductionVariantInstanceType> supportedRealtimeInferenceInstanceTypes()

A list of the instance types that are used to generate inferences in real-time.

This parameter is required for unversioned models, and optional for versioned models.

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

You can use hasSupportedRealtimeInferenceInstanceTypes() to see if a value was sent in this field.

Returns:

A list of the instance types that are used to generate inferences in real-time.

This parameter is required for unversioned models, and optional for versioned models.

hasSupportedRealtimeInferenceInstanceTypes

public final boolean hasSupportedRealtimeInferenceInstanceTypes()

Returns true if the SupportedRealtimeInferenceInstanceTypes 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.

supportedRealtimeInferenceInstanceTypesAsStrings

public final List<String> supportedRealtimeInferenceInstanceTypesAsStrings()

A list of the instance types that are used to generate inferences in real-time.

This parameter is required for unversioned models, and optional for versioned models.

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

You can use hasSupportedRealtimeInferenceInstanceTypes() to see if a value was sent in this field.

Returns:

A list of the instance types that are used to generate inferences in real-time.

This parameter is required for unversioned models, and optional for versioned models.

hasSupportedContentTypes

public final boolean hasSupportedContentTypes()

Returns true if the SupportedContentTypes 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.

supportedContentTypes

public final List<String> supportedContentTypes()

The supported MIME types for the input data.

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

You can use hasSupportedContentTypes() to see if a value was sent in this field.

Returns:

The supported MIME types for the input data.

hasSupportedResponseMIMETypes

public final boolean hasSupportedResponseMIMETypes()

Returns true if the SupportedResponseMIMETypes 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.

supportedResponseMIMETypes

public final List<String> supportedResponseMIMETypes()

The supported MIME types for the output data.

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

You can use hasSupportedResponseMIMETypes() to see if a value was sent in this field.

Returns:

The supported MIME types for the output data.

toBuilder

public InferenceSpecification.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<InferenceSpecification.Builder,InferenceSpecification>

builder

public static InferenceSpecification.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

sdkFields

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

Specified by:

sdkFields in interface SdkPojo