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() Specifies the number of records to include in a mini-batch for an HTTP inference request.
String	batchStrategyAsString() Specifies the number of records to include in a mini-batch for an HTTP inference request.
static CreateTransformJobRequest.Builder	builder()
DataProcessing	dataProcessing() The data structure used to specify the data to be used for inference in a batch transform job and to associate the data that is relevant to the prediction results in the output.
Map<String,String>	environment() The environment variables to set in the Docker container.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
ExperimentConfig	experimentConfig() Returns the value of the ExperimentConfig property for this object.
<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()
boolean	hasTags() For responses, this returns true if the service returned a value for the Tags property.
Integer	maxConcurrentTransforms() The maximum number of parallel requests that can be sent to each instance in a transform job.
Integer	maxPayloadInMB() The maximum allowed size of the payload, in MB.
ModelClientConfig	modelClientConfig() Configures the timeout and maximum number of retries for processing a transform job invocation.
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() (Optional) An array of key-value pairs.
CreateTransformJobRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
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

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

transformJobName

public final String transformJobName()

The name of the transform job. The name must be unique within an Amazon Web Services Region in an Amazon Web Services account.

Returns:

The name of the transform job. The name must be unique within an Amazon Web Services Region in an Amazon Web Services account.

modelName

public final 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 Amazon Web Services Region in an Amazon Web Services 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 Amazon Web Services Region in an Amazon Web Services account.

maxConcurrentTransforms

public final Integer maxConcurrentTransforms()

The maximum number of parallel requests that can be sent to each instance in a transform job. If MaxConcurrentTransforms is set to 0 or left unset, Amazon SageMaker checks the optional execution-parameters to determine the settings for your chosen algorithm. If the execution-parameters endpoint is not enabled, the default value is 1. For more information on execution-parameters, see How Containers Serve Requests. For built-in algorithms, you don't need to set a value for MaxConcurrentTransforms.

Returns:

The maximum number of parallel requests that can be sent to each instance in a transform job. If MaxConcurrentTransforms is set to 0 or left unset, Amazon SageMaker checks the optional execution-parameters to determine the settings for your chosen algorithm. If the execution-parameters endpoint is not enabled, the default value is 1. For more information on execution-parameters, see How Containers Serve Requests. For built-in algorithms, you don't need to set a value for MaxConcurrentTransforms.

modelClientConfig

public final ModelClientConfig modelClientConfig()

Configures the timeout and maximum number of retries for processing a transform job invocation.

Returns:

Configures the timeout and maximum number of retries for processing a transform job invocation.

maxPayloadInMB

public final Integer maxPayloadInMB()

The maximum allowed size of the payload, in MB. A payload is the data portion of a record (without metadata). The value in MaxPayloadInMB must be greater than, or equal to, the size of a single record. To estimate the size of a record in MB, divide the size of your dataset by the number of records. To ensure that the records fit within the maximum payload size, we recommend using a slightly larger value. 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 works only in supported algorithms. Currently, Amazon SageMaker built-in algorithms do not support HTTP chunked encoding.

Returns:

The maximum allowed size of the payload, in MB. A payload is the data portion of a record (without metadata). The value in MaxPayloadInMB must be greater than, or equal to, the size of a single record. To estimate the size of a record in MB, divide the size of your dataset by the number of records. To ensure that the records fit within the maximum payload size, we recommend using a slightly larger value. 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 works only in supported algorithms. Currently, Amazon SageMaker built-in algorithms do not support HTTP chunked encoding.

batchStrategy

public final BatchStrategy batchStrategy()

Specifies the number of records to include in a mini-batch for an HTTP inference request. A record is a single unit of input data that inference can be made on. For example, a single line in a CSV file is a record.

To enable the batch strategy, you must set the SplitType property to Line, RecordIO, or TFRecord.

To use only one record when making an HTTP invocation request to a container, set BatchStrategy to SingleRecord and SplitType to Line.

To fit as many records in a mini-batch as can fit within the MaxPayloadInMB limit, set BatchStrategy to MultiRecord and SplitType to Line.

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:

Specifies the number of records to include in a mini-batch for an HTTP inference request. A record is a single unit of input data that inference can be made on. For example, a single line in a CSV file is a record.

To enable the batch strategy, you must set the SplitType property to Line, RecordIO, or TFRecord.

To use only one record when making an HTTP invocation request to a container, set BatchStrategy to SingleRecord and SplitType to Line.

To fit as many records in a mini-batch as can fit within the MaxPayloadInMB limit, set BatchStrategy to MultiRecord and SplitType to Line.

See Also:

BatchStrategy

batchStrategyAsString

public final String batchStrategyAsString()

Specifies the number of records to include in a mini-batch for an HTTP inference request. A record is a single unit of input data that inference can be made on. For example, a single line in a CSV file is a record.

To enable the batch strategy, you must set the SplitType property to Line, RecordIO, or TFRecord.

To use only one record when making an HTTP invocation request to a container, set BatchStrategy to SingleRecord and SplitType to Line.

To fit as many records in a mini-batch as can fit within the MaxPayloadInMB limit, set BatchStrategy to MultiRecord and SplitType to Line.

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:

Specifies the number of records to include in a mini-batch for an HTTP inference request. A record is a single unit of input data that inference can be made on. For example, a single line in a CSV file is a record.

To enable the batch strategy, you must set the SplitType property to Line, RecordIO, or TFRecord.

To use only one record when making an HTTP invocation request to a container, set BatchStrategy to SingleRecord and SplitType to Line.

To fit as many records in a mini-batch as can fit within the MaxPayloadInMB limit, set BatchStrategy to MultiRecord and SplitType to Line.

See Also:

BatchStrategy

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

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. We support up to 16 key and values entries in the map.

transformInput

public final 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 final TransformOutput transformOutput()

Describes the results of the transform job.

Returns:

Describes the results of the transform job.

transformResources

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

dataProcessing

public final DataProcessing dataProcessing()

The data structure used to specify the data to be used for inference in a batch transform job and to associate the data that is relevant to the prediction results in the output. The input filter provided allows you to exclude input data that is not needed for inference in a batch transform job. The output filter provided allows you to include input data relevant to interpreting the predictions in the output from the job. For more information, see Associate Prediction Results with their Corresponding Input Records.

Returns:

The data structure used to specify the data to be used for inference in a batch transform job and to associate the data that is relevant to the prediction results in the output. The input filter provided allows you to exclude input data that is not needed for inference in a batch transform job. The output filter provided allows you to include input data relevant to interpreting the predictions in the output from the job. For more information, see Associate Prediction Results with their Corresponding Input Records.

hasTags

public final boolean hasTags()

For responses, this returns true if the service returned a value for the Tags 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.

tags

public final List<Tag> tags()

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

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 hasTags() method.

Returns:

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

experimentConfig

public final ExperimentConfig experimentConfig()

Returns the value of the ExperimentConfig property for this object.

Returns:

The value of the ExperimentConfig property for this object.

toBuilder

public CreateTransformJobRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateTransformJobRequest.Builder,CreateTransformJobRequest>

Specified by:

toBuilder in class SageMakerRequest

builder

public static CreateTransformJobRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo