com.amazonaws.services.sagemaker.model

Class CreateTransformJobRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.sagemaker.model.CreateTransformJobRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

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

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateTransformJobRequest()

Method Summary

Modifier and Type	Method and Description
CreateTransformJobRequest	addEnvironmentEntry(String key, String value)
CreateTransformJobRequest	clearEnvironmentEntries() Removes all the entries added into Environment.
CreateTransformJobRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getBatchStrategy() Determines the number of records to include in a mini-batch.
Map<String,String>	getEnvironment() The environment variables to set in the Docker container.
Integer	getMaxConcurrentTransforms() The maximum number of parallel requests that can be sent to an algorithm container on an instance.
Integer	getMaxPayloadInMB() The maximum payload size allowed, in MB.
String	getModelName() The name of the model that you want to use for the transform job.
List<Tag>	getTags() (Optional) An array of key-value pairs.
TransformInput	getTransformInput() Describes the input source and the way the transform job consumes it.
String	getTransformJobName() The name of the transform job.
TransformOutput	getTransformOutput() Describes the results of the transform job.
TransformResources	getTransformResources() Describes the resources, including ML instance types and ML instance count, to use for the transform job.
int	hashCode()
void	setBatchStrategy(String batchStrategy) Determines the number of records to include in a mini-batch.
void	setEnvironment(Map<String,String> environment) The environment variables to set in the Docker container.
void	setMaxConcurrentTransforms(Integer maxConcurrentTransforms) The maximum number of parallel requests that can be sent to an algorithm container on an instance.
void	setMaxPayloadInMB(Integer maxPayloadInMB) The maximum payload size allowed, in MB.
void	setModelName(String modelName) The name of the model that you want to use for the transform job.
void	setTags(Collection<Tag> tags) (Optional) An array of key-value pairs.
void	setTransformInput(TransformInput transformInput) Describes the input source and the way the transform job consumes it.
void	setTransformJobName(String transformJobName) The name of the transform job.
void	setTransformOutput(TransformOutput transformOutput) Describes the results of the transform job.
void	setTransformResources(TransformResources transformResources) Describes the resources, including ML instance types and ML instance count, to use for the transform job.
String	toString() Returns a string representation of this object.
CreateTransformJobRequest	withBatchStrategy(BatchStrategy batchStrategy) Determines the number of records to include in a mini-batch.
CreateTransformJobRequest	withBatchStrategy(String batchStrategy) Determines the number of records to include in a mini-batch.
CreateTransformJobRequest	withEnvironment(Map<String,String> environment) The environment variables to set in the Docker container.
CreateTransformJobRequest	withMaxConcurrentTransforms(Integer maxConcurrentTransforms) The maximum number of parallel requests that can be sent to an algorithm container on an instance.
CreateTransformJobRequest	withMaxPayloadInMB(Integer maxPayloadInMB) The maximum payload size allowed, in MB.
CreateTransformJobRequest	withModelName(String modelName) The name of the model that you want to use for the transform job.
CreateTransformJobRequest	withTags(Collection<Tag> tags) (Optional) An array of key-value pairs.
CreateTransformJobRequest	withTags(Tag... tags) (Optional) An array of key-value pairs.
CreateTransformJobRequest	withTransformInput(TransformInput transformInput) Describes the input source and the way the transform job consumes it.
CreateTransformJobRequest	withTransformJobName(String transformJobName) The name of the transform job.
CreateTransformJobRequest	withTransformOutput(TransformOutput transformOutput) Describes the results of the transform job.
CreateTransformJobRequest	withTransformResources(TransformResources transformResources) Describes the resources, including ML instance types and ML instance count, to use for the transform job.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateTransformJobRequest

public CreateTransformJobRequest()

Method Detail

setTransformJobName

public void setTransformJobName(String transformJobName)

The name of the transform job. The name must be unique within an AWS Region in an AWS account.

Parameters:

