TransformJobDefinition (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.sagemaker.model.TransformJobDefinition

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class TransformJobDefinition
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Defines the input needed to run a transform job using the inference specification specified in the algorithm.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

TransformJobDefinition()

Constructors
Constructor and Description
`TransformJobDefinition()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`TransformJobDefinition`	`addEnvironmentEntry(String key, String value)`
`TransformJobDefinition`	`clearEnvironmentEntries()` Removes all the entries added into Environment.
`TransformJobDefinition`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getBatchStrategy()` A string that determines the number of records included in a single 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 each instance in a transform job.
`Integer`	`getMaxPayloadInMB()` The maximum payload size allowed, in MB.
`TransformInput`	`getTransformInput()` A description of the input source and the way the transform job consumes it.
`TransformOutput`	`getTransformOutput()` Identifies the Amazon S3 location where you want Amazon SageMaker to save the results from the transform job.
`TransformResources`	`getTransformResources()` Identifies the ML compute instances for the transform job.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setBatchStrategy(String batchStrategy)` A string that determines the number of records included in a single 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 each instance in a transform job.
`void`	`setMaxPayloadInMB(Integer maxPayloadInMB)` The maximum payload size allowed, in MB.
`void`	`setTransformInput(TransformInput transformInput)` A description of the input source and the way the transform job consumes it.
`void`	`setTransformOutput(TransformOutput transformOutput)` Identifies the Amazon S3 location where you want Amazon SageMaker to save the results from the transform job.
`void`	`setTransformResources(TransformResources transformResources)` Identifies the ML compute instances for the transform job.
`String`	`toString()` Returns a string representation of this object.
`TransformJobDefinition`	`withBatchStrategy(BatchStrategy batchStrategy)` A string that determines the number of records included in a single mini-batch.
`TransformJobDefinition`	`withBatchStrategy(String batchStrategy)` A string that determines the number of records included in a single mini-batch.
`TransformJobDefinition`	`withEnvironment(Map<String,String> environment)` The environment variables to set in the Docker container.
`TransformJobDefinition`	`withMaxConcurrentTransforms(Integer maxConcurrentTransforms)` The maximum number of parallel requests that can be sent to each instance in a transform job.
`TransformJobDefinition`	`withMaxPayloadInMB(Integer maxPayloadInMB)` The maximum payload size allowed, in MB.
`TransformJobDefinition`	`withTransformInput(TransformInput transformInput)` A description of the input source and the way the transform job consumes it.
`TransformJobDefinition`	`withTransformOutput(TransformOutput transformOutput)` Identifies the Amazon S3 location where you want Amazon SageMaker to save the results from the transform job.
`TransformJobDefinition`	`withTransformResources(TransformResources transformResources)` Identifies the ML compute instances for the transform job.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - TransformJobDefinition
```
public TransformJobDefinition()
```
- Method Detail
  - setMaxConcurrentTransforms
```
public void setMaxConcurrentTransforms(Integer maxConcurrentTransforms)
```
    The maximum number of parallel requests that can be sent to each instance in a transform job. The default value is 1.
    
    Parameters:
    
    maxConcurrentTransforms - The maximum number of parallel requests that can be sent to each instance in a transform job. The default value is 1.
  - getMaxConcurrentTransforms
```
public Integer getMaxConcurrentTransforms()
```
    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.
  - withMaxConcurrentTransforms
```
public TransformJobDefinition withMaxConcurrentTransforms(Integer maxConcurrentTransforms)
```
    The maximum number of parallel requests that can be sent to each instance in a transform job. The default value is 1.
    
    Parameters:
    
    maxConcurrentTransforms - The maximum number of parallel requests that can be sent to each instance in a transform job. The default value is 1.
    
    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).
    
    Parameters:
    
    maxPayloadInMB - The maximum payload size allowed, in MB. A payload is the data portion of a record (without metadata).
  - getMaxPayloadInMB
```
public Integer getMaxPayloadInMB()
```
    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).
  - withMaxPayloadInMB
```
public TransformJobDefinition withMaxPayloadInMB(Integer maxPayloadInMB)
```
    The maximum payload size allowed, in MB. A payload is the data portion of a record (without metadata).
    
    Parameters:
    
    maxPayloadInMB - The maximum payload size allowed, in MB. A payload is the data portion of a record (without metadata).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setBatchStrategy
```
public void setBatchStrategy(String 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.
    
    Parameters:
    
    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.
    
    See Also:
    
    BatchStrategy
  - getBatchStrategy
```
public String getBatchStrategy()
```
    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.
    
    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
  - withBatchStrategy
```
public TransformJobDefinition withBatchStrategy(String 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    BatchStrategy
  - withBatchStrategy
```
public TransformJobDefinition withBatchStrategy(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.
    
    Parameters:
    
    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.
    
    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 TransformJobDefinition 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 TransformJobDefinition addEnvironmentEntry(String key,
                                                  String value)
```
  - clearEnvironmentEntries
```
public TransformJobDefinition 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)
```
    A description of the input source and the way the transform job consumes it.
    
    Parameters:
    
    transformInput - A description of the input source and the way the transform job consumes it.
  - getTransformInput
```
public TransformInput getTransformInput()
```
    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.
  - withTransformInput
```
public TransformJobDefinition withTransformInput(TransformInput transformInput)
```
    A description of the input source and the way the transform job consumes it.
    
    Parameters:
    
    transformInput - A description of 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)
```
    Identifies the Amazon S3 location where you want Amazon SageMaker to save the results from the transform job.
    
    Parameters:
    
    transformOutput - Identifies the Amazon S3 location where you want Amazon SageMaker to save the results from the transform job.
  - getTransformOutput
```
public TransformOutput getTransformOutput()
```
    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.
  - withTransformOutput
```
public TransformJobDefinition withTransformOutput(TransformOutput transformOutput)
```
    Identifies the Amazon S3 location where you want Amazon SageMaker to save the results from the transform job.
    
    Parameters:
    
    transformOutput - Identifies the Amazon S3 location where you want Amazon SageMaker to save the results from the transform job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTransformResources
```
public void setTransformResources(TransformResources transformResources)
```
    Identifies the ML compute instances for the transform job.
    
    Parameters:
    
    transformResources - Identifies the ML compute instances for the transform job.
  - getTransformResources
```
public TransformResources getTransformResources()
```
    Identifies the ML compute instances for the transform job.
    
    Returns:
    
    Identifies the ML compute instances for the transform job.
  - withTransformResources
```
public TransformJobDefinition withTransformResources(TransformResources transformResources)
```
    Identifies the ML compute instances for the transform job.
    
    Parameters:
    
    transformResources - Identifies the ML compute instances for the transform job.
    
    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 TransformJobDefinition clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class TransformJobDefinition

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TransformJobDefinition

Method Detail

setMaxConcurrentTransforms

getMaxConcurrentTransforms

withMaxConcurrentTransforms

setMaxPayloadInMB

getMaxPayloadInMB

withMaxPayloadInMB

setBatchStrategy

getBatchStrategy

withBatchStrategy

withBatchStrategy

getEnvironment

setEnvironment

withEnvironment

addEnvironmentEntry

clearEnvironmentEntries

setTransformInput

getTransformInput

withTransformInput

setTransformOutput

getTransformOutput

withTransformOutput

setTransformResources

getTransformResources

withTransformResources

toString

equals

hashCode

clone

marshall