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

Interface MLTransform.Builder

    • Method Detail

      • transformId

        MLTransform.Builder transformId​(String transformId)

        The unique transform ID that is generated for the machine learning transform. The ID is guaranteed to be unique and does not change.

        Parameters:
        transformId - The unique transform ID that is generated for the machine learning transform. The ID is guaranteed to be unique and does not change.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • name

        MLTransform.Builder name​(String name)

        A user-defined name for the machine learning transform. Names are not guaranteed unique and can be changed at any time.

        Parameters:
        name - A user-defined name for the machine learning transform. Names are not guaranteed unique and can be changed at any time.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • description

        MLTransform.Builder description​(String description)

        A user-defined, long-form description text for the machine learning transform. Descriptions are not guaranteed to be unique and can be changed at any time.

        Parameters:
        description - A user-defined, long-form description text for the machine learning transform. Descriptions are not guaranteed to be unique and can be changed at any time.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • status

        MLTransform.Builder status​(String status)

        The current status of the machine learning transform.

        Parameters:
        status - The current status of the machine learning transform.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        TransformStatusType, TransformStatusType

      • createdOn

        MLTransform.Builder createdOn​(Instant createdOn)

        A timestamp. The time and date that this machine learning transform was created.

        Parameters:
        createdOn - A timestamp. The time and date that this machine learning transform was created.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • lastModifiedOn

        MLTransform.Builder lastModifiedOn​(Instant lastModifiedOn)

        A timestamp. The last point in time when this machine learning transform was modified.

        Parameters:
        lastModifiedOn - A timestamp. The last point in time when this machine learning transform was modified.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • inputRecordTables

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

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

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

        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:
        #inputRecordTables(java.util.Collection)

      • parameters

        MLTransform.Builder parameters​(TransformParameters parameters)

        A TransformParameters object. You can use parameters to tune (customize) the behavior of the machine learning transform by specifying what data it learns from and your preference on various tradeoffs (such as precious vs. recall, or accuracy vs. cost).

        Parameters:
        parameters - A TransformParameters object. You can use parameters to tune (customize) the behavior of the machine learning transform by specifying what data it learns from and your preference on various tradeoffs (such as precious vs. recall, or accuracy vs. cost).
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • evaluationMetrics

        MLTransform.Builder evaluationMetrics​(EvaluationMetrics evaluationMetrics)

        An EvaluationMetrics object. Evaluation metrics provide an estimate of the quality of your machine learning transform.

        Parameters:
        evaluationMetrics - An EvaluationMetrics object. Evaluation metrics provide an estimate of the quality of your machine learning transform.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • labelCount

        MLTransform.Builder labelCount​(Integer labelCount)

        A count identifier for the labeling files generated by Glue for this transform. As you create a better transform, you can iteratively download, label, and upload the labeling file.

        Parameters:
        labelCount - A count identifier for the labeling files generated by Glue for this transform. As you create a better transform, you can iteratively download, label, and upload the labeling file.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • schema

        MLTransform.Builder schema​(Collection<SchemaColumn> schema)

        A map of key-value pairs representing the columns and data types that this transform can run against. Has an upper bound of 100 columns.

        Parameters:
        schema - A map of key-value pairs representing the columns and data types that this transform can run against. Has an upper bound of 100 columns.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • schema

        MLTransform.Builder schema​(SchemaColumn... schema)

        A map of key-value pairs representing the columns and data types that this transform can run against. Has an upper bound of 100 columns.

        Parameters:
        schema - A map of key-value pairs representing the columns and data types that this transform can run against. Has an upper bound of 100 columns.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • schema

        MLTransform.Builder schema​(Consumer<SchemaColumn.Builder>... schema)

        A map of key-value pairs representing the columns and data types that this transform can run against. Has an upper bound of 100 columns.

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

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

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

      • role

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

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

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

        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.

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

      • workerType

        MLTransform.Builder workerType​(String workerType)

        The type of predefined worker that is allocated when a task of this transform 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 a task of this transform 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, WorkerType

      • workerType

        MLTransform.Builder workerType​(WorkerType workerType)

        The type of predefined worker that is allocated when a task of this transform 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 a task of this transform 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, WorkerType

      • numberOfWorkers

        MLTransform.Builder numberOfWorkers​(Integer numberOfWorkers)

        The number of workers of a defined workerType that are allocated when a task of the transform 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 a task of the transform 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

        MLTransform.Builder timeout​(Integer timeout)

        The timeout in minutes of the machine learning transform.

        Parameters:
        timeout - The timeout in minutes of the machine learning transform.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • maxRetries

        MLTransform.Builder maxRetries​(Integer maxRetries)

        The maximum number of times to retry after an MLTaskRun of the machine learning transform fails.

        Parameters:
        maxRetries - The maximum number of times to retry after an MLTaskRun of the machine learning transform fails.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • transformEncryption

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