transformJobName - The name of the transform job. The name must be unique within an AWS Region in an AWS account.

getTransformJobName

public String getTransformJobName()

The name of the transform job. The name must be unique within an AWS Region in an AWS account.

Returns:

The name of the transform job. The name must be unique within an AWS Region in an AWS account.

withTransformJobName

public CreateTransformJobRequest withTransformJobName(String transformJobName)

The name of the transform job. The name must be unique within an AWS Region in an AWS account.

Parameters:

transformJobName - The name of the transform job. The name must be unique within an AWS Region in an AWS account.

Returns:

Returns a reference to this object so that method calls can be chained together.

setModelName

public void setModelName(String modelName)

The name of the model that you want to use for the transform job. ModelName must be the name of an existing Amazon SageMaker model within an AWS Region in an AWS account.

Parameters:

modelName - The name of the model that you want to use for the transform job. ModelName must be the name of an existing Amazon SageMaker model within an AWS Region in an AWS account.

getModelName

public String getModelName()

The name of the model that you want to use for the transform job. ModelName must be the name of an existing Amazon SageMaker model within an AWS Region in an AWS account.

Returns:

The name of the model that you want to use for the transform job. ModelName must be the name of an existing Amazon SageMaker model within an AWS Region in an AWS account.

withModelName

public CreateTransformJobRequest withModelName(String modelName)

The name of the model that you want to use for the transform job. ModelName must be the name of an existing Amazon SageMaker model within an AWS Region in an AWS account.

Parameters:

modelName - The name of the model that you want to use for the transform job. ModelName must be the name of an existing Amazon SageMaker model within an AWS Region in an AWS account.

Returns:

Returns a reference to this object so that method calls can be chained together.

setMaxConcurrentTransforms

public void setMaxConcurrentTransforms(Integer maxConcurrentTransforms)

The maximum number of parallel requests that can be sent to an algorithm container on an instance. This is good for algorithms that implement multiple workers on larger instances . The default value is 1. To allow Amazon SageMaker to determine the appropriate number for MaxConcurrentTransforms, do not set the value in the API.

Parameters:

maxConcurrentTransforms - The maximum number of parallel requests that can be sent to an algorithm container on an instance. This is good for algorithms that implement multiple workers on larger instances . The default value is 1. To allow Amazon SageMaker to determine the appropriate number for MaxConcurrentTransforms, do not set the value in the API.

getMaxConcurrentTransforms

public Integer getMaxConcurrentTransforms()

The maximum number of parallel requests that can be sent to an algorithm container on an instance. This is good for algorithms that implement multiple workers on larger instances . The default value is 1. To allow Amazon SageMaker to determine the appropriate number for MaxConcurrentTransforms, do not set the value in the API.

Returns:

The maximum number of parallel requests that can be sent to an algorithm container on an instance. This is good for algorithms that implement multiple workers on larger instances . The default value is 1. To allow Amazon SageMaker to determine the appropriate number for MaxConcurrentTransforms, do not set the value in the API.

withMaxConcurrentTransforms

public CreateTransformJobRequest withMaxConcurrentTransforms(Integer maxConcurrentTransforms)

The maximum number of parallel requests that can be sent to an algorithm container on an instance. This is good for algorithms that implement multiple workers on larger instances . The default value is 1. To allow Amazon SageMaker to determine the appropriate number for MaxConcurrentTransforms, do not set the value in the API.

Parameters:

maxConcurrentTransforms - The maximum number of parallel requests that can be sent to an algorithm container on an instance. This is good for algorithms that implement multiple workers on larger instances . The default value is 1. To allow Amazon SageMaker to determine the appropriate number for MaxConcurrentTransforms, do not set the value in the API.

Returns:

Returns a reference to this object so that method calls can be chained together.

setMaxPayloadInMB

public void setMaxPayloadInMB(Integer maxPayloadInMB)

