com.amazonaws.services.sagemaker.model

Class DescribeTransformJobResult

java.lang.Object

com.amazonaws.AmazonWebServiceResult<ResponseMetadata>

com.amazonaws.services.sagemaker.model.DescribeTransformJobResult

All Implemented Interfaces:

Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class DescribeTransformJobResult
extends AmazonWebServiceResult<ResponseMetadata>
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
DescribeTransformJobResult()

Method Summary

Modifier and Type	Method and Description
DescribeTransformJobResult	addEnvironmentEntry(String key, String value)
DescribeTransformJobResult	clearEnvironmentEntries() Removes all the entries added into Environment.
DescribeTransformJobResult	clone()
boolean	equals(Object obj)
String	getAutoMLJobArn()
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.
DataProcessing	getDataProcessing()
Map<String,String>	getEnvironment() The environment variables to set in the Docker container.
ExperimentConfig	getExperimentConfig()
String	getFailureReason() If the transform job failed, FailureReason describes why it failed.
String	getLabelingJobArn() The Amazon Resource Name (ARN) of the Amazon SageMaker Ground Truth labeling job that created the transform or training job.
Integer	getMaxConcurrentTransforms() The maximum number of parallel requests on each instance node that can be launched in a transform job.
Integer	getMaxPayloadInMB() The maximum payload size, in MB, used in the transform job.
String	getModelName() The name of the model used in the transform job.
Date	getTransformEndTime() Indicates when the transform job has been completed, or has stopped or failed.
TransformInput	getTransformInput() Describes the dataset to be transformed and the Amazon S3 location where it is stored.
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() Identifies the Amazon S3 location where you want Amazon SageMaker to save the results from the transform job.
TransformResources	getTransformResources() Describes the resources, including ML instance types and ML instance count, to use for the transform job.
Date	getTransformStartTime() Indicates when the transform job starts on ML instances.
int	hashCode()
void	setAutoMLJobArn(String autoMLJobArn)
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	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, FailureReason describes why it failed.
void	setLabelingJobArn(String labelingJobArn) The Amazon Resource Name (ARN) of the Amazon SageMaker Ground Truth labeling job that created the transform or training job.
void	setMaxConcurrentTransforms(Integer maxConcurrentTransforms) The maximum number of parallel requests on each instance node that can be launched in a transform job.
void	setMaxPayloadInMB(Integer maxPayloadInMB) The maximum payload size, in MB, used in the transform job.
void	setModelName(String modelName) The name of the model used in the transform job.
void	setTransformEndTime(Date transformEndTime) Indicates when the transform job has been completed, or has stopped or failed.
void	setTransformInput(TransformInput transformInput) Describes the dataset to be transformed and the Amazon S3 location where it is stored.
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) Identifies the Amazon S3 location where you want Amazon SageMaker to save the results from the transform job.
void	setTransformResources(TransformResources transformResources) Describes the resources, including ML instance types and ML instance count, to use for the transform job.
void	setTransformStartTime(Date transformStartTime) Indicates when the transform job starts on ML instances.
String	toString() Returns a string representation of this object.
DescribeTransformJobResult	withAutoMLJobArn(String autoMLJobArn)
DescribeTransformJobResult	withBatchStrategy(BatchStrategy batchStrategy) Specifies the number of records to include in a mini-batch for an HTTP inference request.
DescribeTransformJobResult	withBatchStrategy(String batchStrategy) Specifies the number of records to include in a mini-batch for an HTTP inference request.
DescribeTransformJobResult	withCreationTime(Date creationTime) A timestamp that shows when the transform Job was created.
DescribeTransformJobResult	withDataProcessing(DataProcessing dataProcessing)
DescribeTransformJobResult	withEnvironment(Map<String,String> environment) The environment variables to set in the Docker container.
DescribeTransformJobResult	withExperimentConfig(ExperimentConfig experimentConfig)
DescribeTransformJobResult	withFailureReason(String failureReason) If the transform job failed, FailureReason describes why it failed.
DescribeTransformJobResult	withLabelingJobArn(String labelingJobArn) The Amazon Resource Name (ARN) of the Amazon SageMaker Ground Truth labeling job that created the transform or training job.
DescribeTransformJobResult	withMaxConcurrentTransforms(Integer maxConcurrentTransforms) The maximum number of parallel requests on each instance node that can be launched in a transform job.
DescribeTransformJobResult	withMaxPayloadInMB(Integer maxPayloadInMB) The maximum payload size, in MB, used in the transform job.
DescribeTransformJobResult	withModelName(String modelName) The name of the model used in the transform job.
DescribeTransformJobResult	withTransformEndTime(Date transformEndTime) Indicates when the transform job has been completed, or has stopped or failed.
DescribeTransformJobResult	withTransformInput(TransformInput transformInput) Describes the dataset to be transformed and the Amazon S3 location where it is stored.
DescribeTransformJobResult	withTransformJobArn(String transformJobArn) The Amazon Resource Name (ARN) of the transform job.
DescribeTransformJobResult	withTransformJobName(String transformJobName) The name of the transform job.
DescribeTransformJobResult	withTransformJobStatus(String transformJobStatus) The status of the transform job.
DescribeTransformJobResult	withTransformJobStatus(TransformJobStatus transformJobStatus) The status of the transform job.
DescribeTransformJobResult	withTransformOutput(TransformOutput transformOutput) Identifies the Amazon S3 location where you want Amazon SageMaker to save the results from the transform job.
DescribeTransformJobResult	withTransformResources(TransformResources transformResources) Describes the resources, including ML instance types and ML instance count, to use for the transform job.
DescribeTransformJobResult	withTransformStartTime(Date transformStartTime) Indicates when the transform job starts on ML instances.

