Class InferenceSpecification
- java.lang.Object
-
- software.amazon.awssdk.services.sagemaker.model.InferenceSpecification
-
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<InferenceSpecification.Builder,InferenceSpecification>
@Generated("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 Description static interface
InferenceSpecification.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method 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()
For responses, this returns true if the service returned a value for the Containers property.int
hashCode()
boolean
hasSupportedContentTypes()
For responses, this returns true if the service returned a value for the SupportedContentTypes property.boolean
hasSupportedRealtimeInferenceInstanceTypes()
For responses, this returns true if the service returned a value for the SupportedRealtimeInferenceInstanceTypes property.boolean
hasSupportedResponseMIMETypes()
For responses, this returns true if the service returned a value for the SupportedResponseMIMETypes property.boolean
hasSupportedTransformInstanceTypes()
For responses, this returns true if the service returned a value for the SupportedTransformInstanceTypes property.Map<String,SdkField<?>>
sdkFieldNameToField()
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()
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 theisEmpty()
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<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.
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 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.
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
hasSupportedTransformInstanceTypes()
method.- 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()
For responses, this returns true if the service returned a value for the SupportedTransformInstanceTypes property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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.
-
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.
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
hasSupportedTransformInstanceTypes()
method.- 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.
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
hasSupportedRealtimeInferenceInstanceTypes()
method.- 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()
For responses, this returns true if the service returned a value for the SupportedRealtimeInferenceInstanceTypes property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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.
-
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.
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
hasSupportedRealtimeInferenceInstanceTypes()
method.- 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()
For responses, this returns true if the service returned a value for the SupportedContentTypes property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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.
-
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.
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
hasSupportedContentTypes()
method.- Returns:
- The supported MIME types for the input data.
-
hasSupportedResponseMIMETypes
public final boolean hasSupportedResponseMIMETypes()
For responses, this returns true if the service returned a value for the SupportedResponseMIMETypes property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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.
-
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.
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
hasSupportedResponseMIMETypes()
method.- Returns:
- The supported MIME types for the output data.
-
toBuilder
public InferenceSpecification.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<InferenceSpecification.Builder,InferenceSpecification>
-
builder
public static InferenceSpecification.Builder builder()
-
serializableBuilderClass
public static Class<? extends InferenceSpecification.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
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.
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToField
in interfaceSdkPojo
-
-