Interface DescribeTransformJobResponse.Builder
- All Superinterfaces:
AwsResponse.Builder
,Buildable
,CopyableBuilder<DescribeTransformJobResponse.Builder,
,DescribeTransformJobResponse> SageMakerResponse.Builder
,SdkBuilder<DescribeTransformJobResponse.Builder,
,DescribeTransformJobResponse> SdkPojo
,SdkResponse.Builder
- Enclosing class:
DescribeTransformJobResponse
-
Method Summary
Modifier and TypeMethodDescriptionautoMLJobArn
(String autoMLJobArn) The Amazon Resource Name (ARN) of the AutoML transform job.batchStrategy
(String batchStrategy) Specifies the number of records to include in a mini-batch for an HTTP inference request.batchStrategy
(BatchStrategy batchStrategy) Specifies the number of records to include in a mini-batch for an HTTP inference request.creationTime
(Instant creationTime) A timestamp that shows when the transform Job was created.dataCaptureConfig
(Consumer<BatchDataCaptureConfig.Builder> dataCaptureConfig) Configuration to control how SageMaker captures inference data.dataCaptureConfig
(BatchDataCaptureConfig dataCaptureConfig) Configuration to control how SageMaker captures inference data.dataProcessing
(Consumer<DataProcessing.Builder> dataProcessing) Sets the value of the DataProcessing property for this object.dataProcessing
(DataProcessing dataProcessing) Sets the value of the DataProcessing property for this object.environment
(Map<String, String> environment) The environment variables to set in the Docker container.experimentConfig
(Consumer<ExperimentConfig.Builder> experimentConfig) Sets the value of the ExperimentConfig property for this object.experimentConfig
(ExperimentConfig experimentConfig) Sets the value of the ExperimentConfig property for this object.failureReason
(String failureReason) If the transform job failed,FailureReason
describes why it failed.labelingJobArn
(String labelingJobArn) The Amazon Resource Name (ARN) of the Amazon SageMaker Ground Truth labeling job that created the transform or training job.maxConcurrentTransforms
(Integer maxConcurrentTransforms) The maximum number of parallel requests on each instance node that can be launched in a transform job.maxPayloadInMB
(Integer maxPayloadInMB) The maximum payload size, in MB, used in the transform job.modelClientConfig
(Consumer<ModelClientConfig.Builder> modelClientConfig) The timeout and maximum number of retries for processing a transform job invocation.modelClientConfig
(ModelClientConfig modelClientConfig) The timeout and maximum number of retries for processing a transform job invocation.The name of the model used in the transform job.transformEndTime
(Instant transformEndTime) Indicates when the transform job has been completed, or has stopped or failed.transformInput
(Consumer<TransformInput.Builder> transformInput) Describes the dataset to be transformed and the Amazon S3 location where it is stored.transformInput
(TransformInput transformInput) Describes the dataset to be transformed and the Amazon S3 location where it is stored.transformJobArn
(String transformJobArn) The Amazon Resource Name (ARN) of the transform job.transformJobName
(String transformJobName) The name of the transform job.transformJobStatus
(String transformJobStatus) The status of the transform job.transformJobStatus
(TransformJobStatus transformJobStatus) The status of the transform job.transformOutput
(Consumer<TransformOutput.Builder> transformOutput) Identifies the Amazon S3 location where you want Amazon SageMaker to save the results from the transform job.transformOutput
(TransformOutput transformOutput) Identifies the Amazon S3 location where you want Amazon SageMaker to save the results from the transform job.transformResources
(Consumer<TransformResources.Builder> transformResources) Describes the resources, including ML instance types and ML instance count, to use for the transform job.transformResources
(TransformResources transformResources) Describes the resources, including ML instance types and ML instance count, to use for the transform job.transformStartTime
(Instant transformStartTime) Indicates when the transform job starts on ML instances.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.sagemaker.model.SageMakerResponse.Builder
build, responseMetadata, responseMetadata
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder
sdkHttpResponse, sdkHttpResponse
-
Method Details
-
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
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
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 theFailureReason
field.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 theFailureReason
field.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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
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
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 theModelClientConfig.Builder
avoiding the need to create one manually viaModelClientConfig.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tomodelClientConfig(ModelClientConfig)
.- Parameters:
modelClientConfig
- a consumer that will call methods onModelClientConfig.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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
toLine
,RecordIO
, orTFRecord
.- 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
toLine
,RecordIO
, orTFRecord
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
toLine
,RecordIO
, orTFRecord
.- 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
toLine
,RecordIO
, orTFRecord
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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 theTransformInput.Builder
avoiding the need to create one manually viaTransformInput.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totransformInput(TransformInput)
.- Parameters:
transformInput
- a consumer that will call methods onTransformInput.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 theTransformOutput.Builder
avoiding the need to create one manually viaTransformOutput.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totransformOutput(TransformOutput)
.- Parameters:
transformOutput
- a consumer that will call methods onTransformOutput.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 theBatchDataCaptureConfig.Builder
avoiding the need to create one manually viaBatchDataCaptureConfig.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed todataCaptureConfig(BatchDataCaptureConfig)
.- Parameters:
dataCaptureConfig
- a consumer that will call methods onBatchDataCaptureConfig.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 theTransformResources.Builder
avoiding the need to create one manually viaTransformResources.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totransformResources(TransformResources)
.- Parameters:
transformResources
- a consumer that will call methods onTransformResources.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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 ofTransformEndTime
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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 ofTransformStartTime
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
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
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 theDataProcessing.Builder
avoiding the need to create one manually viaDataProcessing.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed todataProcessing(DataProcessing)
.- Parameters:
dataProcessing
- a consumer that will call methods onDataProcessing.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 theExperimentConfig.Builder
avoiding the need to create one manually viaExperimentConfig.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toexperimentConfig(ExperimentConfig)
.- Parameters:
experimentConfig
- a consumer that will call methods onExperimentConfig.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-