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

Class GetMlTransformResponse

    • Method Detail

      • transformId

        public final 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 final 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 final String description()

        A description of the transform.

        Returns:
        A description of the transform.

      • status

        public final 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 final 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 final Instant createdOn()

        The date and time when the transform was created.

        Returns:
        The date and time when the transform was created.

      • lastModifiedOn

        public final 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 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 configuration parameters that are specific to the algorithm used.

        Returns:
        The configuration parameters that are specific to the algorithm used.

      • evaluationMetrics

        public final EvaluationMetrics evaluationMetrics()

        The latest evaluation metrics.

        Returns:
        The latest evaluation metrics.

      • labelCount

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

      • schema

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

        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

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

        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.

        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.

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

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

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

      • 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