software.amazon.awssdk.services.sagemaker.model

Class CreateTransformJobRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.sagemaker.model.SageMakerRequest

software.amazon.awssdk.services.sagemaker.model.CreateTransformJobRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateTransformJobRequest.Builder,CreateTransformJobRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateTransformJobRequest
extends SageMakerRequest
implements ToCopyableBuilder<CreateTransformJobRequest.Builder,CreateTransformJobRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateTransformJobRequest.Builder

Method Summary

Modifier and Type	Method and Description
BatchStrategy	batchStrategy() Determines the number of records included in a single mini-batch.
String	batchStrategyAsString() Determines the number of records included in a single mini-batch.
static CreateTransformJobRequest.Builder	builder()
Map<String,String>	environment() The environment variables to set in the Docker container.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
Integer	maxConcurrentTransforms() The maximum number of parallel requests that can be sent to each instance in a transform job.
Integer	maxPayloadInMB() The maximum payload size allowed, in MB.
String	modelName() The name of the model that you want to use for the transform job.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateTransformJobRequest.Builder>	serializableBuilderClass()
List<Tag>	tags() An array of key-value pairs.
CreateTransformJobRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()
TransformInput	transformInput() Describes the input source and the way the transform job consumes it.
String	transformJobName() The name of the transform job.
TransformOutput	transformOutput() Describes the results of the transform job.
TransformResources	transformResources() Describes the resources, including ML instance types and ML instance count, to use for the transform job.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

transformJobName

public String transformJobName()

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.

modelName

public 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.

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.

maxConcurrentTransforms

public Integer maxConcurrentTransforms()

The maximum number of parallel requests that can be sent to each instance in a transform job. 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, set the value to 0.

Returns:

The maximum number of parallel requests that can be sent to each instance in a transform job. 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, set the value to 0.

maxPayloadInMB

public 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.

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.

batchStrategy

public BatchStrategy batchStrategy()

Determines the number of records included in a single mini-batch. SingleRecord means only one record is used per mini-batch. MultiRecord means a mini-batch is set to contain as many records that can fit within the MaxPayloadInMB limit.

Batch transform will automatically split your input data into whatever payload size is specified if you set SplitType to Line and BatchStrategy to MultiRecord. 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.

If the service returns an enum value that is not available in the current SDK version, batchStrategy will return BatchStrategy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from batchStrategyAsString().

Returns:

Determines the number of records included in a single mini-batch. SingleRecord means only one record is used per mini-batch. MultiRecord means a mini-batch is set to contain as many records that can fit within the MaxPayloadInMB limit.

Batch transform will automatically split your input data into whatever payload size is specified if you set SplitType to Line and BatchStrategy to MultiRecord. 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

batchStrategyAsString

public String batchStrategyAsString()

Determines the number of records included in a single mini-batch. SingleRecord means only one record is used per mini-batch. MultiRecord means a mini-batch is set to contain as many records that can fit within the MaxPayloadInMB limit.

Batch transform will automatically split your input data into whatever payload size is specified if you set SplitType to Line and BatchStrategy to MultiRecord. 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.

If the service returns an enum value that is not available in the current SDK version, batchStrategy will return BatchStrategy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from batchStrategyAsString().

Returns:

Determines the number of records included in a single mini-batch. SingleRecord means only one record is used per mini-batch. MultiRecord means a mini-batch is set to contain as many records that can fit within the MaxPayloadInMB limit.

Batch transform will automatically split your input data into whatever payload size is specified if you set SplitType to Line and BatchStrategy to MultiRecord. 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

environment

public 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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

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

transformInput

public TransformInput transformInput()

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.

transformOutput

public TransformOutput transformOutput()

Describes the results of the transform job.

Returns:

Describes the results of the transform job.

transformResources

public TransformResources transformResources()

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.

tags

public List<Tag> tags()

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

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

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

toBuilder

public CreateTransformJobRequest.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<CreateTransformJobRequest.Builder,CreateTransformJobRequest>

Specified by:

toBuilder in class SageMakerRequest

Returns:

a builder for type T

builder

public static CreateTransformJobRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateTransformJobRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

sdkFields

public 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.