com.amazonaws.services.gluedatabrew.model

Class CreateRecipeJobRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.gluedatabrew.model.CreateRecipeJobRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateRecipeJobRequest
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
CreateRecipeJobRequest()

Method Summary

Modifier and Type	Method and Description
CreateRecipeJobRequest	addTagsEntry(String key, String value) Add a single Tags entry
CreateRecipeJobRequest	clearTagsEntries() Removes all the entries added into Tags.
CreateRecipeJobRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
List<DatabaseOutput>	getDatabaseOutputs() Represents a list of JDBC database output objects which defines the output destination for a DataBrew recipe job to write to.
List<DataCatalogOutput>	getDataCatalogOutputs() One or more artifacts that represent the Glue Data Catalog output from running the job.
String	getDatasetName() The name of the dataset that this job processes.
String	getEncryptionKeyArn() The Amazon Resource Name (ARN) of an encryption key that is used to protect the job.
String	getEncryptionMode() The encryption mode for the job, which can be one of the following:
String	getLogSubscription() Enables or disables Amazon CloudWatch logging for the job.
Integer	getMaxCapacity() The maximum number of nodes that DataBrew can consume when the job processes data.
Integer	getMaxRetries() The maximum number of times to retry the job after a job run fails.
String	getName() A unique name for the job.
List<Output>	getOutputs() One or more artifacts that represent the output from running the job.
String	getProjectName() Either the name of an existing project, or a combination of a recipe and a dataset to associate with the recipe.
RecipeReference	getRecipeReference()
String	getRoleArn() The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role to be assumed when DataBrew runs the job.
Map<String,String>	getTags() Metadata tags to apply to this job.
Integer	getTimeout() The job's timeout in minutes.
int	hashCode()
void	setDatabaseOutputs(Collection<DatabaseOutput> databaseOutputs) Represents a list of JDBC database output objects which defines the output destination for a DataBrew recipe job to write to.
void	setDataCatalogOutputs(Collection<DataCatalogOutput> dataCatalogOutputs) One or more artifacts that represent the Glue Data Catalog output from running the job.
void	setDatasetName(String datasetName) The name of the dataset that this job processes.
void	setEncryptionKeyArn(String encryptionKeyArn) The Amazon Resource Name (ARN) of an encryption key that is used to protect the job.
void	setEncryptionMode(String encryptionMode) The encryption mode for the job, which can be one of the following:
void	setLogSubscription(String logSubscription) Enables or disables Amazon CloudWatch logging for the job.
void	setMaxCapacity(Integer maxCapacity) The maximum number of nodes that DataBrew can consume when the job processes data.
void	setMaxRetries(Integer maxRetries) The maximum number of times to retry the job after a job run fails.
void	setName(String name) A unique name for the job.
void	setOutputs(Collection<Output> outputs) One or more artifacts that represent the output from running the job.
void	setProjectName(String projectName) Either the name of an existing project, or a combination of a recipe and a dataset to associate with the recipe.
void	setRecipeReference(RecipeReference recipeReference)
void	setRoleArn(String roleArn) The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role to be assumed when DataBrew runs the job.
void	setTags(Map<String,String> tags) Metadata tags to apply to this job.
void	setTimeout(Integer timeout) The job's timeout in minutes.
String	toString() Returns a string representation of this object.
CreateRecipeJobRequest	withDatabaseOutputs(Collection<DatabaseOutput> databaseOutputs) Represents a list of JDBC database output objects which defines the output destination for a DataBrew recipe job to write to.
CreateRecipeJobRequest	withDatabaseOutputs(DatabaseOutput... databaseOutputs) Represents a list of JDBC database output objects which defines the output destination for a DataBrew recipe job to write to.
CreateRecipeJobRequest	withDataCatalogOutputs(Collection<DataCatalogOutput> dataCatalogOutputs) One or more artifacts that represent the Glue Data Catalog output from running the job.
CreateRecipeJobRequest	withDataCatalogOutputs(DataCatalogOutput... dataCatalogOutputs) One or more artifacts that represent the Glue Data Catalog output from running the job.
CreateRecipeJobRequest	withDatasetName(String datasetName) The name of the dataset that this job processes.
CreateRecipeJobRequest	withEncryptionKeyArn(String encryptionKeyArn) The Amazon Resource Name (ARN) of an encryption key that is used to protect the job.
CreateRecipeJobRequest	withEncryptionMode(EncryptionMode encryptionMode) The encryption mode for the job, which can be one of the following:
CreateRecipeJobRequest	withEncryptionMode(String encryptionMode) The encryption mode for the job, which can be one of the following:
CreateRecipeJobRequest	withLogSubscription(LogSubscription logSubscription) Enables or disables Amazon CloudWatch logging for the job.
CreateRecipeJobRequest	withLogSubscription(String logSubscription) Enables or disables Amazon CloudWatch logging for the job.
CreateRecipeJobRequest	withMaxCapacity(Integer maxCapacity) The maximum number of nodes that DataBrew can consume when the job processes data.
CreateRecipeJobRequest	withMaxRetries(Integer maxRetries) The maximum number of times to retry the job after a job run fails.
CreateRecipeJobRequest	withName(String name) A unique name for the job.
CreateRecipeJobRequest	withOutputs(Collection<Output> outputs) One or more artifacts that represent the output from running the job.
CreateRecipeJobRequest	withOutputs(Output... outputs) One or more artifacts that represent the output from running the job.
CreateRecipeJobRequest	withProjectName(String projectName) Either the name of an existing project, or a combination of a recipe and a dataset to associate with the recipe.
CreateRecipeJobRequest	withRecipeReference(RecipeReference recipeReference)
CreateRecipeJobRequest	withRoleArn(String roleArn) The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role to be assumed when DataBrew runs the job.
CreateRecipeJobRequest	withTags(Map<String,String> tags) Metadata tags to apply to this job.
CreateRecipeJobRequest	withTimeout(Integer timeout) The job's timeout in minutes.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateRecipeJobRequest

