/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.sagemaker.model; import java.io.Serializable; import javax.annotation.Generated; import com.amazonaws.protocol.StructuredPojo; import com.amazonaws.protocol.ProtocolMarshaller; /** *
* A batch transform job. For information about SageMaker batch transform, see Use Batch Transform. *
* * @see AWS API * Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class TransformJob implements Serializable, Cloneable, StructuredPojo { /** ** The name of the transform job. *
*/ private String transformJobName; /** ** The Amazon Resource Name (ARN) of the transform job. *
*/ private String transformJobArn; /** ** 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.
*
* If the transform job failed, the reason it failed. *
*/ private String failureReason; /** ** The name of the model associated with the transform job. *
*/ private String modelName; /** *
* 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
.
*
* 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.
*
* 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. *
*/ private String batchStrategy; /** ** The environment variables to set in the Docker container. We support up to 16 key and values entries in the map. *
*/ private java.util.Map* A timestamp that shows when the transform Job was created. *
*/ private java.util.Date creationTime; /** *
* Indicates when the transform job starts on ML instances. You are billed for the time interval between this time
* and the value of 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
.
*
* The Amazon Resource Name (ARN) of the labeling job that created the transform job. *
*/ private String labelingJobArn; /** ** The Amazon Resource Name (ARN) of the AutoML job that created the transform job. *
*/ private String autoMLJobArn; private DataProcessing dataProcessing; private ExperimentConfig experimentConfig; /** ** A list of tags associated with the transform job. *
*/ private java.util.List* The name of the transform job. *
* * @param transformJobName * The name of the transform job. */ public void setTransformJobName(String transformJobName) { this.transformJobName = transformJobName; } /** ** The name of the transform job. *
* * @return The name of the transform job. */ public String getTransformJobName() { return this.transformJobName; } /** ** The name of the transform job. *
* * @param transformJobName * The name of the transform job. * @return Returns a reference to this object so that method calls can be chained together. */ public TransformJob withTransformJobName(String transformJobName) { setTransformJobName(transformJobName); return this; } /** ** The Amazon Resource Name (ARN) of the transform job. *
* * @param transformJobArn * The Amazon Resource Name (ARN) of the transform job. */ public void setTransformJobArn(String transformJobArn) { this.transformJobArn = transformJobArn; } /** ** The Amazon Resource Name (ARN) of the transform job. *
* * @return The Amazon Resource Name (ARN) of the transform job. */ public String getTransformJobArn() { return this.transformJobArn; } /** ** The Amazon Resource Name (ARN) of the transform job. *
* * @param transformJobArn * The Amazon Resource Name (ARN) of the transform job. * @return Returns a reference to this object so that method calls can be chained together. */ public TransformJob withTransformJobArn(String transformJobArn) { setTransformJobArn(transformJobArn); return this; } /** ** 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.
*
* 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.
*
* 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.
*
* 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.
*
* If the transform job failed, the reason it failed. *
* * @param failureReason * If the transform job failed, the reason it failed. */ public void setFailureReason(String failureReason) { this.failureReason = failureReason; } /** ** If the transform job failed, the reason it failed. *
* * @return If the transform job failed, the reason it failed. */ public String getFailureReason() { return this.failureReason; } /** ** If the transform job failed, the reason it failed. *
* * @param failureReason * If the transform job failed, the reason it failed. * @return Returns a reference to this object so that method calls can be chained together. */ public TransformJob withFailureReason(String failureReason) { setFailureReason(failureReason); return this; } /** ** The name of the model associated with the transform job. *
* * @param modelName * The name of the model associated with the transform job. */ public void setModelName(String modelName) { this.modelName = modelName; } /** ** The name of the model associated with the transform job. *
* * @return The name of the model associated with the transform job. */ public String getModelName() { return this.modelName; } /** ** The name of the model associated with the transform job. *
* * @param modelName * The name of the model associated with the transform job. * @return Returns a reference to this object so that method calls can be chained together. */ public TransformJob withModelName(String modelName) { setModelName(modelName); return this; } /** *
* 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 void setMaxConcurrentTransforms(Integer maxConcurrentTransforms) {
this.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
.
*
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() {
return this.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
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
.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public TransformJob withMaxConcurrentTransforms(Integer maxConcurrentTransforms) {
setMaxConcurrentTransforms(maxConcurrentTransforms);
return this;
}
/**
* @param modelClientConfig
*/
public void setModelClientConfig(ModelClientConfig modelClientConfig) {
this.modelClientConfig = modelClientConfig;
}
/**
* @return
*/
public ModelClientConfig getModelClientConfig() {
return this.modelClientConfig;
}
/**
* @param modelClientConfig
* @return Returns a reference to this object so that method calls can be chained together.
*/
public TransformJob withModelClientConfig(ModelClientConfig modelClientConfig) {
setModelClientConfig(modelClientConfig);
return this;
}
/**
*
* 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 void setMaxPayloadInMB(Integer maxPayloadInMB) {
this.maxPayloadInMB = 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
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() {
return this.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
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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public TransformJob withMaxPayloadInMB(Integer maxPayloadInMB) {
setMaxPayloadInMB(maxPayloadInMB);
return this;
}
/**
* * 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. *
* * @param 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. * @see BatchStrategy */ public void setBatchStrategy(String batchStrategy) { this.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. *
* * @return 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. * @see BatchStrategy */ public String getBatchStrategy() { return this.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. *
* * @param 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. * @return Returns a reference to this object so that method calls can be chained together. * @see BatchStrategy */ public TransformJob withBatchStrategy(String batchStrategy) { setBatchStrategy(batchStrategy); return this; } /** ** 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. *
* * @param 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. * @return Returns a reference to this object so that method calls can be chained together. * @see BatchStrategy */ public TransformJob withBatchStrategy(BatchStrategy batchStrategy) { this.batchStrategy = batchStrategy.toString(); return this; } /** ** The environment variables to set in the Docker container. We support up to 16 key and values entries in the map. *
* * @return The environment variables to set in the Docker container. We support up to 16 key and values entries in * the map. */ public java.util.Map* The environment variables to set in the Docker container. We support up to 16 key and values entries in the map. *
* * @param environment * The environment variables to set in the Docker container. We support up to 16 key and values entries in * the map. */ public void setEnvironment(java.util.Map* The environment variables to set in the Docker container. We support up to 16 key and values entries in the map. *
* * @param environment * The environment variables to set in the Docker container. We support up to 16 key and values entries in * the map. * @return Returns a reference to this object so that method calls can be chained together. */ public TransformJob withEnvironment(java.util.Map* A timestamp that shows when the transform Job was created. *
* * @param creationTime * A timestamp that shows when the transform Job was created. */ public void setCreationTime(java.util.Date creationTime) { this.creationTime = creationTime; } /** ** A timestamp that shows when the transform Job was created. *
* * @return A timestamp that shows when the transform Job was created. */ public java.util.Date getCreationTime() { return this.creationTime; } /** ** A timestamp that shows when the transform Job was created. *
* * @param creationTime * A timestamp that shows when the transform Job was created. * @return Returns a reference to this object so that method calls can be chained together. */ public TransformJob withCreationTime(java.util.Date creationTime) { setCreationTime(creationTime); return this; } /** *
* 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 void setTransformStartTime(java.util.Date transformStartTime) {
this.transformStartTime = 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
.
*
TransformEndTime
.
*/
public java.util.Date getTransformStartTime() {
return this.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
.
*
TransformEndTime
.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public TransformJob withTransformStartTime(java.util.Date transformStartTime) {
setTransformStartTime(transformStartTime);
return this;
}
/**
*
* 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 void setTransformEndTime(java.util.Date transformEndTime) {
this.transformEndTime = 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
.
*
TransformStartTime
.
*/
public java.util.Date getTransformEndTime() {
return this.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
.
*
TransformStartTime
.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public TransformJob withTransformEndTime(java.util.Date transformEndTime) {
setTransformEndTime(transformEndTime);
return this;
}
/**
* * The Amazon Resource Name (ARN) of the labeling job that created the transform job. *
* * @param labelingJobArn * The Amazon Resource Name (ARN) of the labeling job that created the transform job. */ public void setLabelingJobArn(String labelingJobArn) { this.labelingJobArn = labelingJobArn; } /** ** The Amazon Resource Name (ARN) of the labeling job that created the transform job. *
* * @return The Amazon Resource Name (ARN) of the labeling job that created the transform job. */ public String getLabelingJobArn() { return this.labelingJobArn; } /** ** The Amazon Resource Name (ARN) of the labeling job that created the transform job. *
* * @param labelingJobArn * The Amazon Resource Name (ARN) of the labeling job that created the transform job. * @return Returns a reference to this object so that method calls can be chained together. */ public TransformJob withLabelingJobArn(String labelingJobArn) { setLabelingJobArn(labelingJobArn); return this; } /** ** The Amazon Resource Name (ARN) of the AutoML job that created the transform job. *
* * @param autoMLJobArn * The Amazon Resource Name (ARN) of the AutoML job that created the transform job. */ public void setAutoMLJobArn(String autoMLJobArn) { this.autoMLJobArn = autoMLJobArn; } /** ** The Amazon Resource Name (ARN) of the AutoML job that created the transform job. *
* * @return The Amazon Resource Name (ARN) of the AutoML job that created the transform job. */ public String getAutoMLJobArn() { return this.autoMLJobArn; } /** ** The Amazon Resource Name (ARN) of the AutoML job that created the transform job. *
* * @param autoMLJobArn * The Amazon Resource Name (ARN) of the AutoML job that created the transform job. * @return Returns a reference to this object so that method calls can be chained together. */ public TransformJob withAutoMLJobArn(String autoMLJobArn) { setAutoMLJobArn(autoMLJobArn); return this; } /** * @param dataProcessing */ public void setDataProcessing(DataProcessing dataProcessing) { this.dataProcessing = dataProcessing; } /** * @return */ public DataProcessing getDataProcessing() { return this.dataProcessing; } /** * @param dataProcessing * @return Returns a reference to this object so that method calls can be chained together. */ public TransformJob withDataProcessing(DataProcessing dataProcessing) { setDataProcessing(dataProcessing); return this; } /** * @param experimentConfig */ public void setExperimentConfig(ExperimentConfig experimentConfig) { this.experimentConfig = experimentConfig; } /** * @return */ public ExperimentConfig getExperimentConfig() { return this.experimentConfig; } /** * @param experimentConfig * @return Returns a reference to this object so that method calls can be chained together. */ public TransformJob withExperimentConfig(ExperimentConfig experimentConfig) { setExperimentConfig(experimentConfig); return this; } /** ** A list of tags associated with the transform job. *
* * @return A list of tags associated with the transform job. */ public java.util.List* A list of tags associated with the transform job. *
* * @param tags * A list of tags associated with the transform job. */ public void setTags(java.util.Collection* A list of tags associated with the transform job. *
** NOTE: This method appends the values to the existing list (if any). Use * {@link #setTags(java.util.Collection)} or {@link #withTags(java.util.Collection)} if you want to override the * existing values. *
* * @param tags * A list of tags associated with the transform job. * @return Returns a reference to this object so that method calls can be chained together. */ public TransformJob withTags(Tag... tags) { if (this.tags == null) { setTags(new java.util.ArrayList* A list of tags associated with the transform job. *
* * @param tags * A list of tags associated with the transform job. * @return Returns a reference to this object so that method calls can be chained together. */ public TransformJob withTags(java.util.Collection