com.amazonaws.services.workmail.model

Class StartMailboxExportJobRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.workmail.model.StartMailboxExportJobRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

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

Method Summary

Modifier and Type	Method and Description
StartMailboxExportJobRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getClientToken() The idempotency token for the client request.
String	getDescription() The mailbox export job description.
String	getEntityId() The identifier of the user or resource associated with the mailbox.
String	getKmsKeyArn() The Amazon Resource Name (ARN) of the symmetric AWS Key Management Service (AWS KMS) key that encrypts the exported mailbox content.
String	getOrganizationId() The identifier associated with the organization.
String	getRoleArn() The ARN of the AWS Identity and Access Management (IAM) role that grants write permission to the S3 bucket.
String	getS3BucketName() The name of the S3 bucket.
String	getS3Prefix() The S3 bucket prefix.
int	hashCode()
void	setClientToken(String clientToken) The idempotency token for the client request.
void	setDescription(String description) The mailbox export job description.
void	setEntityId(String entityId) The identifier of the user or resource associated with the mailbox.
void	setKmsKeyArn(String kmsKeyArn) The Amazon Resource Name (ARN) of the symmetric AWS Key Management Service (AWS KMS) key that encrypts the exported mailbox content.
void	setOrganizationId(String organizationId) The identifier associated with the organization.
void	setRoleArn(String roleArn) The ARN of the AWS Identity and Access Management (IAM) role that grants write permission to the S3 bucket.
void	setS3BucketName(String s3BucketName) The name of the S3 bucket.
void	setS3Prefix(String s3Prefix) The S3 bucket prefix.
String	toString() Returns a string representation of this object.
StartMailboxExportJobRequest	withClientToken(String clientToken) The idempotency token for the client request.
StartMailboxExportJobRequest	withDescription(String description) The mailbox export job description.
StartMailboxExportJobRequest	withEntityId(String entityId) The identifier of the user or resource associated with the mailbox.
StartMailboxExportJobRequest	withKmsKeyArn(String kmsKeyArn) The Amazon Resource Name (ARN) of the symmetric AWS Key Management Service (AWS KMS) key that encrypts the exported mailbox content.
StartMailboxExportJobRequest	withOrganizationId(String organizationId) The identifier associated with the organization.
StartMailboxExportJobRequest	withRoleArn(String roleArn) The ARN of the AWS Identity and Access Management (IAM) role that grants write permission to the S3 bucket.
StartMailboxExportJobRequest	withS3BucketName(String s3BucketName) The name of the S3 bucket.
StartMailboxExportJobRequest	withS3Prefix(String s3Prefix) The S3 bucket prefix.

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

StartMailboxExportJobRequest

public StartMailboxExportJobRequest()

Method Detail

setClientToken

public void setClientToken(String clientToken)

The idempotency token for the client request.

Parameters:

clientToken - The idempotency token for the client request.

getClientToken

public String getClientToken()

The idempotency token for the client request.

Returns:

The idempotency token for the client request.

withClientToken

public StartMailboxExportJobRequest withClientToken(String clientToken)

The idempotency token for the client request.

Parameters:

clientToken - The idempotency token for the client request.

Returns:

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

setOrganizationId

public void setOrganizationId(String organizationId)

The identifier associated with the organization.

Parameters:

organizationId - The identifier associated with the organization.

getOrganizationId

public String getOrganizationId()

The identifier associated with the organization.

Returns:

The identifier associated with the organization.

withOrganizationId

public StartMailboxExportJobRequest withOrganizationId(String organizationId)

The identifier associated with the organization.

Parameters:

organizationId - The identifier associated with the organization.

Returns:

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

setEntityId

public void setEntityId(String entityId)

The identifier of the user or resource associated with the mailbox.

Parameters:

entityId - The identifier of the user or resource associated with the mailbox.

getEntityId

public String getEntityId()

The identifier of the user or resource associated with the mailbox.

Returns:

The identifier of the user or resource associated with the mailbox.

withEntityId

public StartMailboxExportJobRequest withEntityId(String entityId)

The identifier of the user or resource associated with the mailbox.

Parameters:

entityId - The identifier of the user or resource associated with the mailbox.

Returns:

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

setDescription

public void setDescription(String description)

The mailbox export job description.

Parameters:

description - The mailbox export job description.

getDescription

public String getDescription()

The mailbox export job description.

Returns:

The mailbox export job description.

withDescription

public StartMailboxExportJobRequest withDescription(String description)

The mailbox export job description.

Parameters:

description - The mailbox export job description.

Returns:

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

setRoleArn

public void setRoleArn(String roleArn)

The ARN of the AWS Identity and Access Management (IAM) role that grants write permission to the S3 bucket.

Parameters:

roleArn - The ARN of the AWS Identity and Access Management (IAM) role that grants write permission to the S3 bucket.

getRoleArn

public String getRoleArn()

The ARN of the AWS Identity and Access Management (IAM) role that grants write permission to the S3 bucket.

Returns:

The ARN of the AWS Identity and Access Management (IAM) role that grants write permission to the S3 bucket.

withRoleArn

public StartMailboxExportJobRequest withRoleArn(String roleArn)

The ARN of the AWS Identity and Access Management (IAM) role that grants write permission to the S3 bucket.

Parameters:

roleArn - The ARN of the AWS Identity and Access Management (IAM) role that grants write permission to the S3 bucket.

Returns:

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

setKmsKeyArn

public void setKmsKeyArn(String kmsKeyArn)

The Amazon Resource Name (ARN) of the symmetric AWS Key Management Service (AWS KMS) key that encrypts the exported mailbox content.

Parameters:

kmsKeyArn - The Amazon Resource Name (ARN) of the symmetric AWS Key Management Service (AWS KMS) key that encrypts the exported mailbox content.

getKmsKeyArn

public String getKmsKeyArn()

The Amazon Resource Name (ARN) of the symmetric AWS Key Management Service (AWS KMS) key that encrypts the exported mailbox content.

Returns:

The Amazon Resource Name (ARN) of the symmetric AWS Key Management Service (AWS KMS) key that encrypts the exported mailbox content.

withKmsKeyArn

public StartMailboxExportJobRequest withKmsKeyArn(String kmsKeyArn)

The Amazon Resource Name (ARN) of the symmetric AWS Key Management Service (AWS KMS) key that encrypts the exported mailbox content.

Parameters:

kmsKeyArn - The Amazon Resource Name (ARN) of the symmetric AWS Key Management Service (AWS KMS) key that encrypts the exported mailbox content.

Returns:

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

setS3BucketName

public void setS3BucketName(String s3BucketName)

The name of the S3 bucket.

Parameters:

s3BucketName - The name of the S3 bucket.

getS3BucketName

public String getS3BucketName()

The name of the S3 bucket.

Returns:

The name of the S3 bucket.

withS3BucketName

public StartMailboxExportJobRequest withS3BucketName(String s3BucketName)

The name of the S3 bucket.

Parameters:

s3BucketName - The name of the S3 bucket.

Returns:

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

setS3Prefix

public void setS3Prefix(String s3Prefix)

The S3 bucket prefix.

Parameters:

s3Prefix - The S3 bucket prefix.

getS3Prefix

public String getS3Prefix()

The S3 bucket prefix.

Returns:

The S3 bucket prefix.

withS3Prefix

public StartMailboxExportJobRequest withS3Prefix(String s3Prefix)

The S3 bucket prefix.

Parameters:

s3Prefix - The S3 bucket prefix.

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