software.amazon.awssdk.services.workmail.model

Interface StartMailboxExportJobRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<StartMailboxExportJobRequest.Builder,StartMailboxExportJobRequest>, SdkBuilder<StartMailboxExportJobRequest.Builder,StartMailboxExportJobRequest>, SdkPojo, SdkRequest.Builder, WorkMailRequest.Builder

Enclosing class:

StartMailboxExportJobRequest

public static interface StartMailboxExportJobRequest.Builder
extends WorkMailRequest.Builder, SdkPojo, CopyableBuilder<StartMailboxExportJobRequest.Builder,StartMailboxExportJobRequest>

Method Summary

Modifier and Type	Method and Description
StartMailboxExportJobRequest.Builder	clientToken(String clientToken) The idempotency token for the client request.
StartMailboxExportJobRequest.Builder	description(String description) The mailbox export job description.
StartMailboxExportJobRequest.Builder	entityId(String entityId) The identifier of the user or resource associated with the mailbox.
StartMailboxExportJobRequest.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.
StartMailboxExportJobRequest.Builder	organizationId(String organizationId) The identifier associated with the organization.
StartMailboxExportJobRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.
StartMailboxExportJobRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.
StartMailboxExportJobRequest.Builder	roleArn(String roleArn) The ARN of the AWS Identity and Access Management (IAM) role that grants write permission to the S3 bucket.
StartMailboxExportJobRequest.Builder	s3BucketName(String s3BucketName) The name of the S3 bucket.
StartMailboxExportJobRequest.Builder	s3Prefix(String s3Prefix) The S3 bucket prefix.

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

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

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

clientToken

StartMailboxExportJobRequest.Builder clientToken(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.

organizationId

StartMailboxExportJobRequest.Builder organizationId(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.

entityId

StartMailboxExportJobRequest.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

StartMailboxExportJobRequest.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

StartMailboxExportJobRequest.Builder roleArn(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.

kmsKeyArn

StartMailboxExportJobRequest.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

StartMailboxExportJobRequest.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

StartMailboxExportJobRequest.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.

overrideConfiguration

StartMailboxExportJobRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

StartMailboxExportJobRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.