Package software.amazon.awssdk.services.sagemaker.model

Interface TransformJob.Builder

    • Method Detail

      • transformJobName

        TransformJob.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

        TransformJob.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

        TransformJob.Builder transformJobStatus​(String transformJobStatus)

        The status of the transform job.

        Transform job statuses are:

        • InProgress - The job is in progress.

        • Completed - The job has completed.

        • Failed - The transform job has failed. To see the reason for the failure, see the FailureReason field in the response to a DescribeTransformJob call.

        • Stopping - The transform job is stopping.

        • Stopped - The transform job has stopped.

        Parameters:
        transformJobStatus - The status of the transform job.

        Transform job statuses are:

        • InProgress - The job is in progress.

        • Completed - The job has completed.

        • Failed - The transform job has failed. To see the reason for the failure, see the FailureReason field in the response to a DescribeTransformJob call.

        • Stopping - The transform job is stopping.

        • Stopped - The transform job has stopped.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        TransformJobStatus, TransformJobStatus

      • transformJobStatus

        TransformJob.Builder transformJobStatus​(TransformJobStatus transformJobStatus)

        The status of the transform job.

        Transform job statuses are:

        • InProgress - The job is in progress.

        • Completed - The job has completed.

        • Failed - The transform job has failed. To see the reason for the failure, see the FailureReason field in the response to a DescribeTransformJob call.

        • Stopping - The transform job is stopping.

        • Stopped - The transform job has stopped.

        Parameters:
        transformJobStatus - The status of the transform job.

        Transform job statuses are:

        • InProgress - The job is in progress.

        • Completed - The job has completed.

        • Failed - The transform job has failed. To see the reason for the failure, see the FailureReason field in the response to a DescribeTransformJob call.

        • Stopping - The transform job is stopping.

        • Stopped - The transform job has stopped.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        TransformJobStatus, TransformJobStatus

      • failureReason

        TransformJob.Builder failureReason​(String failureReason)

        If the transform job failed, the reason it failed.

        Parameters:
        failureReason - If the transform job failed, the reason it failed.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • modelName

        TransformJob.Builder modelName​(String modelName)

        The name of the model associated with the transform job.

        Parameters:
        modelName - The name of the model associated with the transform job.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • maxConcurrentTransforms

        TransformJob.Builder maxConcurrentTransforms​(Integer maxConcurrentTransforms)

        The maximum number of parallel requests that can be sent to each instance in a transform job. If MaxConcurrentTransforms is set to 0 or left unset, SageMaker checks the optional execution-parameters to determine the settings for your chosen algorithm. If the execution-parameters endpoint is not enabled, the default value is 1. For built-in algorithms, you don't need to set a value for MaxConcurrentTransforms.

        Parameters:
        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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • modelClientConfig

        TransformJob.Builder modelClientConfig​(ModelClientConfig modelClientConfig)
        Sets the value of the ModelClientConfig property for this object.
        Parameters:
        modelClientConfig - The new value for the ModelClientConfig property for this object.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • maxPayloadInMB

        TransformJob.Builder maxPayloadInMB​(Integer maxPayloadInMB)

        The maximum allowed size of the payload, in MB. A payload is the data portion of a record (without metadata). The value in MaxPayloadInMB must be greater than, or equal to, the size of a single record. To estimate the size of a record in MB, divide the size of your dataset by the number of records. To ensure that the records fit within the maximum payload size, we recommend using a slightly larger value. The default value is 6 MB. For cases where the payload might be arbitrarily large and is transmitted using HTTP chunked encoding, set the value to 0. This feature works only in supported algorithms. Currently, SageMaker built-in algorithms do not support HTTP chunked encoding.

        Parameters:
        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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • batchStrategy

        TransformJob.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.

        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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        BatchStrategy, BatchStrategy

      • batchStrategy

        TransformJob.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.

        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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        BatchStrategy, BatchStrategy

      • environment

        TransformJob.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

        TransformJob.Builder transformInput​(TransformInput transformInput)
        Sets the value of the TransformInput property for this object.
        Parameters:
        transformInput - The new value for the TransformInput property for this object.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • transformOutput

        TransformJob.Builder transformOutput​(TransformOutput transformOutput)
        Sets the value of the TransformOutput property for this object.
        Parameters:
        transformOutput - The new value for the TransformOutput property for this object.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • dataCaptureConfig

        TransformJob.Builder dataCaptureConfig​(BatchDataCaptureConfig dataCaptureConfig)
        Sets the value of the DataCaptureConfig property for this object.
        Parameters:
        dataCaptureConfig - The new value for the DataCaptureConfig property for this object.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • transformResources

        TransformJob.Builder transformResources​(TransformResources transformResources)
        Sets the value of the TransformResources property for this object.
        Parameters:
        transformResources - The new value for the TransformResources property for this object.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • creationTime

        TransformJob.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

        TransformJob.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

        TransformJob.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

        TransformJob.Builder labelingJobArn​(String labelingJobArn)

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

        Parameters:
        labelingJobArn - The Amazon Resource Name (ARN) of the labeling job that created the transform job.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • autoMLJobArn

        TransformJob.Builder autoMLJobArn​(String autoMLJobArn)

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

        Parameters:
        autoMLJobArn - The Amazon Resource Name (ARN) of the AutoML job that created the transform job.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • dataProcessing

        TransformJob.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.

      • experimentConfig

        TransformJob.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.

      • tags

        TransformJob.Builder tags​(Collection<Tag> tags)

        A list of tags associated with the transform job.

        Parameters:
        tags - A list of tags associated with the transform job.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tags

        TransformJob.Builder tags​(Tag... tags)

        A list of tags associated with the transform job.

        Parameters:
        tags - A list of tags associated with the transform job.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tags

        TransformJob.Builder tags​(Consumer<Tag.Builder>... tags)

        A list of tags associated with the transform job.

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

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #tags(List).

        Parameters:
        tags - a consumer that will call methods on Tag.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #tags(java.util.Collection)