software.amazon.awssdk.services.sagemaker.model

Interface DescribeTransformJobResponse.Builder

All Superinterfaces:

AwsResponse.Builder, Buildable, CopyableBuilder<DescribeTransformJobResponse.Builder,DescribeTransformJobResponse>, SageMakerResponse.Builder, SdkBuilder<DescribeTransformJobResponse.Builder,DescribeTransformJobResponse>, SdkPojo, SdkResponse.Builder

Enclosing class:

DescribeTransformJobResponse

public static interface DescribeTransformJobResponse.Builder
extends SageMakerResponse.Builder, SdkPojo, CopyableBuilder<DescribeTransformJobResponse.Builder,DescribeTransformJobResponse>

Method Summary

Modifier and Type	Method and Description
DescribeTransformJobResponse.Builder	autoMLJobArn(String autoMLJobArn) The Amazon Resource Name (ARN) of the AutoML transform job.
DescribeTransformJobResponse.Builder	batchStrategy(BatchStrategy batchStrategy) Specifies the number of records to include in a mini-batch for an HTTP inference request.
DescribeTransformJobResponse.Builder	batchStrategy(String batchStrategy) Specifies the number of records to include in a mini-batch for an HTTP inference request.
DescribeTransformJobResponse.Builder	creationTime(Instant creationTime) A timestamp that shows when the transform Job was created.
DescribeTransformJobResponse.Builder	dataCaptureConfig(BatchDataCaptureConfig dataCaptureConfig) Configuration to control how SageMaker captures inference data.
default DescribeTransformJobResponse.Builder	dataCaptureConfig(Consumer<BatchDataCaptureConfig.Builder> dataCaptureConfig) Configuration to control how SageMaker captures inference data.
default DescribeTransformJobResponse.Builder	dataProcessing(Consumer<DataProcessing.Builder> dataProcessing) Sets the value of the DataProcessing property for this object.
DescribeTransformJobResponse.Builder	dataProcessing(DataProcessing dataProcessing) Sets the value of the DataProcessing property for this object.
DescribeTransformJobResponse.Builder	environment(Map<String,String> environment) The environment variables to set in the Docker container.
default DescribeTransformJobResponse.Builder	experimentConfig(Consumer<ExperimentConfig.Builder> experimentConfig) Sets the value of the ExperimentConfig property for this object.
DescribeTransformJobResponse.Builder	experimentConfig(ExperimentConfig experimentConfig) Sets the value of the ExperimentConfig property for this object.
DescribeTransformJobResponse.Builder	failureReason(String failureReason) If the transform job failed, FailureReason describes why it failed.
DescribeTransformJobResponse.Builder	labelingJobArn(String labelingJobArn) The Amazon Resource Name (ARN) of the Amazon SageMaker Ground Truth labeling job that created the transform or training job.
DescribeTransformJobResponse.Builder	maxConcurrentTransforms(Integer maxConcurrentTransforms) The maximum number of parallel requests on each instance node that can be launched in a transform job.
DescribeTransformJobResponse.Builder	maxPayloadInMB(Integer maxPayloadInMB) The maximum payload size, in MB, used in the transform job.
default DescribeTransformJobResponse.Builder	modelClientConfig(Consumer<ModelClientConfig.Builder> modelClientConfig) The timeout and maximum number of retries for processing a transform job invocation.
DescribeTransformJobResponse.Builder	modelClientConfig(ModelClientConfig modelClientConfig) The timeout and maximum number of retries for processing a transform job invocation.
DescribeTransformJobResponse.Builder	modelName(String modelName) The name of the model used in the transform job.
DescribeTransformJobResponse.Builder	transformEndTime(Instant transformEndTime) Indicates when the transform job has been completed, or has stopped or failed.
default DescribeTransformJobResponse.Builder	transformInput(Consumer<TransformInput.Builder> transformInput) Describes the dataset to be transformed and the Amazon S3 location where it is stored.
DescribeTransformJobResponse.Builder	transformInput(TransformInput transformInput) Describes the dataset to be transformed and the Amazon S3 location where it is stored.
DescribeTransformJobResponse.Builder	transformJobArn(String transformJobArn) The Amazon Resource Name (ARN) of the transform job.
DescribeTransformJobResponse.Builder	transformJobName(String transformJobName) The name of the transform job.
DescribeTransformJobResponse.Builder	transformJobStatus(String transformJobStatus) The status of the transform job.
DescribeTransformJobResponse.Builder	transformJobStatus(TransformJobStatus transformJobStatus) The status of the transform job.
default DescribeTransformJobResponse.Builder	transformOutput(Consumer<TransformOutput.Builder> transformOutput) Identifies the Amazon S3 location where you want Amazon SageMaker to save the results from the transform job.
DescribeTransformJobResponse.Builder	transformOutput(TransformOutput transformOutput) Identifies the Amazon S3 location where you want Amazon SageMaker to save the results from the transform job.
default DescribeTransformJobResponse.Builder	transformResources(Consumer<TransformResources.Builder> transformResources) Describes the resources, including ML instance types and ML instance count, to use for the transform job.
DescribeTransformJobResponse.Builder	transformResources(TransformResources transformResources) Describes the resources, including ML instance types and ML instance count, to use for the transform job.
DescribeTransformJobResponse.Builder	transformStartTime(Instant transformStartTime) Indicates when the transform job starts on ML instances.

