@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class TransformJob extends Object implements Serializable, Cloneable, StructuredPojo
A batch transform job. For information about SageMaker batch transform, see Use Batch Transform.
Constructor and Description |
---|
TransformJob() |
Modifier and Type | Method and Description |
---|---|
TransformJob |
addEnvironmentEntry(String key,
String value)
Add a single Environment entry
|
TransformJob |
clearEnvironmentEntries()
Removes all the entries added into Environment.
|
TransformJob |
clone() |
boolean |
equals(Object obj) |
String |
getAutoMLJobArn()
The Amazon Resource Name (ARN) of the AutoML job that created the transform job.
|
String |
getBatchStrategy()
Specifies the number of records to include in a mini-batch for an HTTP inference request.
|
Date |
getCreationTime()
A timestamp that shows when the transform Job was created.
|
BatchDataCaptureConfig |
getDataCaptureConfig() |
DataProcessing |
getDataProcessing() |
Map<String,String> |
getEnvironment()
The environment variables to set in the Docker container.
|
ExperimentConfig |
getExperimentConfig() |
String |
getFailureReason()
If the transform job failed, the reason it failed.
|
String |
getLabelingJobArn()
The Amazon Resource Name (ARN) of the labeling job that created the transform job.
|
Integer |
getMaxConcurrentTransforms()
The maximum number of parallel requests that can be sent to each instance in a transform job.
|
Integer |
getMaxPayloadInMB()
The maximum allowed size of the payload, in MB.
|
ModelClientConfig |
getModelClientConfig() |
String |
getModelName()
The name of the model associated with the transform job.
|
List<Tag> |
getTags()
A list of tags associated with the transform job.
|
Date |
getTransformEndTime()
Indicates when the transform job has been completed, or has stopped or failed.
|
TransformInput |
getTransformInput() |
String |
getTransformJobArn()
The Amazon Resource Name (ARN) of the transform job.
|
String |
getTransformJobName()
The name of the transform job.
|
String |
getTransformJobStatus()
The status of the transform job.
|
TransformOutput |
getTransformOutput() |
TransformResources |
getTransformResources() |
Date |
getTransformStartTime()
Indicates when the transform job starts on ML instances.
|
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setAutoMLJobArn(String autoMLJobArn)
The Amazon Resource Name (ARN) of the AutoML job that created the transform job.
|
void |
setBatchStrategy(String batchStrategy)
Specifies the number of records to include in a mini-batch for an HTTP inference request.
|
void |
setCreationTime(Date creationTime)
A timestamp that shows when the transform Job was created.
|
void |
setDataCaptureConfig(BatchDataCaptureConfig dataCaptureConfig) |
void |
setDataProcessing(DataProcessing dataProcessing) |
void |
setEnvironment(Map<String,String> environment)
The environment variables to set in the Docker container.
|
void |
setExperimentConfig(ExperimentConfig experimentConfig) |
void |
setFailureReason(String failureReason)
If the transform job failed, the reason it failed.
|
void |
setLabelingJobArn(String labelingJobArn)
The Amazon Resource Name (ARN) of the labeling job that created the transform job.
|
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 allowed size of the payload, in MB.
|
void |
setModelClientConfig(ModelClientConfig modelClientConfig) |
void |
setModelName(String modelName)
The name of the model associated with the transform job.
|
void |
setTags(Collection<Tag> tags)
A list of tags associated with the transform job.
|
void |
setTransformEndTime(Date transformEndTime)
Indicates when the transform job has been completed, or has stopped or failed.
|
void |
setTransformInput(TransformInput transformInput) |
void |
setTransformJobArn(String transformJobArn)
The Amazon Resource Name (ARN) of the transform job.
|
void |
setTransformJobName(String transformJobName)
The name of the transform job.
|
void |
setTransformJobStatus(String transformJobStatus)
The status of the transform job.
|
void |
setTransformOutput(TransformOutput transformOutput) |
void |
setTransformResources(TransformResources transformResources) |
void |
setTransformStartTime(Date transformStartTime)
Indicates when the transform job starts on ML instances.
|
String |
toString()
Returns a string representation of this object.
|
TransformJob |
withAutoMLJobArn(String autoMLJobArn)
The Amazon Resource Name (ARN) of the AutoML job that created the transform job.
|
TransformJob |
withBatchStrategy(BatchStrategy batchStrategy)
Specifies the number of records to include in a mini-batch for an HTTP inference request.
|
TransformJob |
withBatchStrategy(String batchStrategy)
Specifies the number of records to include in a mini-batch for an HTTP inference request.
|
TransformJob |
withCreationTime(Date creationTime)
A timestamp that shows when the transform Job was created.
|
TransformJob |
withDataCaptureConfig(BatchDataCaptureConfig dataCaptureConfig) |
TransformJob |
withDataProcessing(DataProcessing dataProcessing) |
TransformJob |
withEnvironment(Map<String,String> environment)
The environment variables to set in the Docker container.
|
TransformJob |
withExperimentConfig(ExperimentConfig experimentConfig) |
TransformJob |
withFailureReason(String failureReason)
If the transform job failed, the reason it failed.
|
TransformJob |
withLabelingJobArn(String labelingJobArn)
The Amazon Resource Name (ARN) of the labeling job that created the transform job.
|
TransformJob |
withMaxConcurrentTransforms(Integer maxConcurrentTransforms)
The maximum number of parallel requests that can be sent to each instance in a transform job.
|
TransformJob |
withMaxPayloadInMB(Integer maxPayloadInMB)
The maximum allowed size of the payload, in MB.
|
TransformJob |
withModelClientConfig(ModelClientConfig modelClientConfig) |
TransformJob |
withModelName(String modelName)
The name of the model associated with the transform job.
|
TransformJob |
withTags(Collection<Tag> tags)
A list of tags associated with the transform job.
|
TransformJob |
withTags(Tag... tags)
A list of tags associated with the transform job.
|
TransformJob |
withTransformEndTime(Date transformEndTime)
Indicates when the transform job has been completed, or has stopped or failed.
|
TransformJob |
withTransformInput(TransformInput transformInput) |
TransformJob |
withTransformJobArn(String transformJobArn)
The Amazon Resource Name (ARN) of the transform job.
|
TransformJob |
withTransformJobName(String transformJobName)
The name of the transform job.
|
TransformJob |
withTransformJobStatus(String transformJobStatus)
The status of the transform job.
|
TransformJob |
withTransformJobStatus(TransformJobStatus transformJobStatus)
The status of the transform job.
|
TransformJob |
withTransformOutput(TransformOutput transformOutput) |
TransformJob |
withTransformResources(TransformResources transformResources) |
TransformJob |
withTransformStartTime(Date transformStartTime)
Indicates when the transform job starts on ML instances.
|
public void setTransformJobName(String transformJobName)
The name of the transform job.
transformJobName
- The name of the transform job.public String getTransformJobName()
The name of the transform job.
public TransformJob withTransformJobName(String transformJobName)
The name of the transform job.
transformJobName
- The name of the transform job.public void setTransformJobArn(String transformJobArn)
The Amazon Resource Name (ARN) of the transform job.
transformJobArn
- The Amazon Resource Name (ARN) of the transform job.public String getTransformJobArn()
The Amazon Resource Name (ARN) of the transform job.
public TransformJob withTransformJobArn(String transformJobArn)
The Amazon Resource Name (ARN) of the transform job.
transformJobArn
- The Amazon Resource Name (ARN) of the transform job.public void setTransformJobStatus(String 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.
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.
TransformJobStatus
public String getTransformJobStatus()
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.
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.
TransformJobStatus
public TransformJob withTransformJobStatus(String 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.
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.
TransformJobStatus
public TransformJob withTransformJobStatus(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.
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.
TransformJobStatus
public void setFailureReason(String failureReason)
If the transform job failed, the reason it failed.
failureReason
- If the transform job failed, the reason it failed.public String getFailureReason()
If the transform job failed, the reason it failed.
public TransformJob withFailureReason(String failureReason)
If the transform job failed, the reason it failed.
failureReason
- If the transform job failed, the reason it failed.public void setModelName(String modelName)
The name of the model associated with the transform job.
modelName
- The name of the model associated with the transform job.public String getModelName()
The name of the model associated with the transform job.
public TransformJob withModelName(String modelName)
The name of the model associated with the transform job.
modelName
- The name of the model associated with the transform job.public void setMaxConcurrentTransforms(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
.
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
.public Integer getMaxConcurrentTransforms()
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
.
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
.public TransformJob withMaxConcurrentTransforms(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
.
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
.public void setModelClientConfig(ModelClientConfig modelClientConfig)
modelClientConfig
- public ModelClientConfig getModelClientConfig()
public TransformJob withModelClientConfig(ModelClientConfig modelClientConfig)
modelClientConfig
- public void setMaxPayloadInMB(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.
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.public Integer getMaxPayloadInMB()
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.
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.public TransformJob withMaxPayloadInMB(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.
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.public void setBatchStrategy(String 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.
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.BatchStrategy
public String getBatchStrategy()
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.
BatchStrategy
public TransformJob withBatchStrategy(String 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.
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.BatchStrategy
public TransformJob withBatchStrategy(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.
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.BatchStrategy
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.
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.
environment
- The environment variables to set in the Docker container. We support up to 16 key and values entries in
the map.public TransformJob 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.
environment
- The environment variables to set in the Docker container. We support up to 16 key and values entries in
the map.public TransformJob addEnvironmentEntry(String key, String value)
public TransformJob clearEnvironmentEntries()
public void setTransformInput(TransformInput transformInput)
transformInput
- public TransformInput getTransformInput()
public TransformJob withTransformInput(TransformInput transformInput)
transformInput
- public void setTransformOutput(TransformOutput transformOutput)
transformOutput
- public TransformOutput getTransformOutput()
public TransformJob withTransformOutput(TransformOutput transformOutput)
transformOutput
- public void setDataCaptureConfig(BatchDataCaptureConfig dataCaptureConfig)
dataCaptureConfig
- public BatchDataCaptureConfig getDataCaptureConfig()
public TransformJob withDataCaptureConfig(BatchDataCaptureConfig dataCaptureConfig)
dataCaptureConfig
- public void setTransformResources(TransformResources transformResources)
transformResources
- public TransformResources getTransformResources()
public TransformJob withTransformResources(TransformResources transformResources)
transformResources
- public void setCreationTime(Date creationTime)
A timestamp that shows when the transform Job was created.
creationTime
- A timestamp that shows when the transform Job was created.public Date getCreationTime()
A timestamp that shows when the transform Job was created.
public TransformJob withCreationTime(Date creationTime)
A timestamp that shows when the transform Job was created.
creationTime
- A timestamp that shows when the transform Job was created.public void setTransformStartTime(Date 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
.
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
.public Date getTransformStartTime()
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 TransformJob withTransformStartTime(Date 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
.
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
.public void setTransformEndTime(Date 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
.
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
.public Date getTransformEndTime()
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
.
TransformStartTime
.public TransformJob withTransformEndTime(Date 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
.
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
.public void setLabelingJobArn(String labelingJobArn)
The Amazon Resource Name (ARN) of the labeling job that created the transform job.
labelingJobArn
- The Amazon Resource Name (ARN) of the labeling job that created the transform job.public String getLabelingJobArn()
The Amazon Resource Name (ARN) of the labeling job that created the transform job.
public TransformJob withLabelingJobArn(String labelingJobArn)
The Amazon Resource Name (ARN) of the labeling job that created the transform job.
labelingJobArn
- The Amazon Resource Name (ARN) of the labeling job that created the transform job.public void setAutoMLJobArn(String autoMLJobArn)
The Amazon Resource Name (ARN) of the AutoML job that created the transform job.
autoMLJobArn
- The Amazon Resource Name (ARN) of the AutoML job that created the transform job.public String getAutoMLJobArn()
The Amazon Resource Name (ARN) of the AutoML job that created the transform job.
public TransformJob withAutoMLJobArn(String autoMLJobArn)
The Amazon Resource Name (ARN) of the AutoML job that created the transform job.
autoMLJobArn
- The Amazon Resource Name (ARN) of the AutoML job that created the transform job.public void setDataProcessing(DataProcessing dataProcessing)
dataProcessing
- public DataProcessing getDataProcessing()
public TransformJob withDataProcessing(DataProcessing dataProcessing)
dataProcessing
- public void setExperimentConfig(ExperimentConfig experimentConfig)
experimentConfig
- public ExperimentConfig getExperimentConfig()
public TransformJob withExperimentConfig(ExperimentConfig experimentConfig)
experimentConfig
- public List<Tag> getTags()
A list of tags associated with the transform job.
public void setTags(Collection<Tag> tags)
A list of tags associated with the transform job.
tags
- A list of tags associated with the transform job.public TransformJob withTags(Tag... tags)
A list of tags associated with the transform job.
NOTE: This method appends the values to the existing list (if any). Use
setTags(java.util.Collection)
or withTags(java.util.Collection)
if you want to override the
existing values.
tags
- A list of tags associated with the transform job.public TransformJob withTags(Collection<Tag> tags)
A list of tags associated with the transform job.
tags
- A list of tags associated with the transform job.public String toString()
toString
in class Object
Object.toString()
public TransformJob clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.