com.amazonaws.services.s3control.model

Class CreateJobRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.s3control.model.CreateJobRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

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

Method Summary

Modifier and Type	Method and Description
CreateJobRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getAccountId() The Amazon Web Services account ID that creates the job.
String	getClientRequestToken() An idempotency token to ensure that you don't accidentally submit the same request twice.
Boolean	getConfirmationRequired() Indicates whether confirmation is required before Amazon S3 runs the job.
String	getDescription() A description for this job.
JobManifest	getManifest() Configuration parameters for the manifest.
JobManifestGenerator	getManifestGenerator() The attribute container for the ManifestGenerator details.
JobOperation	getOperation() The action that you want this job to perform on every object listed in the manifest.
Integer	getPriority() The numerical priority for this job.
JobReport	getReport() Configuration parameters for the optional job-completion report.
String	getRoleArn() The Amazon Resource Name (ARN) for the Identity and Access Management (IAM) role that Batch Operations will use to run this job's action on every object in the manifest.
List<S3Tag>	getTags() A set of tags to associate with the S3 Batch Operations job.
int	hashCode()
Boolean	isConfirmationRequired() Indicates whether confirmation is required before Amazon S3 runs the job.
void	setAccountId(String accountId) The Amazon Web Services account ID that creates the job.
void	setClientRequestToken(String clientRequestToken) An idempotency token to ensure that you don't accidentally submit the same request twice.
void	setConfirmationRequired(Boolean confirmationRequired) Indicates whether confirmation is required before Amazon S3 runs the job.
void	setDescription(String description) A description for this job.
void	setManifest(JobManifest manifest) Configuration parameters for the manifest.
void	setManifestGenerator(JobManifestGenerator manifestGenerator) The attribute container for the ManifestGenerator details.
void	setOperation(JobOperation operation) The action that you want this job to perform on every object listed in the manifest.
void	setPriority(Integer priority) The numerical priority for this job.
void	setReport(JobReport report) Configuration parameters for the optional job-completion report.
void	setRoleArn(String roleArn) The Amazon Resource Name (ARN) for the Identity and Access Management (IAM) role that Batch Operations will use to run this job's action on every object in the manifest.
void	setTags(Collection<S3Tag> tags) A set of tags to associate with the S3 Batch Operations job.
String	toString() Returns a string representation of this object.
CreateJobRequest	withAccountId(String accountId) The Amazon Web Services account ID that creates the job.
CreateJobRequest	withClientRequestToken(String clientRequestToken) An idempotency token to ensure that you don't accidentally submit the same request twice.
CreateJobRequest	withConfirmationRequired(Boolean confirmationRequired) Indicates whether confirmation is required before Amazon S3 runs the job.
CreateJobRequest	withDescription(String description) A description for this job.
CreateJobRequest	withManifest(JobManifest manifest) Configuration parameters for the manifest.
CreateJobRequest	withManifestGenerator(JobManifestGenerator manifestGenerator) The attribute container for the ManifestGenerator details.
CreateJobRequest	withOperation(JobOperation operation) The action that you want this job to perform on every object listed in the manifest.
CreateJobRequest	withPriority(Integer priority) The numerical priority for this job.
CreateJobRequest	withReport(JobReport report) Configuration parameters for the optional job-completion report.
CreateJobRequest	withRoleArn(String roleArn) The Amazon Resource Name (ARN) for the Identity and Access Management (IAM) role that Batch Operations will use to run this job's action on every object in the manifest.
CreateJobRequest	withTags(Collection<S3Tag> tags) A set of tags to associate with the S3 Batch Operations job.
CreateJobRequest	withTags(S3Tag... tags) A set of tags to associate with the S3 Batch Operations 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

CreateJobRequest

public CreateJobRequest()

Method Detail

setAccountId

public void setAccountId(String accountId)

The Amazon Web Services account ID that creates the job.

Parameters:

accountId - The Amazon Web Services account ID that creates the job.

getAccountId

public String getAccountId()

The Amazon Web Services account ID that creates the job.

Returns:

The Amazon Web Services account ID that creates the job.

withAccountId

public CreateJobRequest withAccountId(String accountId)

The Amazon Web Services account ID that creates the job.

Parameters:

accountId - The Amazon Web Services account ID that creates the job.

Returns:

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

setConfirmationRequired

public void setConfirmationRequired(Boolean confirmationRequired)

