MLTransform (AWS Java SDK :: Services :: AWS Glue 2.15.32 API)

java.lang.Object
- software.amazon.awssdk.services.glue.model.MLTransform

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<MLTransform.Builder,MLTransform>

@Generated(value="software.amazon.awssdk:codegen")
public final class MLTransform
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<MLTransform.Builder,MLTransform>

A structure for a machine learning transform.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface MLTransform.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`MLTransform.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static MLTransform.Builder`	`builder()`
`Instant`	`createdOn()` A timestamp.
`String`	`description()` A user-defined, long-form description text for the machine learning transform.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`EvaluationMetrics`	`evaluationMetrics()` An `EvaluationMetrics` object.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`String`	`glueVersion()` This value determines which version of AWS Glue this machine learning transform is compatible with.
`int`	`hashCode()`
`boolean`	`hasInputRecordTables()` Returns true if the InputRecordTables property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasSchema()` Returns true if the Schema property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`List<GlueTable>`	`inputRecordTables()` A list of AWS Glue table definitions used by the transform.
`Integer`	`labelCount()` A count identifier for the labeling files generated by AWS Glue for this transform.
`Instant`	`lastModifiedOn()` A timestamp.
`Double`	`maxCapacity()` The number of AWS Glue data processing units (DPUs) that are allocated to task runs for this transform.
`Integer`	`maxRetries()` The maximum number of times to retry after an `MLTaskRun` of the machine learning transform fails.
`String`	`name()` A user-defined name for the machine learning transform.
`Integer`	`numberOfWorkers()` The number of workers of a defined `workerType` that are allocated when a task of the transform runs.
`TransformParameters`	`parameters()` A `TransformParameters` object.
`String`	`role()` The name or Amazon Resource Name (ARN) of the IAM role with the required permissions.
`List<SchemaColumn>`	`schema()` A map of key-value pairs representing the columns and data types that this transform can run against.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends MLTransform.Builder>`	`serializableBuilderClass()`
`TransformStatusType`	`status()` The current status of the machine learning transform.
`String`	`statusAsString()` The current status of the machine learning transform.
`Integer`	`timeout()` The timeout in minutes of the machine learning transform.
`MLTransform.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`TransformEncryption`	`transformEncryption()` The encryption-at-rest settings of the transform that apply to accessing user data.
`String`	`transformId()` The unique transform ID that is generated for the machine learning transform.
`WorkerType`	`workerType()` The type of predefined worker that is allocated when a task of this transform runs.
`String`	`workerTypeAsString()` The type of predefined worker that is allocated when a task of this transform runs.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - transformId
```
public 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.
    
    Returns:
    
    The unique transform ID that is generated for the machine learning transform. The ID is guaranteed to be unique and does not change.
  - name
```
public String name()
```
    A user-defined name for the machine learning transform. Names are not guaranteed unique and can be changed at any time.
    
    Returns:
    
    A user-defined name for the machine learning transform. Names are not guaranteed unique and can be changed at any time.
  - description
```
public 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.
    
    Returns:
    
    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.
  - status
```
public TransformStatusType status()
```
    The current status of the machine learning transform.
    
    If the service returns an enum value that is not available in the current SDK version, status will return TransformStatusType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    
    Returns:
    
    The current status of the machine learning transform.
    
    See Also:
    
    TransformStatusType
  - statusAsString
```
public String statusAsString()
```
    The current status of the machine learning transform.
    
    If the service returns an enum value that is not available in the current SDK version, status will return TransformStatusType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    
    Returns:
    
    The current status of the machine learning transform.
    
    See Also:
    
    TransformStatusType
  - createdOn
```
public Instant createdOn()
```
    A timestamp. The time and date that this machine learning transform was created.
    
    Returns:
    
    A timestamp. The time and date that this machine learning transform was created.
  - lastModifiedOn
```
public Instant lastModifiedOn()
```
    A timestamp. The last point in time when this machine learning transform was modified.
    
    Returns:
    
    A timestamp. The last point in time when this machine learning transform was modified.
  - hasInputRecordTables
```
public boolean hasInputRecordTables()
```
    Returns true if the InputRecordTables property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - inputRecordTables
```
public List<GlueTable> inputRecordTables()
```
    A list of AWS Glue table definitions used by the transform.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasInputRecordTables() to see if a value was sent in this field.
    
    Returns:
    
    A list of AWS Glue table definitions used by the transform.
  - parameters
```
public 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).
    
    Returns:
    
    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).
  - evaluationMetrics