Methods inherited from class com.amazonaws.AmazonWebServiceResult

getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata

Methods inherited from class java.lang.Object

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

Constructor Detail

DescribeTransformJobResult

public DescribeTransformJobResult()

Method Detail

setTransformJobName

public void setTransformJobName(String transformJobName)

The name of the transform job.

Parameters:

transformJobName - The name of the transform job.

getTransformJobName

public String getTransformJobName()

The name of the transform job.

Returns:

The name of the transform job.

withTransformJobName

public DescribeTransformJobResult withTransformJobName(String transformJobName)

The name of the transform job.

Parameters:

transformJobName - The name of the transform job.

Returns:

Returns a reference to this object so that method calls can be chained together.

setTransformJobArn

public void setTransformJobArn(String transformJobArn)

The Amazon Resource Name (ARN) of the transform job.

Parameters:

transformJobArn - The Amazon Resource Name (ARN) of the transform job.

getTransformJobArn

public String getTransformJobArn()

The Amazon Resource Name (ARN) of the transform job.

Returns:

The Amazon Resource Name (ARN) of the transform job.

withTransformJobArn

public DescribeTransformJobResult withTransformJobArn(String transformJobArn)

The Amazon Resource Name (ARN) of the transform job.

Parameters:

transformJobArn - The Amazon Resource Name (ARN) of the transform job.

Returns:

Returns a reference to this object so that method calls can be chained together.

setTransformJobStatus

public void setTransformJobStatus(String transformJobStatus)

The status of the transform job. If the transform job failed, the reason is returned in the FailureReason field.

Parameters:

transformJobStatus - The status of the transform job. If the transform job failed, the reason is returned in the FailureReason field.

See Also:

TransformJobStatus

getTransformJobStatus

public String getTransformJobStatus()

The status of the transform job. If the transform job failed, the reason is returned in the FailureReason field.

Returns:

The status of the transform job. If the transform job failed, the reason is returned in the FailureReason field.

See Also:

TransformJobStatus

withTransformJobStatus

public DescribeTransformJobResult withTransformJobStatus(String transformJobStatus)

The status of the transform job. If the transform job failed, the reason is returned in the FailureReason field.

Parameters:

transformJobStatus - The status of the transform job. If the transform job failed, the reason is returned in the FailureReason field.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

TransformJobStatus

withTransformJobStatus

public DescribeTransformJobResult withTransformJobStatus(TransformJobStatus transformJobStatus)

The status of the transform job. If the transform job failed, the reason is returned in the FailureReason field.

Parameters:

transformJobStatus - The status of the transform job. If the transform job failed, the reason is returned in the FailureReason field.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