The maximum payload size allowed, in MB. A payload is the data portion of a record (without metadata). The value in MaxPayloadInMB must be greater or equal to the size of a single record. You can approximate the size of a record by dividing the size of your dataset by the number of records. Then multiply this value by the number of records you want in a mini-batch. We recommend to enter a slightly larger value than this to ensure the records fit within the maximum payload size. The default value is 6 MB.

For cases where the payload might be arbitrarily large and is transmitted using HTTP chunked encoding, set the value to 0. This feature only works in supported algorithms. Currently, Amazon SageMaker built-in algorithms do not support this feature.

Parameters:

maxPayloadInMB - The maximum payload size allowed, in MB. A payload is the data portion of a record (without metadata). The value in MaxPayloadInMB must be greater or equal to the size of a single record. You can approximate the size of a record by dividing the size of your dataset by the number of records. Then multiply this value by the number of records you want in a mini-batch. We recommend to enter a slightly larger value than this to ensure the records fit within the maximum payload size. The default value is 6 MB.

For cases where the payload might be arbitrarily large and is transmitted using HTTP chunked encoding, set the value to 0. This feature only works in supported algorithms. Currently, Amazon SageMaker built-in algorithms do not support this feature.

getMaxPayloadInMB

public Integer getMaxPayloadInMB()

The maximum payload size allowed, in MB. A payload is the data portion of a record (without metadata). The value in MaxPayloadInMB must be greater or equal to the size of a single record. You can approximate the size of a record by dividing the size of your dataset by the number of records. Then multiply this value by the number of records you want in a mini-batch. We recommend to enter a slightly larger value than this to ensure the records fit within the maximum payload size. The default value is 6 MB.

For cases where the payload might be arbitrarily large and is transmitted using HTTP chunked encoding, set the value to 0. This feature only works in supported algorithms. Currently, Amazon SageMaker built-in algorithms do not support this feature.

Returns:

The maximum payload size allowed, in MB. A payload is the data portion of a record (without metadata). The value in MaxPayloadInMB must be greater or equal to the size of a single record. You can approximate the size of a record by dividing the size of your dataset by the number of records. Then multiply this value by the number of records you want in a mini-batch. We recommend to enter a slightly larger value than this to ensure the records fit within the maximum payload size. The default value is 6 MB.

For cases where the payload might be arbitrarily large and is transmitted using HTTP chunked encoding, set the value to 0. This feature only works in supported algorithms. Currently, Amazon SageMaker built-in algorithms do not support this feature.

withMaxPayloadInMB

public CreateTransformJobRequest withMaxPayloadInMB(Integer maxPayloadInMB)

The maximum payload size allowed, in MB. A payload is the data portion of a record (without metadata). The value in MaxPayloadInMB must be greater or equal to the size of a single record. You can approximate the size of a record by dividing the size of your dataset by the number of records. Then multiply this value by the number of records you want in a mini-batch. We recommend to enter a slightly larger value than this to ensure the records fit within the maximum payload size. The default value is 6 MB.

For cases where the payload might be arbitrarily large and is transmitted using HTTP chunked encoding, set the value to 0. This feature only works in supported algorithms. Currently, Amazon SageMaker built-in algorithms do not support this feature.

Parameters:

maxPayloadInMB - The maximum payload size allowed, in MB. A payload is the data portion of a record (without metadata). The value in MaxPayloadInMB must be greater or equal to the size of a single record. You can approximate the size of a record by dividing the size of your dataset by the number of records. Then multiply this value by the number of records you want in a mini-batch. We recommend to enter a slightly larger value than this to ensure the records fit within the maximum payload size. The default value is 6 MB.

For cases where the payload might be arbitrarily large and is transmitted using HTTP chunked encoding, set the value to 0. This feature only works in supported algorithms. Currently, Amazon SageMaker built-in algorithms do not support this feature.

Returns:

Returns a reference to this object so that method calls can be chained together.

setBatchStrategy

public void setBatchStrategy(String batchStrategy)

