Class GetMlTransformResponse
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<GetMlTransformResponse.Builder,
GetMlTransformResponse>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final Instant
The date and time when the transform was created.final String
A description of the transform.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final EvaluationMetrics
The latest evaluation metrics.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkResponse
.final String
This value determines which version of Glue this machine learning transform is compatible with.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the InputRecordTables property.final boolean
For responses, this returns true if the service returned a value for the Schema property.A list of Glue table definitions used by the transform.final Integer
The number of labels available for this transform.final Instant
The date and time when the transform was last modified.final Double
The number of Glue data processing units (DPUs) that are allocated to task runs for this transform.final Integer
The maximum number of times to retry a task for this transform after a task run fails.final String
name()
The unique name given to the transform when it was created.final Integer
The number of workers of a definedworkerType
that are allocated when this task runs.final TransformParameters
The configuration parameters that are specific to the algorithm used.final String
role()
The name or Amazon Resource Name (ARN) of the IAM role with the required permissions.final List
<SchemaColumn> schema()
TheMap<Column, Type>
object that represents the schema that this transform accepts.static Class
<? extends GetMlTransformResponse.Builder> final TransformStatusType
status()
The last known status of the transform (to indicate whether it can be used or not).final String
The last known status of the transform (to indicate whether it can be used or not).final Integer
timeout()
The timeout for a task run for this transform in minutes.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final TransformEncryption
The encryption-at-rest settings of the transform that apply to accessing user data.final String
The unique identifier of the transform, generated at the time that the transform was created.final WorkerType
The type of predefined worker that is allocated when this task runs.final String
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 interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
The unique name given to the transform when it was created.
- Returns:
- The unique name given to the transform when it was created.
-
description
A description of the transform.
- Returns:
- A description of the transform.
-
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 returnTransformStatusType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- 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:
-
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 returnTransformStatusType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- 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:
-
createdOn
The date and time when the transform was created.
- Returns:
- The date and time when the transform was created.
-
lastModifiedOn
The date and time when the transform was last modified.
- Returns:
- The date and time when the transform was last modified.
-
hasInputRecordTables
public final boolean hasInputRecordTables()For responses, this returns true if the service returned a value for the InputRecordTables property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
inputRecordTables
A list of Glue table definitions used by the transform.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasInputRecordTables()
method.- Returns:
- A list of Glue table definitions used by the transform.
-
parameters
The configuration parameters that are specific to the algorithm used.
- Returns:
- The configuration parameters that are specific to the algorithm used.
-
evaluationMetrics
The latest evaluation metrics.
- Returns:
- The latest evaluation metrics.
-
labelCount
The number of labels available for this transform.
- Returns:
- The number of labels available for this transform.
-
hasSchema
public final boolean hasSchema()For responses, this returns true if the service returned a value for the Schema property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
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.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasSchema()
method.- Returns:
- The
Map<Column, Type>
object that represents the schema that this transform accepts. Has an upper bound of 100 columns.
-
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
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:
- 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.
-
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.
When the
WorkerType
field is set to a value other thanStandard
, theMaxCapacity
field is set automatically and becomes read-only.- Returns:
- 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.
When the
WorkerType
field is set to a value other thanStandard
, theMaxCapacity
field is set automatically and becomes read-only.
-
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 returnWorkerType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromworkerTypeAsString()
.- 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:
-
-
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 returnWorkerType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromworkerTypeAsString()
.- 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:
-
-
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
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
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
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
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<GetMlTransformResponse.Builder,
GetMlTransformResponse> - Specified by:
toBuilder
in classAwsResponse
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsResponse
-
equals
- Overrides:
equals
in classAwsResponse
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkResponse
Used to retrieve the value of a field from any class that extendsSdkResponse
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkResponse.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkResponse
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-