public CreateRecipeJobRequest()

Method Detail

setDatasetName

public void setDatasetName(String datasetName)

The name of the dataset that this job processes.

Parameters:

datasetName - The name of the dataset that this job processes.

getDatasetName

public String getDatasetName()

The name of the dataset that this job processes.

Returns:

The name of the dataset that this job processes.

withDatasetName

public CreateRecipeJobRequest withDatasetName(String datasetName)

The name of the dataset that this job processes.

Parameters:

datasetName - The name of the dataset that this job processes.

Returns:

Returns a reference to this object so that method calls can be chained together.

setEncryptionKeyArn

public void setEncryptionKeyArn(String encryptionKeyArn)

The Amazon Resource Name (ARN) of an encryption key that is used to protect the job.

Parameters:

encryptionKeyArn - The Amazon Resource Name (ARN) of an encryption key that is used to protect the job.

getEncryptionKeyArn

public String getEncryptionKeyArn()

The Amazon Resource Name (ARN) of an encryption key that is used to protect the job.

Returns:

The Amazon Resource Name (ARN) of an encryption key that is used to protect the job.

withEncryptionKeyArn

public CreateRecipeJobRequest withEncryptionKeyArn(String encryptionKeyArn)

The Amazon Resource Name (ARN) of an encryption key that is used to protect the job.

Parameters:

encryptionKeyArn - The Amazon Resource Name (ARN) of an encryption key that is used to protect the job.

Returns:

Returns a reference to this object so that method calls can be chained together.

setEncryptionMode

public void setEncryptionMode(String encryptionMode)

The encryption mode for the job, which can be one of the following:

• SSE-KMS - Server-side encryption with keys managed by KMS.

• SSE-S3 - Server-side encryption with keys managed by Amazon S3.

Parameters:

encryptionMode - The encryption mode for the job, which can be one of the following:

• SSE-KMS - Server-side encryption with keys managed by KMS.

• SSE-S3 - Server-side encryption with keys managed by Amazon S3.

See Also:

EncryptionMode

getEncryptionMode

public String getEncryptionMode()

The encryption mode for the job, which can be one of the following:

• SSE-KMS - Server-side encryption with keys managed by KMS.

• SSE-S3 - Server-side encryption with keys managed by Amazon S3.

Returns:

The encryption mode for the job, which can be one of the following:

• SSE-KMS - Server-side encryption with keys managed by KMS.

• SSE-S3 - Server-side encryption with keys managed by Amazon S3.