Methods inherited from interface software.amazon.awssdk.services.sagemaker.model.SageMakerResponse.Builder

build, responseMetadata, responseMetadata

Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder

sdkHttpResponse, sdkHttpResponse

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

transformJobName

DescribeTransformJobResponse.Builder transformJobName(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.

transformJobArn

DescribeTransformJobResponse.Builder transformJobArn(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.

transformJobStatus

DescribeTransformJobResponse.Builder transformJobStatus(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, TransformJobStatus

transformJobStatus

DescribeTransformJobResponse.Builder transformJobStatus(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, TransformJobStatus

failureReason

DescribeTransformJobResponse.Builder failureReason(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.

modelName

DescribeTransformJobResponse.Builder modelName(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.

maxConcurrentTransforms

DescribeTransformJobResponse.Builder maxConcurrentTransforms(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.

modelClientConfig

DescribeTransformJobResponse.Builder modelClientConfig(ModelClientConfig modelClientConfig)

The timeout and maximum number of retries for processing a transform job invocation.

Parameters:

modelClientConfig - The timeout and maximum number of retries for processing a transform job invocation.

Returns:

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

modelClientConfig

default DescribeTransformJobResponse.Builder modelClientConfig(Consumer<ModelClientConfig.Builder> modelClientConfig)

The timeout and maximum number of retries for processing a transform job invocation.

This is a convenience method that creates an instance of the ModelClientConfig.Builder avoiding the need to create one manually via ModelClientConfig.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to modelClientConfig(ModelClientConfig).

Parameters:

modelClientConfig - a consumer that will call methods on ModelClientConfig.Builder

Returns:

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

See Also:

modelClientConfig(ModelClientConfig)

maxPayloadInMB

DescribeTransformJobResponse.Builder maxPayloadInMB(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.

batchStrategy

DescribeTransformJobResponse.Builder batchStrategy(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, BatchStrategy

batchStrategy

DescribeTransformJobResponse.Builder batchStrategy(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, BatchStrategy

environment

DescribeTransformJobResponse.Builder environment(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.

transformInput

DescribeTransformJobResponse.Builder transformInput(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.

transformInput

default DescribeTransformJobResponse.Builder transformInput(Consumer<TransformInput.Builder> transformInput)

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

This is a convenience method that creates an instance of the TransformInput.Builder avoiding the need to create one manually via TransformInput.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to transformInput(TransformInput).

Parameters:

transformInput - a consumer that will call methods on TransformInput.Builder

Returns:

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

See Also:

transformInput(TransformInput)

transformOutput

DescribeTransformJobResponse.Builder transformOutput(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.

transformOutput

default DescribeTransformJobResponse.Builder transformOutput(Consumer<TransformOutput.Builder> transformOutput)

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

This is a convenience method that creates an instance of the TransformOutput.Builder avoiding the need to create one manually via TransformOutput.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to transformOutput(TransformOutput).

Parameters:

transformOutput - a consumer that will call methods on TransformOutput.Builder

Returns:

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

See Also:

transformOutput(TransformOutput)

dataCaptureConfig

DescribeTransformJobResponse.Builder dataCaptureConfig(BatchDataCaptureConfig dataCaptureConfig)

Configuration to control how SageMaker captures inference data.

Parameters:

dataCaptureConfig - Configuration to control how SageMaker captures inference data.

Returns:

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

dataCaptureConfig

default DescribeTransformJobResponse.Builder dataCaptureConfig(Consumer<BatchDataCaptureConfig.Builder> dataCaptureConfig)

Configuration to control how SageMaker captures inference data.

This is a convenience method that creates an instance of the BatchDataCaptureConfig.Builder avoiding the need to create one manually via BatchDataCaptureConfig.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to dataCaptureConfig(BatchDataCaptureConfig).

Parameters:

dataCaptureConfig - a consumer that will call methods on BatchDataCaptureConfig.Builder

Returns:

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

See Also:

dataCaptureConfig(BatchDataCaptureConfig)

transformResources

DescribeTransformJobResponse.Builder transformResources(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.

transformResources

default DescribeTransformJobResponse.Builder transformResources(Consumer<TransformResources.Builder> transformResources)

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

This is a convenience method that creates an instance of the TransformResources.Builder avoiding the need to create one manually via TransformResources.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to transformResources(TransformResources).

Parameters:

transformResources - a consumer that will call methods on TransformResources.Builder

Returns:

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

See Also:

transformResources(TransformResources)

creationTime

DescribeTransformJobResponse.Builder creationTime(Instant 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.

transformStartTime

DescribeTransformJobResponse.Builder transformStartTime(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.

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.

transformEndTime

DescribeTransformJobResponse.Builder transformEndTime(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.

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.

labelingJobArn

DescribeTransformJobResponse.Builder labelingJobArn(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.

autoMLJobArn

DescribeTransformJobResponse.Builder autoMLJobArn(String autoMLJobArn)

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

Parameters:

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

Returns:

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

dataProcessing

DescribeTransformJobResponse.Builder dataProcessing(DataProcessing dataProcessing)

Sets the value of the DataProcessing property for this object.

Parameters:

dataProcessing - The new value for the DataProcessing property for this object.

Returns:

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

dataProcessing

default DescribeTransformJobResponse.Builder dataProcessing(Consumer<DataProcessing.Builder> dataProcessing)

Sets the value of the DataProcessing property for this object. This is a convenience method that creates an instance of the DataProcessing.Builder avoiding the need to create one manually via DataProcessing.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to dataProcessing(DataProcessing).

Parameters:

dataProcessing - a consumer that will call methods on DataProcessing.Builder

Returns:

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

See Also:

dataProcessing(DataProcessing)

experimentConfig

DescribeTransformJobResponse.Builder experimentConfig(ExperimentConfig experimentConfig)

Sets the value of the ExperimentConfig property for this object.

Parameters:

experimentConfig - The new value for the ExperimentConfig property for this object.

Returns:

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

experimentConfig

default DescribeTransformJobResponse.Builder experimentConfig(Consumer<ExperimentConfig.Builder> experimentConfig)

Sets the value of the ExperimentConfig property for this object. This is a convenience method that creates an instance of the ExperimentConfig.Builder avoiding the need to create one manually via ExperimentConfig.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to experimentConfig(ExperimentConfig).

Parameters:

experimentConfig - a consumer that will call methods on ExperimentConfig.Builder

Returns:

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

See Also:

experimentConfig(ExperimentConfig)