ModelPackageContainerDefinition (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.sagemaker.model.ModelPackageContainerDefinition

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ModelPackageContainerDefinition
extends Object
implements Serializable, Cloneable, StructuredPojo

Describes the Docker container for the model package.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

ModelPackageContainerDefinition()

Constructors
Constructor and Description
`ModelPackageContainerDefinition()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ModelPackageContainerDefinition`	`addEnvironmentEntry(String key, String value)` Add a single Environment entry
`ModelPackageContainerDefinition`	`clearEnvironmentEntries()` Removes all the entries added into Environment.
`ModelPackageContainerDefinition`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getContainerHostname()` The DNS host name for the Docker container.
`Map<String,String>`	`getEnvironment()` The environment variables to set in the Docker container.
`String`	`getImage()` The Amazon EC2 Container Registry (Amazon ECR) path where inference code is stored.
`String`	`getImageDigest()` An MD5 hash of the training algorithm that identifies the Docker image used for training.
`String`	`getModelDataUrl()` The Amazon S3 path where the model artifacts, which result from model training, are stored.
`String`	`getProductId()` The Amazon Web Services Marketplace product ID of the model package.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setContainerHostname(String containerHostname)` The DNS host name for the Docker container.
`void`	`setEnvironment(Map<String,String> environment)` The environment variables to set in the Docker container.
`void`	`setImage(String image)` The Amazon EC2 Container Registry (Amazon ECR) path where inference code is stored.
`void`	`setImageDigest(String imageDigest)` An MD5 hash of the training algorithm that identifies the Docker image used for training.
`void`	`setModelDataUrl(String modelDataUrl)` The Amazon S3 path where the model artifacts, which result from model training, are stored.
`void`	`setProductId(String productId)` The Amazon Web Services Marketplace product ID of the model package.
`String`	`toString()` Returns a string representation of this object.
`ModelPackageContainerDefinition`	`withContainerHostname(String containerHostname)` The DNS host name for the Docker container.
`ModelPackageContainerDefinition`	`withEnvironment(Map<String,String> environment)` The environment variables to set in the Docker container.
`ModelPackageContainerDefinition`	`withImage(String image)` The Amazon EC2 Container Registry (Amazon ECR) path where inference code is stored.
`ModelPackageContainerDefinition`	`withImageDigest(String imageDigest)` An MD5 hash of the training algorithm that identifies the Docker image used for training.
`ModelPackageContainerDefinition`	`withModelDataUrl(String modelDataUrl)` The Amazon S3 path where the model artifacts, which result from model training, are stored.
`ModelPackageContainerDefinition`	`withProductId(String productId)` The Amazon Web Services Marketplace product ID of the model package.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - ModelPackageContainerDefinition
```
public ModelPackageContainerDefinition()
```
- Method Detail
  - setContainerHostname
```
public void setContainerHostname(String containerHostname)
```
    The DNS host name for the Docker container.
    
    Parameters:
    
    containerHostname - The DNS host name for the Docker container.
  - getContainerHostname
```
public String getContainerHostname()
```
    The DNS host name for the Docker container.
    
    Returns:
    
    The DNS host name for the Docker container.
  - withContainerHostname
```
public ModelPackageContainerDefinition withContainerHostname(String containerHostname)
```
    The DNS host name for the Docker container.
    
    Parameters:
    
    containerHostname - The DNS host name for the Docker container.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setImage
```
public void setImage(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 Amazon SageMaker, the inference code must meet Amazon SageMaker requirements. Amazon SageMaker supports both registry/repository[:tag] and registry/repository[@digest] image path formats. For more information, see Using Your Own Algorithms with Amazon SageMaker.
    
    Parameters:
    
    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 Amazon SageMaker, the inference code must meet Amazon SageMaker requirements. Amazon SageMaker supports both registry/repository[:tag] and registry/repository[@digest] image path formats. For more information, see Using Your Own Algorithms with Amazon SageMaker.
  - getImage
```
public String getImage()
```
    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 Amazon SageMaker, the inference code must meet Amazon SageMaker requirements. Amazon 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 Amazon SageMaker, the inference code must meet Amazon SageMaker requirements. Amazon SageMaker supports both registry/repository[:tag] and registry/repository[@digest] image path formats. For more information, see Using Your Own Algorithms with Amazon SageMaker.
  - withImage
```
public ModelPackageContainerDefinition withImage(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 Amazon SageMaker, the inference code must meet Amazon SageMaker requirements. Amazon SageMaker supports both registry/repository[:tag] and registry/repository[@digest] image path formats. For more information, see Using Your Own Algorithms with Amazon SageMaker.
    
    Parameters:
    
    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 Amazon SageMaker, the inference code must meet Amazon SageMaker requirements. Amazon 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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setImageDigest
```
public void setImageDigest(String imageDigest)
```
    An MD5 hash of the training algorithm that identifies the Docker image used for training.
    
    Parameters:
    
    imageDigest - An MD5 hash of the training algorithm that identifies the Docker image used for training.
  - getImageDigest
```
public String getImageDigest()
```
    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.
  - withImageDigest
```
public ModelPackageContainerDefinition withImageDigest(String imageDigest)
```
    An MD5 hash of the training algorithm that identifies the Docker image used for training.
    
    Parameters:
    
    imageDigest - An MD5 hash of the training algorithm that identifies the Docker image used for training.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setModelDataUrl
```
public void setModelDataUrl(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.
    
    Parameters:
    
    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.
  - getModelDataUrl
```
public String getModelDataUrl()
```
    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.
  - withModelDataUrl
```
public ModelPackageContainerDefinition withModelDataUrl(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setProductId
```
public void setProductId(String productId)
```
    The Amazon Web Services Marketplace product ID of the model package.
    
    Parameters:
    
    productId - The Amazon Web Services Marketplace product ID of the model package.
  - getProductId
```
public String getProductId()
```
    The Amazon Web Services Marketplace product ID of the model package.
    
    Returns:
    
    The Amazon Web Services Marketplace product ID of the model package.
  - withProductId
```
public ModelPackageContainerDefinition withProductId(String productId)
```
    The Amazon Web Services Marketplace product ID of the model package.
    
    Parameters:
    
    productId - The Amazon Web Services Marketplace product ID of the model package.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getEnvironment
```
public Map<String,String> getEnvironment()
```
    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.
    
    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.
  - setEnvironment
```
public void setEnvironment(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.
    
    Parameters:
    
    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.
  - withEnvironment
```
public ModelPackageContainerDefinition withEnvironment(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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addEnvironmentEntry
```
public ModelPackageContainerDefinition addEnvironmentEntry(String key,
                                                           String value)
```
    Add a single Environment entry
    
    See Also:
    
    withEnvironment(java.util.Map<java.lang.String, java.lang.String>)
  - clearEnvironmentEntries
```
public ModelPackageContainerDefinition clearEnvironmentEntries()
```
    Removes all the entries added into Environment.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public ModelPackageContainerDefinition clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class ModelPackageContainerDefinition

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ModelPackageContainerDefinition

Method Detail

setContainerHostname

getContainerHostname

withContainerHostname

setImage

getImage

withImage

setImageDigest

getImageDigest

withImageDigest

setModelDataUrl

getModelDataUrl

withModelDataUrl

setProductId

getProductId

withProductId

getEnvironment

setEnvironment

withEnvironment

addEnvironmentEntry

clearEnvironmentEntries

toString

equals

hashCode

clone

marshall