See Also:

EncryptionMode

withEncryptionMode

public CreateRecipeJobRequest withEncryptionMode(String encryptionMode)

The encryption mode for the job, which can be one of the following:

• SSE-KMS - Server-side encryption with keys managed by KMS.

• SSE-S3 - Server-side encryption with keys managed by Amazon S3.

Parameters:

encryptionMode - The encryption mode for the job, which can be one of the following:

• SSE-KMS - Server-side encryption with keys managed by KMS.

• SSE-S3 - Server-side encryption with keys managed by Amazon S3.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

EncryptionMode

withEncryptionMode

public CreateRecipeJobRequest withEncryptionMode(EncryptionMode encryptionMode)

The encryption mode for the job, which can be one of the following:

• SSE-KMS - Server-side encryption with keys managed by KMS.

• SSE-S3 - Server-side encryption with keys managed by Amazon S3.

Parameters:

encryptionMode - The encryption mode for the job, which can be one of the following:

• SSE-KMS - Server-side encryption with keys managed by KMS.

• SSE-S3 - Server-side encryption with keys managed by Amazon S3.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

EncryptionMode

setName

public void setName(String name)

A unique name for the job. Valid characters are alphanumeric (A-Z, a-z, 0-9), hyphen (-), period (.), and space.

Parameters:

name - A unique name for the job. Valid characters are alphanumeric (A-Z, a-z, 0-9), hyphen (-), period (.), and space.

getName

public String getName()

A unique name for the job. Valid characters are alphanumeric (A-Z, a-z, 0-9), hyphen (-), period (.), and space.

Returns:

A unique name for the job. Valid characters are alphanumeric (A-Z, a-z, 0-9), hyphen (-), period (.), and space.

withName

public CreateRecipeJobRequest withName(String name)

A unique name for the job. Valid characters are alphanumeric (A-Z, a-z, 0-9), hyphen (-), period (.), and space.

Parameters:

name - A unique name for the job. Valid characters are alphanumeric (A-Z, a-z, 0-9), hyphen (-), period (.), and space.

Returns:

Returns a reference to this object so that method calls can be chained together.

setLogSubscription

public void setLogSubscription(String logSubscription)

Enables or disables Amazon CloudWatch logging for the job. If logging is enabled, CloudWatch writes one log stream for each job run.

Parameters:

logSubscription - Enables or disables Amazon CloudWatch logging for the job. If logging is enabled, CloudWatch writes one log stream for each job run.

See Also:

LogSubscription

getLogSubscription

public String getLogSubscription()

Enables or disables Amazon CloudWatch logging for the job. If logging is enabled, CloudWatch writes one log stream for each job run.

Returns:

Enables or disables Amazon CloudWatch logging for the job. If logging is enabled, CloudWatch writes one log stream for each job run.

See Also:

LogSubscription

withLogSubscription

public CreateRecipeJobRequest withLogSubscription(String logSubscription)

Enables or disables Amazon CloudWatch logging for the job. If logging is enabled, CloudWatch writes one log stream for each job run.

Parameters:

logSubscription - Enables or disables Amazon CloudWatch logging for the job. If logging is enabled, CloudWatch writes one log stream for each job run.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

LogSubscription

withLogSubscription

public CreateRecipeJobRequest withLogSubscription(LogSubscription logSubscription)

Enables or disables Amazon CloudWatch logging for the job. If logging is enabled, CloudWatch writes one log stream for each job run.

Parameters:

logSubscription - Enables or disables Amazon CloudWatch logging for the job. If logging is enabled, CloudWatch writes one log stream for each job run.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

LogSubscription

setMaxCapacity

public void setMaxCapacity(Integer maxCapacity)

The maximum number of nodes that DataBrew can consume when the job processes data.

Parameters:

maxCapacity - The maximum number of nodes that DataBrew can consume when the job processes data.

getMaxCapacity

public Integer getMaxCapacity()

The maximum number of nodes that DataBrew can consume when the job processes data.

Returns:

The maximum number of nodes that DataBrew can consume when the job processes data.

withMaxCapacity

public CreateRecipeJobRequest withMaxCapacity(Integer maxCapacity)

The maximum number of nodes that DataBrew can consume when the job processes data.

Parameters:

