Package software.amazon.awssdk.services.sagemaker.model

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:

  • Method Details

    • 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] and registry/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] and registry/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 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.

    • 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()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<ModelPackageContainerDefinition.Builder,ModelPackageContainerDefinition>
      Returns:
      a builder for type T

    • builder

      public static ModelPackageContainerDefinition.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ModelPackageContainerDefinition.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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.