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

Class CreateMlTransformRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.glue.model.GlueRequest
software.amazon.awssdk.services.glue.model.CreateMlTransformRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateMlTransformRequest.Builder,CreateMlTransformRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateMlTransformRequest extends GlueRequest implements ToCopyableBuilder<CreateMlTransformRequest.Builder,CreateMlTransformRequest>

  • Method Details

    • name

      public final String name()

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

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

    • description

      public final String description()

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

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

    • 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 the isEmpty() 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

      public final List<GlueTable> 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

      public final TransformParameters parameters()

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

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

    • role

      public final 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.

      Returns:
      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.

    • glueVersion

      public final 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.

      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

      public final 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.

      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.

      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.

    • workerType

      public final 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.

      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.

      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:

    • workerTypeAsString

      public final 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.

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

      See Also:

    • numberOfWorkers

      public final 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).

      Returns:
      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).

    • timeout

      public final 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).

      Returns:
      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).

    • maxRetries

      public final 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.

    • hasTags

      public final boolean hasTags()
      For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() 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.

    • tags

      public final 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.

      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 hasTags() method.

      Returns:
      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.

    • transformEncryption

      public final 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 CreateMlTransformRequest.Builder 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 interface ToCopyableBuilder<CreateMlTransformRequest.Builder,CreateMlTransformRequest>
      Specified by:
      toBuilder in class GlueRequest
      Returns:
      a builder for type T

    • builder

      public static CreateMlTransformRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CreateMlTransformRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final 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 final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. 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, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      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

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.