Indicates whether confirmation is required before Amazon S3 runs the job. Confirmation is only required for jobs created through the Amazon S3 console.

Parameters:

confirmationRequired - Indicates whether confirmation is required before Amazon S3 runs the job. Confirmation is only required for jobs created through the Amazon S3 console.

getConfirmationRequired

public Boolean getConfirmationRequired()

Indicates whether confirmation is required before Amazon S3 runs the job. Confirmation is only required for jobs created through the Amazon S3 console.

Returns:

Indicates whether confirmation is required before Amazon S3 runs the job. Confirmation is only required for jobs created through the Amazon S3 console.

withConfirmationRequired

public CreateJobRequest withConfirmationRequired(Boolean confirmationRequired)

Indicates whether confirmation is required before Amazon S3 runs the job. Confirmation is only required for jobs created through the Amazon S3 console.

Parameters:

confirmationRequired - Indicates whether confirmation is required before Amazon S3 runs the job. Confirmation is only required for jobs created through the Amazon S3 console.

Returns:

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

isConfirmationRequired

public Boolean isConfirmationRequired()

Indicates whether confirmation is required before Amazon S3 runs the job. Confirmation is only required for jobs created through the Amazon S3 console.

Returns:

Indicates whether confirmation is required before Amazon S3 runs the job. Confirmation is only required for jobs created through the Amazon S3 console.

setOperation

public void setOperation(JobOperation operation)

The action that you want this job to perform on every object listed in the manifest. For more information about the available actions, see Operations in the Amazon S3 User Guide.

Parameters:

operation - The action that you want this job to perform on every object listed in the manifest. For more information about the available actions, see Operations in the Amazon S3 User Guide.

getOperation

public JobOperation getOperation()

The action that you want this job to perform on every object listed in the manifest. For more information about the available actions, see Operations in the Amazon S3 User Guide.

Returns:

The action that you want this job to perform on every object listed in the manifest. For more information about the available actions, see Operations in the Amazon S3 User Guide.

withOperation

public CreateJobRequest withOperation(JobOperation operation)

The action that you want this job to perform on every object listed in the manifest. For more information about the available actions, see Operations in the Amazon S3 User Guide.

Parameters:

operation - The action that you want this job to perform on every object listed in the manifest. For more information about the available actions, see Operations in the Amazon S3 User Guide.

Returns:

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

setReport

public void setReport(JobReport report)

Configuration parameters for the optional job-completion report.

Parameters:

report - Configuration parameters for the optional job-completion report.

getReport

public JobReport getReport()

Configuration parameters for the optional job-completion report.

Returns:

Configuration parameters for the optional job-completion report.

withReport

public CreateJobRequest withReport(JobReport report)

Configuration parameters for the optional job-completion report.

Parameters:

report - Configuration parameters for the optional job-completion report.

Returns:

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

setClientRequestToken

public void setClientRequestToken(String clientRequestToken)

An idempotency token to ensure that you don't accidentally submit the same request twice. You can use any string up to the maximum length.

Parameters:

clientRequestToken - An idempotency token to ensure that you don't accidentally submit the same request twice. You can use any string up to the maximum length.

getClientRequestToken

public String getClientRequestToken()

An idempotency token to ensure that you don't accidentally submit the same request twice. You can use any string up to the maximum length.

Returns:

An idempotency token to ensure that you don't accidentally submit the same request twice. You can use any string up to the maximum length.

withClientRequestToken

public CreateJobRequest withClientRequestToken(String clientRequestToken)

An idempotency token to ensure that you don't accidentally submit the same request twice. You can use any string up to the maximum length.

Parameters:

clientRequestToken - An idempotency token to ensure that you don't accidentally submit the same request twice. You can use any string up to the maximum length.

Returns:

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

setManifest

public void setManifest(JobManifest manifest)

Configuration parameters for the manifest.

Parameters:

manifest - Configuration parameters for the manifest.

getManifest

public JobManifest getManifest()

Configuration parameters for the manifest.

Returns:

Configuration parameters for the manifest.

withManifest

public CreateJobRequest withManifest(JobManifest manifest)

Configuration parameters for the manifest.

Parameters:

manifest - Configuration parameters for the manifest.

Returns:

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

setDescription

public void setDescription(String description)

A description for this job. You can use any string within the permitted length. Descriptions don't need to be unique and can be used for multiple jobs.

Parameters:

