Package software.amazon.awssdk.services.glue.model

Interface CreateMlTransformRequest.Builder

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

  • Method Details

    • name

      CreateMlTransformRequest.Builder name(String name)

      The unique name that you give the transform when you create it.

      Parameters:
      name - The unique name that you give the transform when you create it.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • description

      CreateMlTransformRequest.Builder description(String description)

      A description of the machine learning transform that is being defined. The default is an empty string.

      Parameters:
      description - A description of the machine learning transform that is being defined. The default is an empty string.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • inputRecordTables

      CreateMlTransformRequest.Builder inputRecordTables(Collection<GlueTable> inputRecordTables)

      A list of Glue table definitions used by the transform.

      Parameters:
      inputRecordTables - A list of Glue table definitions used by the transform.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • inputRecordTables

      CreateMlTransformRequest.Builder inputRecordTables(GlueTable... inputRecordTables)

      A list of Glue table definitions used by the transform.

      Parameters:
      inputRecordTables - A list of Glue table definitions used by the transform.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • inputRecordTables

      CreateMlTransformRequest.Builder inputRecordTables(Consumer<GlueTable.Builder>... inputRecordTables)

      A list of Glue table definitions used by the transform.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to inputRecordTables(List<GlueTable>).

      Parameters:
      inputRecordTables - a consumer that will call methods on GlueTable.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • parameters

      CreateMlTransformRequest.Builder parameters(TransformParameters parameters)

      The algorithmic parameters that are specific to the transform type used. Conditionally dependent on the transform type.

      Parameters:
      parameters - The algorithmic parameters that are specific to the transform type used. Conditionally dependent on the transform type.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • parameters

      default CreateMlTransformRequest.Builder parameters(Consumer<TransformParameters.Builder> parameters)

      The algorithmic parameters that are specific to the transform type used. Conditionally dependent on the transform type.

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

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

      Parameters:
      parameters - a consumer that will call methods on TransformParameters.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • role

      CreateMlTransformRequest.Builder role(String role)

      The name or Amazon Resource Name (ARN) of the IAM role with the required permissions. The required permissions include both Glue service role permissions to Glue resources, and Amazon S3 permissions required by the transform.

      • This role needs Glue service role permissions to allow access to resources in Glue. See Attach a Policy to IAM Users That Access Glue.

      • This role needs permission to your Amazon Simple Storage Service (Amazon S3) sources, targets, temporary directory, scripts, and any libraries used by the task run for this transform.

      Parameters:
      role - The name or Amazon Resource Name (ARN) of the IAM role with the required permissions. The required permissions include both Glue service role permissions to Glue resources, and Amazon S3 permissions required by the transform.

      • This role needs Glue service role permissions to allow access to resources in Glue. See Attach a Policy to IAM Users That Access Glue.

      • This role needs permission to your Amazon Simple Storage Service (Amazon S3) sources, targets, temporary directory, scripts, and any libraries used by the task run for this transform.

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

    • glueVersion

      CreateMlTransformRequest.Builder glueVersion(String glueVersion)

      This value determines which version of Glue this machine learning transform is compatible with. Glue 1.0 is recommended for most customers. If the value is not set, the Glue compatibility defaults to Glue 0.9. For more information, see Glue Versions in the developer guide.

      Parameters:
      glueVersion - This value determines which version of Glue this machine learning transform is compatible with. Glue 1.0 is recommended for most customers. If the value is not set, the Glue compatibility defaults to Glue 0.9. For more information, see Glue Versions in the developer guide.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • maxCapacity

      CreateMlTransformRequest.Builder maxCapacity(Double maxCapacity)

      The number of Glue data processing units (DPUs) that are allocated to task runs for this transform. You can allocate from 2 to 100 DPUs; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the Glue pricing page.

      MaxCapacity is a mutually exclusive option with NumberOfWorkers and WorkerType.

      • If either NumberOfWorkers or WorkerType is set, then MaxCapacity cannot be set.

      • If MaxCapacity is set then neither NumberOfWorkers or WorkerType can be set.

      • If WorkerType is set, then NumberOfWorkers is required (and vice versa).

      • MaxCapacity and NumberOfWorkers must both be at least 1.

      When the WorkerType field is set to a value other than Standard, the MaxCapacity field is set automatically and becomes read-only.

      When the WorkerType field is set to a value other than Standard, the MaxCapacity field is set automatically and becomes read-only.

      Parameters:
      maxCapacity - The number of Glue data processing units (DPUs) that are allocated to task runs for this transform. You can allocate from 2 to 100 DPUs; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the Glue pricing page.

      MaxCapacity is a mutually exclusive option with NumberOfWorkers and WorkerType.

      • If either NumberOfWorkers or WorkerType is set, then MaxCapacity cannot be set.

      • If MaxCapacity is set then neither NumberOfWorkers or WorkerType can be set.

      • If WorkerType is set, then NumberOfWorkers is required (and vice versa).

      • MaxCapacity and NumberOfWorkers must both be at least 1.

      When the WorkerType field is set to a value other than Standard, the MaxCapacity field is set automatically and becomes read-only.

      When the WorkerType field is set to a value other than Standard, the MaxCapacity field is set automatically and becomes read-only.

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

    • workerType

      CreateMlTransformRequest.Builder workerType(String workerType)

      The type of predefined worker that is allocated when this task runs. Accepts a value of Standard, G.1X, or G.2X.

      • For the Standard worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker.

      • For the G.1X worker type, each worker provides 4 vCPU, 16 GB of memory and a 64GB disk, and 1 executor per worker.

      • For the G.2X worker type, each worker provides 8 vCPU, 32 GB of memory and a 128GB disk, and 1 executor per worker.

      MaxCapacity is a mutually exclusive option with NumberOfWorkers and WorkerType.

      • If either NumberOfWorkers or WorkerType is set, then MaxCapacity cannot be set.

      • If MaxCapacity is set then neither NumberOfWorkers or WorkerType can be set.

      • If WorkerType is set, then NumberOfWorkers is required (and vice versa).

      • MaxCapacity and NumberOfWorkers must both be at least 1.

      Parameters:
      workerType - The type of predefined worker that is allocated when this task runs. Accepts a value of Standard, G.1X, or G.2X.

      • For the Standard worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker.

      • For the G.1X worker type, each worker provides 4 vCPU, 16 GB of memory and a 64GB disk, and 1 executor per worker.

      • For the G.2X worker type, each worker provides 8 vCPU, 32 GB of memory and a 128GB disk, and 1 executor per worker.

      MaxCapacity is a mutually exclusive option with NumberOfWorkers and WorkerType.

      • If either NumberOfWorkers or WorkerType is set, then MaxCapacity cannot be set.

      • If MaxCapacity is set then neither NumberOfWorkers or WorkerType can be set.

      • If WorkerType is set, then NumberOfWorkers is required (and vice versa).

      • MaxCapacity and NumberOfWorkers must both be at least 1.

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

    • workerType

      CreateMlTransformRequest.Builder workerType(WorkerType workerType)

      The type of predefined worker that is allocated when this task runs. Accepts a value of Standard, G.1X, or G.2X.

      • For the Standard worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker.

      • For the G.1X worker type, each worker provides 4 vCPU, 16 GB of memory and a 64GB disk, and 1 executor per worker.

      • For the G.2X worker type, each worker provides 8 vCPU, 32 GB of memory and a 128GB disk, and 1 executor per worker.

      MaxCapacity is a mutually exclusive option with NumberOfWorkers and WorkerType.

      • If either NumberOfWorkers or WorkerType is set, then MaxCapacity cannot be set.

      • If MaxCapacity is set then neither NumberOfWorkers or WorkerType can be set.

      • If WorkerType is set, then NumberOfWorkers is required (and vice versa).

      • MaxCapacity and NumberOfWorkers must both be at least 1.

      Parameters:
      workerType - The type of predefined worker that is allocated when this task runs. Accepts a value of Standard, G.1X, or G.2X.

      • For the Standard worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker.

      • For the G.1X worker type, each worker provides 4 vCPU, 16 GB of memory and a 64GB disk, and 1 executor per worker.

      • For the G.2X worker type, each worker provides 8 vCPU, 32 GB of memory and a 128GB disk, and 1 executor per worker.

      MaxCapacity is a mutually exclusive option with NumberOfWorkers and WorkerType.

      • If either NumberOfWorkers or WorkerType is set, then MaxCapacity cannot be set.

      • If MaxCapacity is set then neither NumberOfWorkers or WorkerType can be set.

      • If WorkerType is set, then NumberOfWorkers is required (and vice versa).

      • MaxCapacity and NumberOfWorkers must both be at least 1.

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

    • numberOfWorkers

      CreateMlTransformRequest.Builder numberOfWorkers(Integer numberOfWorkers)

      The number of workers of a defined workerType that are allocated when this task runs.

      If WorkerType is set, then NumberOfWorkers is required (and vice versa).

      Parameters:
      numberOfWorkers - The number of workers of a defined workerType that are allocated when this task runs.

      If WorkerType is set, then NumberOfWorkers is required (and vice versa).

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

    • timeout

      CreateMlTransformRequest.Builder timeout(Integer timeout)

      The timeout of the task run for this transform in minutes. This is the maximum time that a task run for this transform can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours).

      Parameters:
      timeout - The timeout of the task run for this transform in minutes. This is the maximum time that a task run for this transform can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • maxRetries

      CreateMlTransformRequest.Builder maxRetries(Integer maxRetries)

      The maximum number of times to retry a task for this transform after a task run fails.

      Parameters:
      maxRetries - The maximum number of times to retry a task for this transform after a task run fails.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateMlTransformRequest.Builder tags(Map<String,String> tags)

      The tags to use with this machine learning transform. You may use tags to limit access to the machine learning transform. For more information about tags in Glue, see Amazon Web Services Tags in Glue in the developer guide.

      Parameters:
      tags - The tags to use with this machine learning transform. You may use tags to limit access to the machine learning transform. For more information about tags in Glue, see Amazon Web Services Tags in Glue in the developer guide.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • transformEncryption

      CreateMlTransformRequest.Builder transformEncryption(TransformEncryption transformEncryption)

      The encryption-at-rest settings of the transform that apply to accessing user data. Machine learning transforms can access user data encrypted in Amazon S3 using KMS.

      Parameters:
      transformEncryption - The encryption-at-rest settings of the transform that apply to accessing user data. Machine learning transforms can access user data encrypted in Amazon S3 using KMS.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • transformEncryption

      default CreateMlTransformRequest.Builder transformEncryption(Consumer<TransformEncryption.Builder> transformEncryption)

      The encryption-at-rest settings of the transform that apply to accessing user data. Machine learning transforms can access user data encrypted in Amazon S3 using KMS.

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

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

      Parameters:
      transformEncryption - a consumer that will call methods on TransformEncryption.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

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

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