maxCapacity - The maximum number of nodes that DataBrew can consume when the job processes data.

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 the job after a job run fails.

Parameters:

maxRetries - The maximum number of times to retry the job after a job run fails.

getMaxRetries

public Integer getMaxRetries()

The maximum number of times to retry the job after a job run fails.

Returns:

The maximum number of times to retry the job after a job run fails.

withMaxRetries

public CreateRecipeJobRequest withMaxRetries(Integer maxRetries)

The maximum number of times to retry the job after a job run fails.

Parameters:

maxRetries - The maximum number of times to retry the job after a job run fails.

Returns:

Returns a reference to this object so that method calls can be chained together.

getOutputs

public List<Output> getOutputs()

One or more artifacts that represent the output from running the job.

Returns:

One or more artifacts that represent the output from running the job.

setOutputs

public void setOutputs(Collection<Output> outputs)

One or more artifacts that represent the output from running the job.

Parameters:

outputs - One or more artifacts that represent the output from running the job.

withOutputs

public CreateRecipeJobRequest withOutputs(Output... outputs)

One or more artifacts that represent the output from running the job.

NOTE: This method appends the values to the existing list (if any). Use setOutputs(java.util.Collection) or withOutputs(java.util.Collection) if you want to override the existing values.

Parameters:

outputs - One or more artifacts that represent the output from running the job.

Returns:

Returns a reference to this object so that method calls can be chained together.

withOutputs

public CreateRecipeJobRequest withOutputs(Collection<Output> outputs)

One or more artifacts that represent the output from running the job.

Parameters:

outputs - One or more artifacts that represent the output from running the job.

Returns:

Returns a reference to this object so that method calls can be chained together.

getDataCatalogOutputs

public List<DataCatalogOutput> getDataCatalogOutputs()

One or more artifacts that represent the Glue Data Catalog output from running the job.

Returns:

One or more artifacts that represent the Glue Data Catalog output from running the job.

setDataCatalogOutputs

public void setDataCatalogOutputs(Collection<DataCatalogOutput> dataCatalogOutputs)

One or more artifacts that represent the Glue Data Catalog output from running the job.

Parameters:

dataCatalogOutputs - One or more artifacts that represent the Glue Data Catalog output from running the job.

withDataCatalogOutputs

public CreateRecipeJobRequest withDataCatalogOutputs(DataCatalogOutput... dataCatalogOutputs)

One or more artifacts that represent the Glue Data Catalog output from running the job.

NOTE: This method appends the values to the existing list (if any). Use setDataCatalogOutputs(java.util.Collection) or withDataCatalogOutputs(java.util.Collection) if you want to override the existing values.

Parameters:

dataCatalogOutputs - One or more artifacts that represent the Glue Data Catalog output from running the job.

Returns:

Returns a reference to this object so that method calls can be chained together.

withDataCatalogOutputs

public CreateRecipeJobRequest withDataCatalogOutputs(Collection<DataCatalogOutput> dataCatalogOutputs)

One or more artifacts that represent the Glue Data Catalog output from running the job.

Parameters:

dataCatalogOutputs - One or more artifacts that represent the Glue Data Catalog output from running the job.

Returns:

Returns a reference to this object so that method calls can be chained together.

getDatabaseOutputs

public List<DatabaseOutput> getDatabaseOutputs()

Represents a list of JDBC database output objects which defines the output destination for a DataBrew recipe job to write to.

Returns:

Represents a list of JDBC database output objects which defines the output destination for a DataBrew recipe job to write to.

setDatabaseOutputs

public void setDatabaseOutputs(Collection<DatabaseOutput> databaseOutputs)

Represents a list of JDBC database output objects which defines the output destination for a DataBrew recipe job to write to.

Parameters:

databaseOutputs - Represents a list of JDBC database output objects which defines the output destination for a DataBrew recipe job to write to.

withDatabaseOutputs

public CreateRecipeJobRequest withDatabaseOutputs(DatabaseOutput... databaseOutputs)

Represents a list of JDBC database output objects which defines the output destination for a DataBrew recipe job to write to.

NOTE: This method appends the values to the existing list (if any). Use setDatabaseOutputs(java.util.Collection) or withDatabaseOutputs(java.util.Collection) if you want to override the existing values.

Parameters:

databaseOutputs - Represents a list of JDBC database output objects which defines the output destination for a DataBrew recipe job to write to.

Returns:

Returns a reference to this object so that method calls can be chained together.

withDatabaseOutputs

public CreateRecipeJobRequest withDatabaseOutputs(Collection<DatabaseOutput> databaseOutputs)

Represents a list of JDBC database output objects which defines the output destination for a DataBrew recipe job to write to.

Parameters:

databaseOutputs - Represents a list of JDBC database output objects which defines the output destination for a DataBrew recipe job to write to.

Returns:

Returns a reference to this object so that method calls can be chained together.

setProjectName

public void setProjectName(String projectName)

Either the name of an existing project, or a combination of a recipe and a dataset to associate with the recipe.

Parameters:

projectName - Either the name of an existing project, or a combination of a recipe and a dataset to associate with the recipe.

getProjectName

public String getProjectName()

Either the name of an existing project, or a combination of a recipe and a dataset to associate with the recipe.

Returns:

Either the name of an existing project, or a combination of a recipe and a dataset to associate with the recipe.

withProjectName

public CreateRecipeJobRequest withProjectName(String projectName)

Either the name of an existing project, or a combination of a recipe and a dataset to associate with the recipe.

Parameters:

projectName - Either the name of an existing project, or a combination of a recipe and a dataset to associate with the recipe.

Returns:

Returns a reference to this object so that method calls can be chained together.

setRecipeReference

public void setRecipeReference(RecipeReference recipeReference)

Parameters:

recipeReference -

getRecipeReference

public RecipeReference getRecipeReference()

Returns:

withRecipeReference

public CreateRecipeJobRequest withRecipeReference(RecipeReference recipeReference)

Parameters:

recipeReference -

Returns:

Returns a reference to this object so that method calls can be chained together.

setRoleArn

public void setRoleArn(String roleArn)

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role to be assumed when DataBrew runs the job.

Parameters:

roleArn - The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role to be assumed when DataBrew runs the job.

getRoleArn

public String getRoleArn()

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role to be assumed when DataBrew runs the job.

Returns:

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role to be assumed when DataBrew runs the job.

withRoleArn

public CreateRecipeJobRequest withRoleArn(String roleArn)

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role to be assumed when DataBrew runs the job.

Parameters:

roleArn - The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role to be assumed when DataBrew runs the job.

Returns:

Returns a reference to this object so that method calls can be chained together.

getTags

public Map<String,String> getTags()

Metadata tags to apply to this job.

Returns:

Metadata tags to apply to this job.

setTags

public void setTags(Map<String,String> tags)

Metadata tags to apply to this job.

Parameters:

tags - Metadata tags to apply to this job.

withTags

public CreateRecipeJobRequest withTags(Map<String,String> tags)

Metadata tags to apply to this job.

Parameters:

tags - Metadata tags to apply to this job.

Returns:

Returns a reference to this object so that method calls can be chained together.

addTagsEntry

public CreateRecipeJobRequest addTagsEntry(String key,
                                           String value)

Add a single Tags entry

See Also:

withTags(java.util.Map<java.lang.String, java.lang.String>)

clearTagsEntries

public CreateRecipeJobRequest clearTagsEntries()

Removes all the entries added into Tags.

Returns:

Returns a reference to this object so that method calls can be chained together.

setTimeout

public void setTimeout(Integer timeout)

The job's timeout in minutes. A job that attempts to run longer than this timeout period ends with a status of TIMEOUT.

Parameters:

timeout - The job's timeout in minutes. A job that attempts to run longer than this timeout period ends with a status of TIMEOUT.

getTimeout

public Integer getTimeout()

The job's timeout in minutes. A job that attempts to run longer than this timeout period ends with a status of TIMEOUT.

Returns:

The job's timeout in minutes. A job that attempts to run longer than this timeout period ends with a status of TIMEOUT.

withTimeout

public CreateRecipeJobRequest withTimeout(Integer timeout)

The job's timeout in minutes. A job that attempts to run longer than this timeout period ends with a status of TIMEOUT.

Parameters:

timeout - The job's timeout in minutes. A job that attempts to run longer than this timeout period ends with a status of TIMEOUT.

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 CreateRecipeJobRequest 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()