GetMlTransformResponse (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.core.SdkResponse
- - software.amazon.awssdk.awscore.AwsResponse
  - - software.amazon.awssdk.services.glue.model.GlueResponse
    - - software.amazon.awssdk.services.glue.model.GetMlTransformResponse

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<GetMlTransformResponse.Builder,GetMlTransformResponse>

@Generated(value="software.amazon.awssdk:codegen")
public final class GetMlTransformResponse
extends GlueResponse
implements ToCopyableBuilder<GetMlTransformResponse.Builder,GetMlTransformResponse>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface GetMlTransformResponse.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static GetMlTransformResponse.Builder`	`builder()`
`Instant`	`createdOn()` The date and time when the transform was created.
`String`	`description()` A description of the transform.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`EvaluationMetrics`	`evaluationMetrics()` The latest evaluation metrics.
`<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()` The number of labels available for this transform.
`Instant`	`lastModifiedOn()` The date and time when the transform was last modified.
`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 a task for this transform after a task run fails.
`String`	`name()` The unique name given to the transform when it was created.
`Integer`	`numberOfWorkers()` The number of workers of a defined `workerType` that are allocated when this task runs.
`TransformParameters`	`parameters()` The configuration parameters that are specific to the algorithm used.
`String`	`role()` The name or Amazon Resource Name (ARN) of the IAM role with the required permissions.
`List<SchemaColumn>`	`schema()` The `Map<Column, Type>` object that represents the schema that this transform accepts.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends GetMlTransformResponse.Builder>`	`serializableBuilderClass()`
`TransformStatusType`	`status()` The last known status of the transform (to indicate whether it can be used or not).
`String`	`statusAsString()` The last known status of the transform (to indicate whether it can be used or not).
`Integer`	`timeout()` The timeout for a task run for this transform in minutes.
`GetMlTransformResponse.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 identifier of the transform, generated at the time that the transform was created.
`WorkerType`	`workerType()` The type of predefined worker that is allocated when this task runs.
`String`	`workerTypeAsString()` The type of predefined worker that is allocated when this task runs.

Methods inherited from class software.amazon.awssdk.services.glue.model.GlueResponse
responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse

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 identifier of the transform, generated at the time that the transform was created.
    
    Returns:
    
    The unique identifier of the transform, generated at the time that the transform was created.
  - name
```
public String name()
```
    The unique name given to the transform when it was created.
    
    Returns:
    
    The unique name given to the transform when it was created.
  - description
```
public String description()
```
    A description of the transform.
    
    Returns:
    
    A description of the transform.
  - status
```
public TransformStatusType status()
```
    The last known status of the transform (to indicate whether it can be used or not). One of "NOT_READY", "READY", or "DELETING".
    
    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 last known status of the transform (to indicate whether it can be used or not). One of "NOT_READY", "READY", or "DELETING".
    
    See Also:
    
    TransformStatusType
  - statusAsString
```
public String statusAsString()
```
    The last known status of the transform (to indicate whether it can be used or not). One of "NOT_READY", "READY", or "DELETING".
    
    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 last known status of the transform (to indicate whether it can be used or not). One of "NOT_READY", "READY", or "DELETING".
    
    See Also:
    
    TransformStatusType
  - createdOn
```
public Instant createdOn()
```
    The date and time when the transform was created.
    
    Returns:
    
    The date and time when the transform was created.
  - lastModifiedOn
```
public Instant lastModifiedOn()
```
    The date and time when the transform was last modified.
    
    Returns:
    
    The date and time when the transform was last 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()
```
    The configuration parameters that are specific to the algorithm used.
    
    Returns:
    
    The configuration parameters that are specific to the algorithm used.
  - evaluationMetrics
```
public EvaluationMetrics evaluationMetrics()
```
    The latest evaluation metrics.
    
    Returns:
    
    The latest evaluation metrics.
  - labelCount
```
public Integer labelCount()
```
    The number of labels available for this transform.
    
    Returns:
    
    The number of labels available for this transform.
  - 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()
```
    The Map<Column, Type> object that represents the schema that this transform accepts. 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:
    
    The Map<Column, Type> object that represents the schema that this transform accepts. 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.
    
    Returns:
    
    The name or Amazon Resource Name (ARN) of the IAM role with the required permissions.
  - 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.
    
    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.
    
    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 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.
    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 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.
    See Also:
    
    WorkerType
  - workerTypeAsString
```
public String workerTypeAsString()
```
    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.
    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 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.
    See Also:
    
    WorkerType
  - numberOfWorkers
```
public Integer numberOfWorkers()
```
    The number of workers of a defined workerType that are allocated when this task runs.
    
    Returns:
    
    The number of workers of a defined workerType that are allocated when this task runs.
  - timeout
```
public Integer timeout()
```
    The timeout for a 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:
    
    The timeout for a 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).
  - maxRetries
```
public Integer maxRetries()
```
    The maximum number of times to retry a task for this transform after a task run fails.
    
    Returns:
    
    The maximum number of times to retry a task for this transform after a task run 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 GetMlTransformResponse.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<GetMlTransformResponse.Builder,GetMlTransformResponse>
    
    Overrides:
    
    toBuilder in class AwsResponse
  - builder
```
public static GetMlTransformResponse.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends GetMlTransformResponse.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class AwsResponse
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsResponse
  - 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)
```
    Overrides:
    
    getValueForField in class SdkResponse
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class GetMlTransformResponse

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.services.glue.model.GlueResponse

Methods inherited from class software.amazon.awssdk.core.SdkResponse

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