TransformJobStatus

setFailureReason

public void setFailureReason(String failureReason)

If the transform job failed, FailureReason describes why it failed. A transform job creates a log file, which includes error messages, and stores it as an Amazon S3 object. For more information, see Log Amazon SageMaker Events with Amazon CloudWatch.

Parameters:

failureReason - If the transform job failed, FailureReason describes why it failed. A transform job creates a log file, which includes error messages, and stores it as an Amazon S3 object. For more information, see Log Amazon SageMaker Events with Amazon CloudWatch.

getFailureReason

public String getFailureReason()

If the transform job failed, FailureReason describes why it failed. A transform job creates a log file, which includes error messages, and stores it as an Amazon S3 object. For more information, see Log Amazon SageMaker Events with Amazon CloudWatch.

Returns:

If the transform job failed, FailureReason describes why it failed. A transform job creates a log file, which includes error messages, and stores it as an Amazon S3 object. For more information, see Log Amazon SageMaker Events with Amazon CloudWatch.

withFailureReason

public DescribeTransformJobResult withFailureReason(String failureReason)

If the transform job failed, FailureReason describes why it failed. A transform job creates a log file, which includes error messages, and stores it as an Amazon S3 object. For more information, see Log Amazon SageMaker Events with Amazon CloudWatch.

Parameters:

failureReason - If the transform job failed, FailureReason describes why it failed. A transform job creates a log file, which includes error messages, and stores it as an Amazon S3 object. For more information, see Log Amazon SageMaker Events with Amazon CloudWatch.

Returns:

Returns a reference to this object so that method calls can be chained together.

setModelName

public void setModelName(String modelName)

The name of the model used in the transform job.

Parameters:

modelName - The name of the model used in the transform job.

getModelName

public String getModelName()

The name of the model used in the transform job.

Returns:

The name of the model used in the transform job.

withModelName

public DescribeTransformJobResult withModelName(String modelName)

The name of the model used in the transform job.

Parameters:

modelName - The name of the model used in the transform job.

Returns:

Returns a reference to this object so that method calls can be chained together.

setMaxConcurrentTransforms

public void setMaxConcurrentTransforms(Integer maxConcurrentTransforms)

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

Parameters:

maxConcurrentTransforms - The maximum number of parallel requests on each instance node that can be launched in a transform job. The default value is 1.

getMaxConcurrentTransforms

public Integer getMaxConcurrentTransforms()

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

Returns:

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

withMaxConcurrentTransforms

public DescribeTransformJobResult withMaxConcurrentTransforms(Integer maxConcurrentTransforms)

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

Parameters:

maxConcurrentTransforms - The maximum number of parallel requests on each instance node that can be launched 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, in MB, used in the transform job.

Parameters:

maxPayloadInMB - The maximum payload size, in MB, used in the transform job.

getMaxPayloadInMB

public Integer getMaxPayloadInMB()

The maximum payload size, in MB, used in the transform job.

Returns:

The maximum payload size, in MB, used in the transform job.

withMaxPayloadInMB

public DescribeTransformJobResult withMaxPayloadInMB(Integer maxPayloadInMB)

The maximum payload size, in MB, used in the transform job.

Parameters:

maxPayloadInMB - The maximum payload size, in MB, used in the transform job.

Returns:

Returns a reference to this object so that method calls can be chained together.

setBatchStrategy

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.

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

Parameters:

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 SplitType to Line, RecordIO, or TFRecord.

See Also:

BatchStrategy

getBatchStrategy

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.

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

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 SplitType to Line, RecordIO, or TFRecord.

See Also:

BatchStrategy

withBatchStrategy

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

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

Parameters:

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 SplitType to Line, RecordIO, or TFRecord.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

BatchStrategy

withBatchStrategy

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

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

Parameters:

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 SplitType to Line, RecordIO, or TFRecord.

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 DescribeTransformJobResult 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 DescribeTransformJobResult addEnvironmentEntry(String key,
                                                      String value)

clearEnvironmentEntries

public DescribeTransformJobResult 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)

Describes the dataset to be transformed and the Amazon S3 location where it is stored.

Parameters:

transformInput - Describes the dataset to be transformed and the Amazon S3 location where it is stored.

