TransformJob (AWS Java SDK :: Services :: Amazon SageMaker 2.17.232 API)

java.lang.Object
- software.amazon.awssdk.services.sagemaker.model.TransformJob

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<TransformJob.Builder,TransformJob>
```
@Generated(value="software.amazon.awssdk:codegen")
public final class TransformJob
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<TransformJob.Builder,TransformJob>
```
A batch transform job. For information about SageMaker batch transform, see Use Batch Transform.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface TransformJob.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`TransformJob.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`autoMLJobArn()` The Amazon Resource Name (ARN) of the AutoML job that created the transform job.
`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 TransformJob.Builder`	`builder()`
`Instant`	`creationTime()` A timestamp that shows when the transform Job was created.
`DataProcessing`	`dataProcessing()` Returns the value of the DataProcessing property for this object.
`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.
`String`	`failureReason()` If the transform job failed, the reason it failed.
`<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.
`String`	`labelingJobArn()` The Amazon Resource Name (ARN) of the labeling job that created the transform job.
`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()` Returns the value of the ModelClientConfig property for this object.
`String`	`modelName()` The name of the model associated with the transform job.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends TransformJob.Builder>`	`serializableBuilderClass()`
`List<Tag>`	`tags()` A list of tags associated with the transform job.
`TransformJob.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`Instant`	`transformEndTime()` Indicates when the transform job has been completed, or has stopped or failed.
`TransformInput`	`transformInput()` Returns the value of the TransformInput property for this object.
`String`	`transformJobArn()` The Amazon Resource Name (ARN) of the transform job.
`String`	`transformJobName()` The name of the transform job.
`TransformJobStatus`	`transformJobStatus()` The status of the transform job.
`String`	`transformJobStatusAsString()` The status of the transform job.
`TransformOutput`	`transformOutput()` Returns the value of the TransformOutput property for this object.
`TransformResources`	`transformResources()` Returns the value of the TransformResources property for this object.
`Instant`	`transformStartTime()` Indicates when the transform job starts on ML instances.

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.
    
    Returns:
    
    The name of the transform job.
  - transformJobArn
```
public final String transformJobArn()
```
    The Amazon Resource Name (ARN) of the transform job.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the transform job.
  - transformJobStatus
```
public final TransformJobStatus transformJobStatus()
```
    The status of the transform job.
    
    Transform job statuses are:
    - InProgress - The job is in progress.
    - Completed - The job has completed.
    - Failed - The transform job has failed. To see the reason for the failure, see the FailureReason field in the response to a DescribeTransformJob call.
    - Stopping - The transform job is stopping.
    - Stopped - The transform job has stopped.
    If the service returns an enum value that is not available in the current SDK version, transformJobStatus will return TransformJobStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from transformJobStatusAsString().
    Returns:
    The status of the transform job.
    
    Transform job statuses are:
    
    InProgress - The job is in progress.
    
    Completed - The job has completed.
    
    Failed - The transform job has failed. To see the reason for the failure, see the FailureReason field in the response to a DescribeTransformJob call.
    
    Stopping - The transform job is stopping.
    
    Stopped - The transform job has stopped.
    See Also:
    
    TransformJobStatus
  - transformJobStatusAsString
```
public final String transformJobStatusAsString()
```
    The status of the transform job.
    
    Transform job statuses are:
    - InProgress - The job is in progress.
    - Completed - The job has completed.
    - Failed - The transform job has failed. To see the reason for the failure, see the FailureReason field in the response to a DescribeTransformJob call.
    - Stopping - The transform job is stopping.
    - Stopped - The transform job has stopped.
    If the service returns an enum value that is not available in the current SDK version, transformJobStatus will return TransformJobStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from transformJobStatusAsString().
    Returns:
    The status of the transform job.
    
    Transform job statuses are:
    
    InProgress - The job is in progress.
    
    Completed - The job has completed.
    
    Failed - The transform job has failed. To see the reason for the failure, see the FailureReason field in the response to a DescribeTransformJob call.
    
    Stopping - The transform job is stopping.
    
    Stopped - The transform job has stopped.
    See Also:
    
    TransformJobStatus
  - failureReason
```
public final String failureReason()
```
    If the transform job failed, the reason it failed.
    
    Returns:
    
    If the transform job failed, the reason it failed.
  - modelName
```
public final String modelName()
```
    The name of the model associated with the transform job.
    
    Returns:
    
    The name of the model associated with the transform job.
  - 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, 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 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, 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 built-in algorithms, you don't need to set a value for MaxConcurrentTransforms.
  - modelClientConfig
```
public final ModelClientConfig modelClientConfig()
```
    Returns the value of the ModelClientConfig property for this object.
    
    Returns:
    
    The value of the ModelClientConfig property for this object.
  - 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, 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, 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.
    
    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.
    
    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.
    
    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.
    
    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()
```
    Returns the value of the TransformInput property for this object.
    
    Returns:
    
    The value of the TransformInput property for this object.
  - transformOutput
```
public final TransformOutput transformOutput()
```
    Returns the value of the TransformOutput property for this object.
    
    Returns:
    
    The value of the TransformOutput property for this object.
  - transformResources
```
public final TransformResources transformResources()
```
    Returns the value of the TransformResources property for this object.
    
    Returns:
    
    The value of the TransformResources property for this object.
  - creationTime
```
public final Instant creationTime()
```
    A timestamp that shows when the transform Job was created.
    
    Returns:
    
    A timestamp that shows when the transform Job was created.
  - transformStartTime
```
public final Instant transformStartTime()
```
    Indicates when the transform job starts on ML instances. You are billed for the time interval between this time and the value of TransformEndTime.
    
    Returns:
    
    Indicates when the transform job starts on ML instances. You are billed for the time interval between this time and the value of TransformEndTime.
  - transformEndTime
```
public final Instant transformEndTime()
```
    Indicates when the transform job has been completed, or has stopped or failed. You are billed for the time interval between this time and the value of TransformStartTime.
    
    Returns:
    
    Indicates when the transform job has been completed, or has stopped or failed. You are billed for the time interval between this time and the value of TransformStartTime.
  - labelingJobArn
```
public final String labelingJobArn()
```
    The Amazon Resource Name (ARN) of the labeling job that created the transform job.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the labeling job that created the transform job.
  - autoMLJobArn
```
public final String autoMLJobArn()
```
    The Amazon Resource Name (ARN) of the AutoML job that created the transform job.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the AutoML job that created the transform job.
  - dataProcessing
```
public final DataProcessing dataProcessing()
```
    Returns the value of the DataProcessing property for this object.
    
    Returns:
    
    The value of the DataProcessing property for this object.
  - 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.
  - 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()
```
    A list of tags associated with the transform job.
    
    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:
    
    A list of tags associated with the transform job.
  - toBuilder
```
public TransformJob.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<TransformJob.Builder,TransformJob>
  - builder
```
public static TransformJob.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends TransformJob.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

Class TransformJob

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

transformJobName

transformJobArn

transformJobStatus

transformJobStatusAsString

failureReason

modelName

maxConcurrentTransforms

modelClientConfig

maxPayloadInMB

batchStrategy

batchStrategyAsString

hasEnvironment

environment

transformInput

transformOutput

transformResources

creationTime

transformStartTime

transformEndTime

labelingJobArn

autoMLJobArn

dataProcessing

experimentConfig

hasTags

tags

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields