CreateMLTransformRequest (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.glue.model.CreateMLTransformRequest

All Implemented Interfaces:: HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateMLTransformRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:: AWS API Documentation, Serialized Form

Field Summary
- Fields inherited from class com.amazonaws.AmazonWebServiceRequest
  NOOP

Constructor Summary

Constructors
Constructor and Description

CreateMLTransformRequest()

Constructors
Constructor and Description
`CreateMLTransformRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CreateMLTransformRequest`	`clone()` Creates a shallow clone of this object for all fields except the handler context.
`boolean`	`equals(Object obj)`
`String`	`getDescription()` A description of the machine learning transform that is being defined.
`List<GlueTable>`	`getInputRecordTables()` A list of AWS Glue table definitions used by the transform.
`Double`	`getMaxCapacity()` The number of AWS Glue data processing units (DPUs) that are allocated to task runs for this transform.
`Integer`	`getMaxRetries()` The maximum number of times to retry a task for this transform after a task run fails.
`String`	`getName()` The unique name that you give the transform when you create it.
`Integer`	`getNumberOfWorkers()` The number of workers of a defined `workerType` that are allocated when this task runs.
`TransformParameters`	`getParameters()` The algorithmic parameters that are specific to the transform type used.
`String`	`getRole()` The name or Amazon Resource Name (ARN) of the IAM role with the required permissions.
`Integer`	`getTimeout()` The timeout of the task run for this transform in minutes.
`String`	`getWorkerType()` The type of predefined worker that is allocated when this task runs.
`int`	`hashCode()`
`void`	`setDescription(String description)` A description of the machine learning transform that is being defined.
`void`	`setInputRecordTables(Collection<GlueTable> inputRecordTables)` A list of AWS Glue table definitions used by the transform.
`void`	`setMaxCapacity(Double maxCapacity)` The number of AWS Glue data processing units (DPUs) that are allocated to task runs for this transform.
`void`	`setMaxRetries(Integer maxRetries)` The maximum number of times to retry a task for this transform after a task run fails.
`void`	`setName(String name)` The unique name that you give the transform when you create it.
`void`	`setNumberOfWorkers(Integer numberOfWorkers)` The number of workers of a defined `workerType` that are allocated when this task runs.
`void`	`setParameters(TransformParameters parameters)` The algorithmic parameters that are specific to the transform type used.
`void`	`setRole(String role)` The name or Amazon Resource Name (ARN) of the IAM role with the required permissions.
`void`	`setTimeout(Integer timeout)` The timeout of the task run for this transform in minutes.
`void`	`setWorkerType(String workerType)` The type of predefined worker that is allocated when this task runs.
`String`	`toString()` Returns a string representation of this object.
`CreateMLTransformRequest`	`withDescription(String description)` A description of the machine learning transform that is being defined.
`CreateMLTransformRequest`	`withInputRecordTables(Collection<GlueTable> inputRecordTables)` A list of AWS Glue table definitions used by the transform.
`CreateMLTransformRequest`	`withInputRecordTables(GlueTable... inputRecordTables)` A list of AWS Glue table definitions used by the transform.
`CreateMLTransformRequest`	`withMaxCapacity(Double maxCapacity)` The number of AWS Glue data processing units (DPUs) that are allocated to task runs for this transform.
`CreateMLTransformRequest`	`withMaxRetries(Integer maxRetries)` The maximum number of times to retry a task for this transform after a task run fails.
`CreateMLTransformRequest`	`withName(String name)` The unique name that you give the transform when you create it.
`CreateMLTransformRequest`	`withNumberOfWorkers(Integer numberOfWorkers)` The number of workers of a defined `workerType` that are allocated when this task runs.
`CreateMLTransformRequest`	`withParameters(TransformParameters parameters)` The algorithmic parameters that are specific to the transform type used.
`CreateMLTransformRequest`	`withRole(String role)` The name or Amazon Resource Name (ARN) of the IAM role with the required permissions.
`CreateMLTransformRequest`	`withTimeout(Integer timeout)` The timeout of the task run for this transform in minutes.
`CreateMLTransformRequest`	`withWorkerType(String workerType)` The type of predefined worker that is allocated when this task runs.
`CreateMLTransformRequest`	`withWorkerType(WorkerType workerType)` The type of predefined worker that is allocated when this task runs.

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

- Constructor Detail
  - CreateMLTransformRequest
```
public CreateMLTransformRequest()
```
- Method Detail
  - setName
```
public void setName(String name)
```
    The unique name that you give the transform when you create it.
    
    Parameters:
    
    name - The unique name that you give the transform when you create it.
  - getName
```
public String getName()
```
    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.
  - withName
```
public CreateMLTransformRequest withName(String name)
```
    The unique name that you give the transform when you create it.
    
    Parameters:
    
    name - The unique name that you give the transform when you create it.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDescription
```
public void setDescription(String description)
```
    A description of the machine learning transform that is being defined. The default is an empty string.
    
    Parameters:
    
    description - A description of the machine learning transform that is being defined. The default is an empty string.
  - getDescription
```
public String getDescription()
```
    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.
  - withDescription
```
public CreateMLTransformRequest withDescription(String description)
```
    A description of the machine learning transform that is being defined. The default is an empty string.
    
    Parameters:
    
    description - A description of the machine learning transform that is being defined. The default is an empty string.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getInputRecordTables
```
public List<GlueTable> getInputRecordTables()
```
    A list of AWS Glue table definitions used by the transform.
    
    Returns:
    
    A list of AWS Glue table definitions used by the transform.
  - setInputRecordTables
```
public void setInputRecordTables(Collection<GlueTable> inputRecordTables)
```
    A list of AWS Glue table definitions used by the transform.
    
    Parameters:
    
    inputRecordTables - A list of AWS Glue table definitions used by the transform.
  - withInputRecordTables
```
public CreateMLTransformRequest withInputRecordTables(GlueTable... inputRecordTables)
```
    A list of AWS Glue table definitions used by the transform.
    
    NOTE: This method appends the values to the existing list (if any). Use setInputRecordTables(java.util.Collection) or withInputRecordTables(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    inputRecordTables - A list of AWS Glue table definitions used by the transform.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withInputRecordTables
```
public CreateMLTransformRequest withInputRecordTables(Collection<GlueTable> inputRecordTables)
```
    A list of AWS Glue table definitions used by the transform.
    
    Parameters:
    
    inputRecordTables - A list of AWS Glue table definitions used by the transform.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setParameters
```
public void setParameters(TransformParameters parameters)
```
    The algorithmic parameters that are specific to the transform type used. Conditionally dependent on the transform type.
    
    Parameters:
    
    parameters - The algorithmic parameters that are specific to the transform type used. Conditionally dependent on the transform type.
  - getParameters
```
public TransformParameters getParameters()
```
    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.
  - withParameters
```
public CreateMLTransformRequest withParameters(TransformParameters parameters)
```
    The algorithmic parameters that are specific to the transform type used. Conditionally dependent on the transform type.
    
    Parameters:
    
    parameters - The algorithmic parameters that are specific to the transform type used. Conditionally dependent on the transform type.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRole
```
public void setRole(String role)
```
    The name or Amazon Resource Name (ARN) of the IAM role with the required permissions. Ensure that this role has permission to your Amazon Simple Storage Service (Amazon S3) sources, targets, temporary directory, scripts, and any libraries that are used by the task run for this transform.
    
    Parameters:
    
    role - The name or Amazon Resource Name (ARN) of the IAM role with the required permissions. Ensure that this role has permission to your Amazon Simple Storage Service (Amazon S3) sources, targets, temporary directory, scripts, and any libraries that are used by the task run for this transform.
  - getRole
```
public String getRole()
```
    The name or Amazon Resource Name (ARN) of the IAM role with the required permissions. Ensure that this role has permission to your Amazon Simple Storage Service (Amazon S3) sources, targets, temporary directory, scripts, and any libraries that are used by the task run for this transform.
    
    Returns:
    
    The name or Amazon Resource Name (ARN) of the IAM role with the required permissions. Ensure that this role has permission to your Amazon Simple Storage Service (Amazon S3) sources, targets, temporary directory, scripts, and any libraries that are used by the task run for this transform.
  - withRole
```
public CreateMLTransformRequest withRole(String role)
```
    The name or Amazon Resource Name (ARN) of the IAM role with the required permissions. Ensure that this role has permission to your Amazon Simple Storage Service (Amazon S3) sources, targets, temporary directory, scripts, and any libraries that are used by the task run for this transform.
    
    Parameters:
    
    role - The name or Amazon Resource Name (ARN) of the IAM role with the required permissions. Ensure that this role has permission to your Amazon Simple Storage Service (Amazon S3) sources, targets, temporary directory, scripts, and any libraries that are used by the task run for this transform.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMaxCapacity
```
public void setMaxCapacity(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.
    
    Parameters:
    
    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.
  - getMaxCapacity
```
public Double getMaxCapacity()
```
    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.
  - withMaxCapacity
```
public CreateMLTransformRequest withMaxCapacity(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setWorkerType
```
public void setWorkerType(String 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.
    Parameters:
    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.
    See Also:
    
    WorkerType
  - getWorkerType
```
public String getWorkerType()
```
    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.
    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
  - withWorkerType
```
public CreateMLTransformRequest withWorkerType(String 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.
    Parameters:
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    WorkerType
  - withWorkerType
```
public CreateMLTransformRequest withWorkerType(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.
    Parameters:
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    WorkerType
  - setNumberOfWorkers
```
public void setNumberOfWorkers(Integer numberOfWorkers)
```
    The number of workers of a defined workerType that are allocated when this task runs.
    
    Parameters:
    
    numberOfWorkers - The number of workers of a defined workerType that are allocated when this task runs.
  - getNumberOfWorkers
```
public Integer getNumberOfWorkers()
```
    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.
  - withNumberOfWorkers
```
public CreateMLTransformRequest withNumberOfWorkers(Integer numberOfWorkers)
```
    The number of workers of a defined workerType that are allocated when this task runs.
    
    Parameters:
    
    numberOfWorkers - The number of workers of a defined workerType that are allocated when this task runs.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTimeout
```
public void setTimeout(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).
    
    Parameters:
    
    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).
  - getTimeout
```
public Integer getTimeout()
```
    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).
  - withTimeout
```
public CreateMLTransformRequest withTimeout(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).
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMaxRetries
```
public void setMaxRetries(Integer maxRetries)
```
    The maximum number of times to retry a task for this transform after a task run fails.
    
    Parameters:
    
    maxRetries - The maximum number of times to retry a task for this transform after a task run fails.
  - getMaxRetries
```
public Integer getMaxRetries()
```
    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.
  - withMaxRetries
```
public CreateMLTransformRequest withMaxRetries(Integer maxRetries)
```
    The maximum number of times to retry a task for this transform after a task run fails.
    
    Parameters:
    
    maxRetries - The maximum number of times to retry a task for this transform after a task run fails.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public CreateMLTransformRequest clone()
```
    Description copied from class: AmazonWebServiceRequest
    
    Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.
    
    Overrides:
    
    clone in class AmazonWebServiceRequest
    
    See Also:
    
    Object.clone()

Did this page help you?

Class CreateMLTransformRequest

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

CreateMLTransformRequest

Method Detail

setName

getName

withName

setDescription

getDescription

withDescription

getInputRecordTables

setInputRecordTables

withInputRecordTables

withInputRecordTables

setParameters

getParameters

withParameters

setRole

getRole

withRole

setMaxCapacity

getMaxCapacity

withMaxCapacity

setWorkerType

getWorkerType

withWorkerType

withWorkerType

setNumberOfWorkers

getNumberOfWorkers

withNumberOfWorkers

setTimeout

getTimeout

withTimeout

setMaxRetries

getMaxRetries

withMaxRetries

toString

equals

hashCode

clone