Interface CreateTransformJobRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CreateTransformJobRequest.Builder,CreateTransformJobRequest>, SageMakerRequest.Builder, SdkBuilder<CreateTransformJobRequest.Builder,CreateTransformJobRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CreateTransformJobRequest
public static interface CreateTransformJobRequest.Builder extends SageMakerRequest.Builder, SdkPojo, CopyableBuilder<CreateTransformJobRequest.Builder,CreateTransformJobRequest>

  • Method Details

    • transformJobName

      CreateTransformJobRequest.Builder transformJobName(String transformJobName)

      The name of the transform job. The name must be unique within an Amazon Web Services Region in an Amazon Web Services account.

      Parameters:
      transformJobName - The name of the transform job. The name must be unique within an Amazon Web Services Region in an Amazon Web Services account.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • modelName

      CreateTransformJobRequest.Builder modelName(String modelName)

      The name of the model that you want to use for the transform job. ModelName must be the name of an existing Amazon SageMaker model within an Amazon Web Services Region in an Amazon Web Services account.

      Parameters:
      modelName - The name of the model that you want to use for the transform job. ModelName must be the name of an existing Amazon SageMaker model within an Amazon Web Services Region in an Amazon Web Services account.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • maxConcurrentTransforms

      CreateTransformJobRequest.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, Amazon 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 more information on execution-parameters, see How Containers Serve Requests. 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, Amazon 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 more information on execution-parameters, see How Containers Serve Requests. 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

      CreateTransformJobRequest.Builder modelClientConfig(ModelClientConfig modelClientConfig)

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

      Parameters:
      modelClientConfig - Configures 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 CreateTransformJobRequest.Builder modelClientConfig(Consumer<ModelClientConfig.Builder> modelClientConfig)

      Configures 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:

    • maxPayloadInMB

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

      The value of MaxPayloadInMB cannot be greater than 100 MB. If you specify the MaxConcurrentTransforms parameter, the value of (MaxConcurrentTransforms * MaxPayloadInMB) also cannot exceed 100 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, Amazon 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.

      The value of MaxPayloadInMB cannot be greater than 100 MB. If you specify the MaxConcurrentTransforms parameter, the value of (MaxConcurrentTransforms * MaxPayloadInMB) also cannot exceed 100 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, Amazon 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

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

      To use only one record when making an HTTP invocation request to a container, set BatchStrategy to SingleRecord and SplitType to Line.

      To fit as many records in a mini-batch as can fit within the MaxPayloadInMB limit, set BatchStrategy to MultiRecord and SplitType to Line.

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

      To use only one record when making an HTTP invocation request to a container, set BatchStrategy to SingleRecord and SplitType to Line.

      To fit as many records in a mini-batch as can fit within the MaxPayloadInMB limit, set BatchStrategy to MultiRecord and SplitType to Line.

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

    • batchStrategy

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

      To use only one record when making an HTTP invocation request to a container, set BatchStrategy to SingleRecord and SplitType to Line.

      To fit as many records in a mini-batch as can fit within the MaxPayloadInMB limit, set BatchStrategy to MultiRecord and SplitType to Line.

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

      To use only one record when making an HTTP invocation request to a container, set BatchStrategy to SingleRecord and SplitType to Line.

      To fit as many records in a mini-batch as can fit within the MaxPayloadInMB limit, set BatchStrategy to MultiRecord and SplitType to Line.

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

    • environment

      CreateTransformJobRequest.Builder environment(Map<String,String> environment)

      The environment variables to set in the Docker container. Don't include any sensitive data in your environment variables. We support up to 16 key and values entries in the map.

      Parameters:
      environment - The environment variables to set in the Docker container. Don't include any sensitive data in your environment variables. 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

      CreateTransformJobRequest.Builder transformInput(TransformInput transformInput)

      Describes the input source and the way the transform job consumes it.

      Parameters:
      transformInput - Describes the input source and the way the transform job consumes it.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • transformInput

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

      Describes the input source and the way the transform job consumes it.

      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:

    • transformOutput

      CreateTransformJobRequest.Builder transformOutput(TransformOutput transformOutput)

      Describes the results of the transform job.

      Parameters:
      transformOutput - Describes the results of the transform job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • transformOutput

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

      Describes the results of 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:

    • dataCaptureConfig

      CreateTransformJobRequest.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 CreateTransformJobRequest.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:

    • transformResources

      CreateTransformJobRequest.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 CreateTransformJobRequest.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:

    • dataProcessing

      CreateTransformJobRequest.Builder dataProcessing(DataProcessing dataProcessing)

      The data structure used to specify the data to be used for inference in a batch transform job and to associate the data that is relevant to the prediction results in the output. The input filter provided allows you to exclude input data that is not needed for inference in a batch transform job. The output filter provided allows you to include input data relevant to interpreting the predictions in the output from the job. For more information, see Associate Prediction Results with their Corresponding Input Records.

      Parameters:
      dataProcessing - The data structure used to specify the data to be used for inference in a batch transform job and to associate the data that is relevant to the prediction results in the output. The input filter provided allows you to exclude input data that is not needed for inference in a batch transform job. The output filter provided allows you to include input data relevant to interpreting the predictions in the output from the job. For more information, see Associate Prediction Results with their Corresponding Input Records.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • dataProcessing

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

      The data structure used to specify the data to be used for inference in a batch transform job and to associate the data that is relevant to the prediction results in the output. The input filter provided allows you to exclude input data that is not needed for inference in a batch transform job. The output filter provided allows you to include input data relevant to interpreting the predictions in the output from the job. For more information, see Associate Prediction Results with their Corresponding Input Records.

      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:

    • tags

      CreateTransformJobRequest.Builder tags(Collection<Tag> tags)

      (Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.

      Parameters:
      tags - (Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateTransformJobRequest.Builder tags(Tag... tags)

      (Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.

      Parameters:
      tags - (Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateTransformJobRequest.Builder tags(Consumer<Tag.Builder>... tags)

      (Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.

      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<Tag>).

      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:

    • experimentConfig

      CreateTransformJobRequest.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 CreateTransformJobRequest.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:

    • overrideConfiguration

      CreateTransformJobRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      CreateTransformJobRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.