description - A description for this job. You can use any string within the permitted length. Descriptions don't need to be unique and can be used for multiple jobs.

getDescription

public String getDescription()

A description for this job. You can use any string within the permitted length. Descriptions don't need to be unique and can be used for multiple jobs.

Returns:

A description for this job. You can use any string within the permitted length. Descriptions don't need to be unique and can be used for multiple jobs.

withDescription

public CreateJobRequest withDescription(String description)

A description for this job. You can use any string within the permitted length. Descriptions don't need to be unique and can be used for multiple jobs.

Parameters:

description - A description for this job. You can use any string within the permitted length. Descriptions don't need to be unique and can be used for multiple jobs.

Returns:

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

setPriority

public void setPriority(Integer priority)

The numerical priority for this job. Higher numbers indicate higher priority.

Parameters:

priority - The numerical priority for this job. Higher numbers indicate higher priority.

getPriority

public Integer getPriority()

The numerical priority for this job. Higher numbers indicate higher priority.

Returns:

The numerical priority for this job. Higher numbers indicate higher priority.

withPriority

public CreateJobRequest withPriority(Integer priority)

The numerical priority for this job. Higher numbers indicate higher priority.

Parameters:

priority - The numerical priority for this job. Higher numbers indicate higher priority.

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) for the Identity and Access Management (IAM) role that Batch Operations will use to run this job's action on every object in the manifest.

Parameters:

roleArn - The Amazon Resource Name (ARN) for the Identity and Access Management (IAM) role that Batch Operations will use to run this job's action on every object in the manifest.

getRoleArn

public String getRoleArn()

The Amazon Resource Name (ARN) for the Identity and Access Management (IAM) role that Batch Operations will use to run this job's action on every object in the manifest.

Returns:

The Amazon Resource Name (ARN) for the Identity and Access Management (IAM) role that Batch Operations will use to run this job's action on every object in the manifest.

withRoleArn

public CreateJobRequest withRoleArn(String roleArn)

The Amazon Resource Name (ARN) for the Identity and Access Management (IAM) role that Batch Operations will use to run this job's action on every object in the manifest.

Parameters:

roleArn - The Amazon Resource Name (ARN) for the Identity and Access Management (IAM) role that Batch Operations will use to run this job's action on every object in the manifest.

Returns:

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

getTags

public List<S3Tag> getTags()

A set of tags to associate with the S3 Batch Operations job. This is an optional parameter.

Returns:

A set of tags to associate with the S3 Batch Operations job. This is an optional parameter.

setTags

public void setTags(Collection<S3Tag> tags)

A set of tags to associate with the S3 Batch Operations job. This is an optional parameter.

Parameters:

tags - A set of tags to associate with the S3 Batch Operations job. This is an optional parameter.

withTags

public CreateJobRequest withTags(S3Tag... tags)

A set of tags to associate with the S3 Batch Operations job. This is an optional parameter.

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

Parameters:

tags - A set of tags to associate with the S3 Batch Operations job. This is an optional parameter.

Returns:

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

withTags

public CreateJobRequest withTags(Collection<S3Tag> tags)

A set of tags to associate with the S3 Batch Operations job. This is an optional parameter.

Parameters:

tags - A set of tags to associate with the S3 Batch Operations job. This is an optional parameter.

Returns:

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

setManifestGenerator

public void setManifestGenerator(JobManifestGenerator manifestGenerator)

The attribute container for the ManifestGenerator details. Jobs must be created with either a manifest file or a ManifestGenerator, but not both.

Parameters:

manifestGenerator - The attribute container for the ManifestGenerator details. Jobs must be created with either a manifest file or a ManifestGenerator, but not both.

getManifestGenerator

public JobManifestGenerator getManifestGenerator()

The attribute container for the ManifestGenerator details. Jobs must be created with either a manifest file or a ManifestGenerator, but not both.

Returns:

The attribute container for the ManifestGenerator details. Jobs must be created with either a manifest file or a ManifestGenerator, but not both.

withManifestGenerator

public CreateJobRequest withManifestGenerator(JobManifestGenerator manifestGenerator)

The attribute container for the ManifestGenerator details. Jobs must be created with either a manifest file or a ManifestGenerator, but not both.

Parameters:

manifestGenerator - The attribute container for the ManifestGenerator details. Jobs must be created with either a manifest file or a ManifestGenerator, but not both.

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