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

Class TransformJobDefinition

java.lang.Object

software.amazon.awssdk.services.sagemaker.model.TransformJobDefinition

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<TransformJobDefinition.Builder,TransformJobDefinition>

@Generated("software.amazon.awssdk:codegen")
public final class TransformJobDefinition
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<TransformJobDefinition.Builder,TransformJobDefinition>

Defines the input needed to run a transform job using the inference specification specified in the algorithm.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	TransformJobDefinition.Builder

Method Summary

Modifier and Type	Method	Description
BatchStrategy	batchStrategy()	A string that determines the number of records included in a single mini-batch.
String	batchStrategyAsString()	A string that determines the number of records included in a single mini-batch.
static TransformJobDefinition.Builder	builder()
Map<String,String>	environment()	The environment variables to set in the Docker container.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<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()
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.
List<SdkField<?>>	sdkFields()
static Class<? extends TransformJobDefinition.Builder>	serializableBuilderClass()
TransformJobDefinition.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
TransformInput	transformInput()	A description of the input source and the way the transform job consumes it.
TransformOutput	transformOutput()	Identifies the Amazon S3 location where you want Amazon SageMaker to save the results from the transform job.
TransformResources	transformResources()	Identifies the ML compute instances for the transform job.

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

maxConcurrentTransforms

public final Integer maxConcurrentTransforms()

The maximum number of parallel requests that can be sent to each instance in a transform job. The default value is 1.

Returns:

The maximum number of parallel requests that can be sent to each instance in a transform job. The default value is 1.

maxPayloadInMB

public final Integer maxPayloadInMB()

The maximum payload size allowed, in MB. A payload is the data portion of a record (without metadata).

Returns:

The maximum payload size allowed, in MB. A payload is the data portion of a record (without metadata).

batchStrategy

public final BatchStrategy batchStrategy()

A string that 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.

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:

A string that 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.

See Also:

BatchStrategy

batchStrategyAsString

public final String batchStrategyAsString()

A string that 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.

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:

A string that 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.

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

A description of the input source and the way the transform job consumes it.

Returns:

A description of the input source and the way the transform job consumes it.

transformOutput

public final TransformOutput transformOutput()

Identifies the Amazon S3 location where you want Amazon SageMaker to save the results from the transform job.

Returns:

Identifies the Amazon S3 location where you want Amazon SageMaker to save the results from the transform job.

transformResources

public final TransformResources transformResources()

Identifies the ML compute instances for the transform job.

Returns:

Identifies the ML compute instances for the transform job.

toBuilder

public TransformJobDefinition.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<TransformJobDefinition.Builder,TransformJobDefinition>

builder

public static TransformJobDefinition.Builder builder()

serializableBuilderClass

public static Class<? extends TransformJobDefinition.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)

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)

sdkFields

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

Specified by:

sdkFields in interface SdkPojo