Determines the number of records to include in a mini-batch. If you want to include only one record in a mini-batch, specify SingleRecord.. If you want mini-batches to contain a maximum of the number of records specified in the MaxPayloadInMB parameter, specify MultiRecord.

If you set SplitType to Line and BatchStrategy to MultiRecord , a batch transform automatically splits your input data into the specified payload size. There's no need to split the dataset into smaller files or to use larger payload sizes unless the records in your dataset are very large.

Parameters:

batchStrategy - Determines the number of records to include in a mini-batch. If you want to include only one record in a mini-batch, specify SingleRecord.. If you want mini-batches to contain a maximum of the number of records specified in the MaxPayloadInMB parameter, specify MultiRecord .

If you set SplitType to Line and BatchStrategy to MultiRecord, a batch transform automatically splits your input data into the specified payload size. There's no need to split the dataset into smaller files or to use larger payload sizes unless the records in your dataset are very large.

See Also:

BatchStrategy

getBatchStrategy

public String getBatchStrategy()

Determines the number of records to include in a mini-batch. If you want to include only one record in a mini-batch, specify SingleRecord.. If you want mini-batches to contain a maximum of the number of records specified in the MaxPayloadInMB parameter, specify MultiRecord.

If you set SplitType to Line and BatchStrategy to MultiRecord , a batch transform automatically splits your input data into the specified payload size. There's no need to split the dataset into smaller files or to use larger payload sizes unless the records in your dataset are very large.

Returns:

Determines the number of records to include in a mini-batch. If you want to include only one record in a mini-batch, specify SingleRecord.. If you want mini-batches to contain a maximum of the number of records specified in the MaxPayloadInMB parameter, specify MultiRecord.

If you set SplitType to Line and BatchStrategy to MultiRecord, a batch transform automatically splits your input data into the specified payload size. There's no need to split the dataset into smaller files or to use larger payload sizes unless the records in your dataset are very large.

See Also:

BatchStrategy

withBatchStrategy

public CreateTransformJobRequest withBatchStrategy(String batchStrategy)

Determines the number of records to include in a mini-batch. If you want to include only one record in a mini-batch, specify SingleRecord.. If you want mini-batches to contain a maximum of the number of records specified in the MaxPayloadInMB parameter, specify MultiRecord.

If you set SplitType to Line and BatchStrategy to MultiRecord , a batch transform automatically splits your input data into the specified payload size. There's no need to split the dataset into smaller files or to use larger payload sizes unless the records in your dataset are very large.

Parameters:

batchStrategy - Determines the number of records to include in a mini-batch. If you want to include only one record in a mini-batch, specify SingleRecord.. If you want mini-batches to contain a maximum of the number of records specified in the MaxPayloadInMB parameter, specify MultiRecord .

If you set SplitType to Line and BatchStrategy to MultiRecord, a batch transform automatically splits your input data into the specified payload size. There's no need to split the dataset into smaller files or to use larger payload sizes unless the records in your dataset are very large.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

BatchStrategy

withBatchStrategy

public CreateTransformJobRequest withBatchStrategy(BatchStrategy batchStrategy)

Determines the number of records to include in a mini-batch. If you want to include only one record in a mini-batch, specify SingleRecord.. If you want mini-batches to contain a maximum of the number of records specified in the MaxPayloadInMB parameter, specify MultiRecord.

If you set SplitType to Line and BatchStrategy to MultiRecord , a batch transform automatically splits your input data into the specified payload size. There's no need to split the dataset into smaller files or to use larger payload sizes unless the records in your dataset are very large.

Parameters:

batchStrategy - Determines the number of records to include in a mini-batch. If you want to include only one record in a mini-batch, specify SingleRecord.. If you want mini-batches to contain a maximum of the number of records specified in the MaxPayloadInMB parameter, specify MultiRecord .

If you set SplitType to Line and BatchStrategy to MultiRecord, a batch transform automatically splits your input data into the specified payload size. There's no need to split the dataset into smaller files or to use larger payload sizes unless the records in your dataset are very large.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

BatchStrategy

getEnvironment

public Map<String,String> getEnvironment()

The environment variables to set in the Docker container. We support up to 16 key and values entries in the map.

Returns:

The environment variables to set in the Docker container. We support up to 16 key and values entries in the map.

setEnvironment

public void setEnvironment(Map<String,String> environment)

The environment variables to set in the Docker container. We support up to 16 key and values entries in the map.

Parameters:

environment - The environment variables to set in the Docker container. We support up to 16 key and values entries in the map.

withEnvironment

public CreateTransformJobRequest withEnvironment(Map<String,String> environment)

The environment variables to set in the Docker container. We support up to 16 key and values entries in the map.

Parameters:

environment - The environment variables to set in the Docker container. We support up to 16 key and values entries in the map.

Returns:

Returns a reference to this object so that method calls can be chained together.

addEnvironmentEntry

public CreateTransformJobRequest addEnvironmentEntry(String key,
                                                     String value)

clearEnvironmentEntries

public CreateTransformJobRequest clearEnvironmentEntries()

Removes all the entries added into Environment.

Returns:

Returns a reference to this object so that method calls can be chained together.

setTransformInput

public void setTransformInput(TransformInput transformInput)

Describes the input source and the way the transform job consumes it.

Parameters:

transformInput - Describes the input source and the way the transform job consumes it.

getTransformInput

public TransformInput getTransformInput()

Describes the input source and the way the transform job consumes it.

Returns:

Describes the input source and the way the transform job consumes it.

withTransformInput

public CreateTransformJobRequest withTransformInput(TransformInput transformInput)

Describes the input source and the way the transform job consumes it.

Parameters:

transformInput - Describes the input source and the way the transform job consumes it.

Returns:

Returns a reference to this object so that method calls can be chained together.

setTransformOutput

public void setTransformOutput(TransformOutput transformOutput)

Describes the results of the transform job.

Parameters:

transformOutput - Describes the results of the transform job.

getTransformOutput

public TransformOutput getTransformOutput()

Describes the results of the transform job.

Returns:

Describes the results of the transform job.

withTransformOutput

public CreateTransformJobRequest withTransformOutput(TransformOutput transformOutput)

Describes the results of the transform job.

Parameters:

transformOutput - Describes the results of the transform job.

Returns:

Returns a reference to this object so that method calls can be chained together.

setTransformResources

public void setTransformResources(TransformResources transformResources)

Describes the resources, including ML instance types and ML instance count, to use for the transform job.

Parameters:

transformResources - Describes the resources, including ML instance types and ML instance count, to use for the transform job.

getTransformResources

public TransformResources getTransformResources()

Describes the resources, including ML instance types and ML instance count, to use for the transform job.

Returns:

Describes the resources, including ML instance types and ML instance count, to use for the transform job.

withTransformResources

public CreateTransformJobRequest withTransformResources(TransformResources transformResources)

Describes the resources, including ML instance types and ML instance count, to use for the transform job.

Parameters:

transformResources - Describes the resources, including ML instance types and ML instance count, to use for the transform job.

Returns:

Returns a reference to this object so that method calls can be chained together.

getTags

public List<Tag> getTags()

(Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.

Returns:

(Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.

setTags

public void setTags(Collection<Tag> tags)

(Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.

Parameters:

tags - (Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.

withTags

public CreateTransformJobRequest withTags(Tag... tags)

(Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.

NOTE: This method appends the values to the existing list (if any). Use setTags(java.util.Collection) or withTags(java.util.Collection) if you want to override the existing values.

Parameters:

tags - (Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.

Returns:

Returns a reference to this object so that method calls can be chained together.

withTags

public CreateTransformJobRequest withTags(Collection<Tag> tags)

(Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.

Parameters:

tags - (Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.

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 CreateTransformJobRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()