Class ModelPackageContainerDefinition
- java.lang.Object
-
- software.amazon.awssdk.services.sagemaker.model.ModelPackageContainerDefinition
-
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<ModelPackageContainerDefinition.Builder,ModelPackageContainerDefinition>
@Generated("software.amazon.awssdk:codegen") public final class ModelPackageContainerDefinition extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ModelPackageContainerDefinition.Builder,ModelPackageContainerDefinition>
Describes the Docker container for the model package.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
ModelPackageContainerDefinition.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description AdditionalS3DataSource
additionalS3DataSource()
The additional data source that is used during inference in the Docker container for your model package.static ModelPackageContainerDefinition.Builder
builder()
String
containerHostname()
The DNS host name for the Docker container.Map<String,String>
environment()
The environment variables to set in the Docker container.boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
String
framework()
The machine learning framework of the model package container image.String
frameworkVersion()
The framework version of the Model Package Container Image.<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
boolean
hasEnvironment()
For responses, this returns true if the service returned a value for the Environment property.int
hashCode()
String
image()
The Amazon EC2 Container Registry (Amazon ECR) path where inference code is stored.String
imageDigest()
An MD5 hash of the training algorithm that identifies the Docker image used for training.ModelDataSource
modelDataSource()
Specifies the location of ML model data to deploy during endpoint creation.String
modelDataUrl()
The Amazon S3 path where the model artifacts, which result from model training, are stored.ModelInput
modelInput()
A structure with Model Input details.String
nearestModelName()
The name of a pre-trained machine learning benchmarked by Amazon SageMaker Inference Recommender model that matches your model.String
productId()
The Amazon Web Services Marketplace product ID of the model package.List<SdkField<?>>
sdkFields()
static Class<? extends ModelPackageContainerDefinition.Builder>
serializableBuilderClass()
ModelPackageContainerDefinition.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
-
containerHostname
public final String containerHostname()
The DNS host name for the Docker container.
- Returns:
- The DNS host name for the Docker container.
-
image
public final String image()
The Amazon EC2 Container Registry (Amazon ECR) path where inference code is stored.
If you are using your own custom algorithm instead of an algorithm provided by SageMaker, the inference code must meet SageMaker requirements. SageMaker supports both
registry/repository[:tag]
andregistry/repository[@digest]
image path formats. For more information, see Using Your Own Algorithms with Amazon SageMaker.- Returns:
- The Amazon EC2 Container Registry (Amazon ECR) path where inference code is stored.
If you are using your own custom algorithm instead of an algorithm provided by SageMaker, the inference code must meet SageMaker requirements. SageMaker supports both
registry/repository[:tag]
andregistry/repository[@digest]
image path formats. For more information, see Using Your Own Algorithms with Amazon SageMaker.
-
imageDigest
public final String imageDigest()
An MD5 hash of the training algorithm that identifies the Docker image used for training.
- Returns:
- An MD5 hash of the training algorithm that identifies the Docker image used for training.
-
modelDataUrl
public final String modelDataUrl()
The Amazon S3 path where the model artifacts, which result from model training, are stored. This path must point to a single
gzip
compressed tar archive (.tar.gz
suffix).The model artifacts must be in an S3 bucket that is in the same region as the model package.
- Returns:
- The Amazon S3 path where the model artifacts, which result from model training, are stored. This path
must point to a single
gzip
compressed tar archive (.tar.gz
suffix).The model artifacts must be in an S3 bucket that is in the same region as the model package.
-
modelDataSource
public final ModelDataSource modelDataSource()
Specifies the location of ML model data to deploy during endpoint creation.
- Returns:
- Specifies the location of ML model data to deploy during endpoint creation.
-
productId
public final String productId()
The Amazon Web Services Marketplace product ID of the model package.
- Returns:
- The Amazon Web Services Marketplace product ID of the model package.
-
hasEnvironment
public final boolean hasEnvironment()
For responses, this returns true if the service returned a value for the Environment 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.
-
environment
public final Map<String,String> environment()
The environment variables to set in the Docker container. Each key and value in the
Environment
string to string map can have length of up to 1024. We support up to 16 entries in the map.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
hasEnvironment()
method.- Returns:
- The environment variables to set in the Docker container. Each key and value in the
Environment
string to string map can have length of up to 1024. We support up to 16 entries in the map.
-
modelInput
public final ModelInput modelInput()
A structure with Model Input details.
- Returns:
- A structure with Model Input details.
-
framework
public final String framework()
The machine learning framework of the model package container image.
- Returns:
- The machine learning framework of the model package container image.
-
frameworkVersion
public final String frameworkVersion()
The framework version of the Model Package Container Image.
- Returns:
- The framework version of the Model Package Container Image.
-
nearestModelName
public final String nearestModelName()
The name of a pre-trained machine learning benchmarked by Amazon SageMaker Inference Recommender model that matches your model. You can find a list of benchmarked models by calling
ListModelMetadata
.- Returns:
- The name of a pre-trained machine learning benchmarked by Amazon SageMaker Inference Recommender model
that matches your model. You can find a list of benchmarked models by calling
ListModelMetadata
.
-
additionalS3DataSource
public final AdditionalS3DataSource additionalS3DataSource()
The additional data source that is used during inference in the Docker container for your model package.
- Returns:
- The additional data source that is used during inference in the Docker container for your model package.
-
toBuilder
public ModelPackageContainerDefinition.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<ModelPackageContainerDefinition.Builder,ModelPackageContainerDefinition>
-
builder
public static ModelPackageContainerDefinition.Builder builder()
-
serializableBuilderClass
public static Class<? extends ModelPackageContainerDefinition.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.
-
-