```
public EvaluationMetrics evaluationMetrics()
```
    An EvaluationMetrics object. Evaluation metrics provide an estimate of the quality of your machine learning transform.
    
    Returns:
    
    An EvaluationMetrics object. Evaluation metrics provide an estimate of the quality of your machine learning transform.
  - labelCount
```
public Integer labelCount()
```
    A count identifier for the labeling files generated by AWS Glue for this transform. As you create a better transform, you can iteratively download, label, and upload the labeling file.
    
    Returns:
    
    A count identifier for the labeling files generated by AWS Glue for this transform. As you create a better transform, you can iteratively download, label, and upload the labeling file.
  - hasSchema
```
public boolean hasSchema()
```
    Returns true if the Schema property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - schema
```
public List<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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasSchema() to see if a value was sent in this field.
    
    Returns:
    
    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.
  - role
```
public String role()
```
    The name or Amazon Resource Name (ARN) of the IAM role with the required permissions. The required permissions include both AWS Glue service role permissions to AWS Glue resources, and Amazon S3 permissions required by the transform.
    - This role needs AWS Glue service role permissions to allow access to resources in AWS Glue. See Attach a Policy to IAM Users That Access AWS 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:
    The name or Amazon Resource Name (ARN) of the IAM role with the required permissions. The required permissions include both AWS Glue service role permissions to AWS Glue resources, and Amazon S3 permissions required by the transform.
    
    This role needs AWS Glue service role permissions to allow access to resources in AWS Glue. See Attach a Policy to IAM Users That Access AWS 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.
  - glueVersion
```
public String glueVersion()
```
    This value determines which version of AWS 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 AWS Glue Versions in the developer guide.
    
    Returns:
    
    This value determines which version of AWS 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 AWS Glue Versions in the developer guide.
  - maxCapacity
```
public Double maxCapacity()
```
    The number of AWS 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 AWS 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:
    The number of AWS 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 AWS 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.
  - workerType
```
public 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.
    If the service returns an enum value that is not available in the current SDK version, workerType will return WorkerType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from workerTypeAsString().
    Returns:
    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.
    See Also:
    
    WorkerType
  - workerTypeAsString
```
public String workerTypeAsString()
```
    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.
    If the service returns an enum value that is not available in the current SDK version, workerType will return WorkerType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from workerTypeAsString().
    Returns:
    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.
    See Also:
    
    WorkerType
  - numberOfWorkers
```
public 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).
    
    Returns:
    
    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).
  - timeout
```
public Integer timeout()
```
    The timeout in minutes of the machine learning transform.
    
    Returns:
    
    The timeout in minutes of the machine learning transform.
  - maxRetries
```
public Integer maxRetries()
```
    The maximum number of times to retry after an MLTaskRun of the machine learning transform fails.
    
    Returns:
    
    The maximum number of times to retry after an MLTaskRun of the machine learning transform fails.
  - transformEncryption
```
public 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.
    
    Returns:
    
    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.
  - toBuilder
```
public MLTransform.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<MLTransform.Builder,MLTransform>
  - builder
```
public static MLTransform.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends MLTransform.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class MLTransform

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

transformId

name

description

status

statusAsString

createdOn

lastModifiedOn

hasInputRecordTables

inputRecordTables

parameters

evaluationMetrics

labelCount

hasSchema

schema

role

glueVersion

maxCapacity

workerType

workerTypeAsString

numberOfWorkers

timeout

maxRetries

transformEncryption

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields