com.amazonaws.services.gluedatabrew.model

Class CreateProfileJobRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.gluedatabrew.model.CreateProfileJobRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

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

Method Summary

Modifier and Type	Method and Description
CreateProfileJobRequest	addTagsEntry(String key, String value) Add a single Tags entry
CreateProfileJobRequest	clearTagsEntries() Removes all the entries added into Tags.
CreateProfileJobRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
ProfileConfiguration	getConfiguration() Configuration for profile jobs.
String	getDatasetName() The name of the dataset that this job is to act upon.
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:
JobSample	getJobSample() Sample configuration for profile jobs only.
String	getLogSubscription() Enables or disables Amazon CloudWatch logging for the job.
Integer	getMaxCapacity() The maximum number of nodes that DataBrew can use when the job processes data.
Integer	getMaxRetries() The maximum number of times to retry the job after a job run fails.
String	getName() The name of the job to be created.
S3Location	getOutputLocation()
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.
List<ValidationConfiguration>	getValidationConfigurations() List of validation configurations that are applied to the profile job.
int	hashCode()
void	setConfiguration(ProfileConfiguration configuration) Configuration for profile jobs.
void	setDatasetName(String datasetName) The name of the dataset that this job is to act upon.
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	setJobSample(JobSample jobSample) Sample configuration for profile jobs only.
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 use 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) The name of the job to be created.
void	setOutputLocation(S3Location outputLocation)
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.
void	setValidationConfigurations(Collection<ValidationConfiguration> validationConfigurations) List of validation configurations that are applied to the profile job.
String	toString() Returns a string representation of this object.
CreateProfileJobRequest	withConfiguration(ProfileConfiguration configuration) Configuration for profile jobs.
CreateProfileJobRequest	withDatasetName(String datasetName) The name of the dataset that this job is to act upon.
CreateProfileJobRequest	withEncryptionKeyArn(String encryptionKeyArn) The Amazon Resource Name (ARN) of an encryption key that is used to protect the job.
CreateProfileJobRequest	withEncryptionMode(EncryptionMode encryptionMode) The encryption mode for the job, which can be one of the following:
CreateProfileJobRequest	withEncryptionMode(String encryptionMode) The encryption mode for the job, which can be one of the following:
CreateProfileJobRequest	withJobSample(JobSample jobSample) Sample configuration for profile jobs only.
CreateProfileJobRequest	withLogSubscription(LogSubscription logSubscription) Enables or disables Amazon CloudWatch logging for the job.
CreateProfileJobRequest	withLogSubscription(String logSubscription) Enables or disables Amazon CloudWatch logging for the job.
CreateProfileJobRequest	withMaxCapacity(Integer maxCapacity) The maximum number of nodes that DataBrew can use when the job processes data.
CreateProfileJobRequest	withMaxRetries(Integer maxRetries) The maximum number of times to retry the job after a job run fails.
CreateProfileJobRequest	withName(String name) The name of the job to be created.
CreateProfileJobRequest	withOutputLocation(S3Location outputLocation)
CreateProfileJobRequest	withRoleArn(String roleArn) The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role to be assumed when DataBrew runs the job.
CreateProfileJobRequest	withTags(Map<String,String> tags) Metadata tags to apply to this job.
CreateProfileJobRequest	withTimeout(Integer timeout) The job's timeout in minutes.
CreateProfileJobRequest	withValidationConfigurations(Collection<ValidationConfiguration> validationConfigurations) List of validation configurations that are applied to the profile job.
CreateProfileJobRequest	withValidationConfigurations(ValidationConfiguration... validationConfigurations) List of validation configurations that are applied to the profile job.

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

CreateProfileJobRequest

public CreateProfileJobRequest()

Method Detail

setDatasetName

public void setDatasetName(String datasetName)

The name of the dataset that this job is to act upon.

Parameters:

datasetName - The name of the dataset that this job is to act upon.

getDatasetName

public String getDatasetName()

The name of the dataset that this job is to act upon.

Returns:

The name of the dataset that this job is to act upon.

withDatasetName

public CreateProfileJobRequest withDatasetName(String datasetName)

The name of the dataset that this job is to act upon.

Parameters:

datasetName - The name of the dataset that this job is to act upon.

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 CreateProfileJobRequest 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 - SSE-KMS - Server-side encryption with KMS-managed keys.

• 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 - SSE-KMS - Server-side encryption with KMS-managed keys.

• 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 - SSE-KMS - Server-side encryption with KMS-managed keys.

• 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 - SSE-KMS - Server-side encryption with KMS-managed keys.

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

See Also:

EncryptionMode

withEncryptionMode

public CreateProfileJobRequest withEncryptionMode(String encryptionMode)

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

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

• 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 - SSE-KMS - Server-side encryption with KMS-managed keys.

• 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 CreateProfileJobRequest withEncryptionMode(EncryptionMode encryptionMode)

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

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

• 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 - SSE-KMS - Server-side encryption with KMS-managed keys.

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

The name of the job to be created. Valid characters are alphanumeric (A-Z, a-z, 0-9), hyphen (-), period (.), and space.

Parameters:

name - The name of the job to be created. Valid characters are alphanumeric (A-Z, a-z, 0-9), hyphen (-), period (.), and space.

getName

public String getName()

The name of the job to be created. Valid characters are alphanumeric (A-Z, a-z, 0-9), hyphen (-), period (.), and space.

Returns:

The name of the job to be created. Valid characters are alphanumeric (A-Z, a-z, 0-9), hyphen (-), period (.), and space.

withName

public CreateProfileJobRequest withName(String name)

The name of the job to be created. Valid characters are alphanumeric (A-Z, a-z, 0-9), hyphen (-), period (.), and space.

Parameters:

name - The name of the job to be created. 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 CreateProfileJobRequest 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 CreateProfileJobRequest 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 use when the job processes data.

Parameters:

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

getMaxCapacity

public Integer getMaxCapacity()

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

Returns:

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

withMaxCapacity

public CreateProfileJobRequest withMaxCapacity(Integer maxCapacity)

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

Parameters:

maxCapacity - The maximum number of nodes that DataBrew can use 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 CreateProfileJobRequest 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.

setOutputLocation

public void setOutputLocation(S3Location outputLocation)

Parameters:

outputLocation -

getOutputLocation

public S3Location getOutputLocation()

Returns:

withOutputLocation

public CreateProfileJobRequest withOutputLocation(S3Location outputLocation)

Parameters:

outputLocation -

Returns:

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

setConfiguration

public void setConfiguration(ProfileConfiguration configuration)

Configuration for profile jobs. Used to select columns, do evaluations, and override default parameters of evaluations. When configuration is null, the profile job will run with default settings.

Parameters:

configuration - Configuration for profile jobs. Used to select columns, do evaluations, and override default parameters of evaluations. When configuration is null, the profile job will run with default settings.

getConfiguration

public ProfileConfiguration getConfiguration()

Configuration for profile jobs. Used to select columns, do evaluations, and override default parameters of evaluations. When configuration is null, the profile job will run with default settings.

Returns:

Configuration for profile jobs. Used to select columns, do evaluations, and override default parameters of evaluations. When configuration is null, the profile job will run with default settings.

withConfiguration

public CreateProfileJobRequest withConfiguration(ProfileConfiguration configuration)

Configuration for profile jobs. Used to select columns, do evaluations, and override default parameters of evaluations. When configuration is null, the profile job will run with default settings.

Parameters:

configuration - Configuration for profile jobs. Used to select columns, do evaluations, and override default parameters of evaluations. When configuration is null, the profile job will run with default settings.

Returns:

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

getValidationConfigurations

public List<ValidationConfiguration> getValidationConfigurations()

List of validation configurations that are applied to the profile job.

Returns:

List of validation configurations that are applied to the profile job.

setValidationConfigurations

public void setValidationConfigurations(Collection<ValidationConfiguration> validationConfigurations)

List of validation configurations that are applied to the profile job.

Parameters:

validationConfigurations - List of validation configurations that are applied to the profile job.

withValidationConfigurations

public CreateProfileJobRequest withValidationConfigurations(ValidationConfiguration... validationConfigurations)

List of validation configurations that are applied to the profile job.

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

Parameters:

validationConfigurations - List of validation configurations that are applied to the profile job.

Returns:

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

withValidationConfigurations

public CreateProfileJobRequest withValidationConfigurations(Collection<ValidationConfiguration> validationConfigurations)

List of validation configurations that are applied to the profile job.

Parameters:

validationConfigurations - List of validation configurations that are applied to the profile job.

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 CreateProfileJobRequest 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 CreateProfileJobRequest 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 CreateProfileJobRequest addTagsEntry(String key,
                                            String value)

Add a single Tags entry

See Also:

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

clearTagsEntries

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

setJobSample

public void setJobSample(JobSample jobSample)

Sample configuration for profile jobs only. Determines the number of rows on which the profile job will be executed. If a JobSample value is not provided, the default value will be used. The default value is CUSTOM_ROWS for the mode parameter and 20000 for the size parameter.

Parameters:

jobSample - Sample configuration for profile jobs only. Determines the number of rows on which the profile job will be executed. If a JobSample value is not provided, the default value will be used. The default value is CUSTOM_ROWS for the mode parameter and 20000 for the size parameter.

getJobSample

public JobSample getJobSample()

Sample configuration for profile jobs only. Determines the number of rows on which the profile job will be executed. If a JobSample value is not provided, the default value will be used. The default value is CUSTOM_ROWS for the mode parameter and 20000 for the size parameter.

Returns:

Sample configuration for profile jobs only. Determines the number of rows on which the profile job will be executed. If a JobSample value is not provided, the default value will be used. The default value is CUSTOM_ROWS for the mode parameter and 20000 for the size parameter.

withJobSample

public CreateProfileJobRequest withJobSample(JobSample jobSample)

Sample configuration for profile jobs only. Determines the number of rows on which the profile job will be executed. If a JobSample value is not provided, the default value will be used. The default value is CUSTOM_ROWS for the mode parameter and 20000 for the size parameter.

Parameters:

jobSample - Sample configuration for profile jobs only. Determines the number of rows on which the profile job will be executed. If a JobSample value is not provided, the default value will be used. The default value is CUSTOM_ROWS for the mode parameter and 20000 for the size parameter.

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