getTransformInput

public TransformInput getTransformInput()

Describes the dataset to be transformed and the Amazon S3 location where it is stored.

Returns:

Describes the dataset to be transformed and the Amazon S3 location where it is stored.

withTransformInput

public DescribeTransformJobResult withTransformInput(TransformInput transformInput)

Describes the dataset to be transformed and the Amazon S3 location where it is stored.

Parameters:

transformInput - Describes the dataset to be transformed and the Amazon S3 location where it is stored.

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

Describes the resources, including ML instance types and ML instance count, to use for the transform job.

Parameters:

transformResources - Describes the resources, including ML instance types and ML instance count, to use for the transform job.

getTransformResources

public TransformResources getTransformResources()

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.

withTransformResources

public DescribeTransformJobResult withTransformResources(TransformResources transformResources)

Describes the resources, including ML instance types and ML instance count, to use for the transform job.

Parameters:

transformResources - Describes the resources, including ML instance types and ML instance count, to use for the transform job.

Returns:

Returns a reference to this object so that method calls can be chained together.

setCreationTime

public void setCreationTime(Date creationTime)

A timestamp that shows when the transform Job was created.

Parameters:

creationTime - A timestamp that shows when the transform Job was created.

getCreationTime

public Date getCreationTime()

A timestamp that shows when the transform Job was created.

Returns:

A timestamp that shows when the transform Job was created.

withCreationTime

public DescribeTransformJobResult withCreationTime(Date creationTime)

A timestamp that shows when the transform Job was created.

Parameters:

creationTime - A timestamp that shows when the transform Job was created.

Returns:

Returns a reference to this object so that method calls can be chained together.

setTransformStartTime

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.

Parameters:

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.

getTransformStartTime

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.

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.

withTransformStartTime

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

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setTransformEndTime

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.

Parameters:

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.

getTransformEndTime

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.

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.

withTransformEndTime

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

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setLabelingJobArn

public void setLabelingJobArn(String labelingJobArn)

The Amazon Resource Name (ARN) of the Amazon SageMaker Ground Truth labeling job that created the transform or training job.

Parameters:

labelingJobArn - The Amazon Resource Name (ARN) of the Amazon SageMaker Ground Truth labeling job that created the transform or training job.

getLabelingJobArn

public String getLabelingJobArn()

The Amazon Resource Name (ARN) of the Amazon SageMaker Ground Truth labeling job that created the transform or training job.

Returns:

The Amazon Resource Name (ARN) of the Amazon SageMaker Ground Truth labeling job that created the transform or training job.

withLabelingJobArn

public DescribeTransformJobResult withLabelingJobArn(String labelingJobArn)

The Amazon Resource Name (ARN) of the Amazon SageMaker Ground Truth labeling job that created the transform or training job.

Parameters:

labelingJobArn - The Amazon Resource Name (ARN) of the Amazon SageMaker Ground Truth labeling job that created the transform or training job.

Returns:

Returns a reference to this object so that method calls can be chained together.

setAutoMLJobArn

public void setAutoMLJobArn(String autoMLJobArn)

Parameters:

autoMLJobArn -

getAutoMLJobArn

public String getAutoMLJobArn()

Returns:

withAutoMLJobArn

public DescribeTransformJobResult withAutoMLJobArn(String autoMLJobArn)

Parameters:

autoMLJobArn -

Returns:

Returns a reference to this object so that method calls can be chained together.

setDataProcessing

public void setDataProcessing(DataProcessing dataProcessing)

Parameters:

dataProcessing -

getDataProcessing

public DataProcessing getDataProcessing()

Returns:

withDataProcessing

public DescribeTransformJobResult withDataProcessing(DataProcessing dataProcessing)

Parameters:

dataProcessing -

Returns:

Returns a reference to this object so that method calls can be chained together.

setExperimentConfig

public void setExperimentConfig(ExperimentConfig experimentConfig)

Parameters:

experimentConfig -

getExperimentConfig

public ExperimentConfig getExperimentConfig()

Returns:

withExperimentConfig

public DescribeTransformJobResult withExperimentConfig(ExperimentConfig experimentConfig)

Parameters:

experimentConfig -

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

Overrides:

clone in class Object