software.amazon.awssdk.services.workmail.model

Interface DescribeMailboxExportJobResponse.Builder

All Superinterfaces:

AwsResponse.Builder, Buildable, CopyableBuilder<DescribeMailboxExportJobResponse.Builder,DescribeMailboxExportJobResponse>, SdkBuilder<DescribeMailboxExportJobResponse.Builder,DescribeMailboxExportJobResponse>, SdkPojo, SdkResponse.Builder, WorkMailResponse.Builder

Enclosing class:

DescribeMailboxExportJobResponse

public static interface DescribeMailboxExportJobResponse.Builder
extends WorkMailResponse.Builder, SdkPojo, CopyableBuilder<DescribeMailboxExportJobResponse.Builder,DescribeMailboxExportJobResponse>

Method Summary

Modifier and Type	Method and Description
DescribeMailboxExportJobResponse.Builder	description(String description) The mailbox export job description.
DescribeMailboxExportJobResponse.Builder	endTime(Instant endTime) The mailbox export job end timestamp.
DescribeMailboxExportJobResponse.Builder	entityId(String entityId) The identifier of the user or resource associated with the mailbox.
DescribeMailboxExportJobResponse.Builder	errorInfo(String errorInfo) Error information for failed mailbox export jobs.
DescribeMailboxExportJobResponse.Builder	estimatedProgress(Integer estimatedProgress) The estimated progress of the mailbox export job, in percentage points.
DescribeMailboxExportJobResponse.Builder	kmsKeyArn(String kmsKeyArn) The Amazon Resource Name (ARN) of the symmetric AWS Key Management Service (AWS KMS) key that encrypts the exported mailbox content.
DescribeMailboxExportJobResponse.Builder	roleArn(String roleArn) The ARN of the AWS Identity and Access Management (IAM) role that grants write permission to the Amazon Simple Storage Service (Amazon S3) bucket.
DescribeMailboxExportJobResponse.Builder	s3BucketName(String s3BucketName) The name of the S3 bucket.
DescribeMailboxExportJobResponse.Builder	s3Path(String s3Path) The path to the S3 bucket and file that the mailbox export job is exporting to.
DescribeMailboxExportJobResponse.Builder	s3Prefix(String s3Prefix) The S3 bucket prefix.
DescribeMailboxExportJobResponse.Builder	startTime(Instant startTime) The mailbox export job start timestamp.
DescribeMailboxExportJobResponse.Builder	state(MailboxExportJobState state) The state of the mailbox export job.
DescribeMailboxExportJobResponse.Builder	state(String state) The state of the mailbox export job.

Methods inherited from interface software.amazon.awssdk.services.workmail.model.WorkMailResponse.Builder

build, responseMetadata, responseMetadata

Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder

sdkHttpResponse, sdkHttpResponse

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

entityId

DescribeMailboxExportJobResponse.Builder entityId(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.

description

DescribeMailboxExportJobResponse.Builder description(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.

roleArn

DescribeMailboxExportJobResponse.Builder roleArn(String roleArn)

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

Parameters:

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

Returns:

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

kmsKeyArn

DescribeMailboxExportJobResponse.Builder kmsKeyArn(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.

s3BucketName

DescribeMailboxExportJobResponse.Builder s3BucketName(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.

s3Prefix

DescribeMailboxExportJobResponse.Builder s3Prefix(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.

s3Path

DescribeMailboxExportJobResponse.Builder s3Path(String s3Path)

The path to the S3 bucket and file that the mailbox export job is exporting to.

Parameters:

s3Path - The path to the S3 bucket and file that the mailbox export job is exporting to.

Returns:

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

estimatedProgress

DescribeMailboxExportJobResponse.Builder estimatedProgress(Integer estimatedProgress)

The estimated progress of the mailbox export job, in percentage points.

Parameters:

estimatedProgress - The estimated progress of the mailbox export job, in percentage points.

Returns:

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

state

DescribeMailboxExportJobResponse.Builder state(String state)

The state of the mailbox export job.

Parameters:

state - The state of the mailbox export job.

Returns:

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

See Also:

MailboxExportJobState, MailboxExportJobState

state

DescribeMailboxExportJobResponse.Builder state(MailboxExportJobState state)

The state of the mailbox export job.

Parameters:

state - The state of the mailbox export job.

Returns:

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

See Also:

MailboxExportJobState, MailboxExportJobState

errorInfo

DescribeMailboxExportJobResponse.Builder errorInfo(String errorInfo)

Error information for failed mailbox export jobs.

Parameters:

errorInfo - Error information for failed mailbox export jobs.

Returns:

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

startTime

DescribeMailboxExportJobResponse.Builder startTime(Instant startTime)

The mailbox export job start timestamp.

Parameters:

startTime - The mailbox export job start timestamp.

Returns:

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

endTime

DescribeMailboxExportJobResponse.Builder endTime(Instant endTime)

The mailbox export job end timestamp.

Parameters:

endTime - The mailbox export job end timestamp.

Returns:

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