Package software.amazon.awssdk.services.workmail.model

Class StartMailboxExportJobRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.workmail.model.WorkMailRequest

software.amazon.awssdk.services.workmail.model.StartMailboxExportJobRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<StartMailboxExportJobRequest.Builder,StartMailboxExportJobRequest>

@Generated("software.amazon.awssdk:codegen")
public final class StartMailboxExportJobRequest
extends WorkMailRequest
implements ToCopyableBuilder<StartMailboxExportJobRequest.Builder,StartMailboxExportJobRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	StartMailboxExportJobRequest.Builder

Method Summary

Modifier and Type	Method	Description
static StartMailboxExportJobRequest.Builder	builder()
String	clientToken()	The idempotency token for the client request.
String	description()	The mailbox export job description.
String	entityId()	The identifier of the user or resource associated with the mailbox.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	kmsKeyArn()	The Amazon Resource Name (ARN) of the symmetric AWS Key Management Service (AWS KMS) key that encrypts the exported mailbox content.
String	organizationId()	The identifier associated with the organization.
String	roleArn()	The ARN of the AWS Identity and Access Management (IAM) role that grants write permission to the S3 bucket.
String	s3BucketName()	The name of the S3 bucket.
String	s3Prefix()	The S3 bucket prefix.
List<SdkField<?>>	sdkFields()
static Class<? extends StartMailboxExportJobRequest.Builder>	serializableBuilderClass()
StartMailboxExportJobRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

clientToken

public final String clientToken()

The idempotency token for the client request.

Returns:

The idempotency token for the client request.

organizationId

public final String organizationId()

The identifier associated with the organization.

Returns:

The identifier associated with the organization.

entityId

public final String entityId()

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

The identifier can accept UserId or ResourceId, Username or Resourcename, or email. The following identity formats are available:

• Entity ID: 12345678-1234-1234-1234-123456789012, r-0123456789a0123456789b0123456789 , or S-1-1-12-1234567890-123456789-123456789-1234

• Email address: entity@domain.tld

• Entity name: entity

Returns:

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

The identifier can accept UserId or ResourceId, Username or Resourcename, or email. The following identity formats are available:

• Entity ID: 12345678-1234-1234-1234-123456789012, r-0123456789a0123456789b0123456789 , or S-1-1-12-1234567890-123456789-123456789-1234

• Email address: entity@domain.tld

• Entity name: entity

description

public final String description()

The mailbox export job description.

Returns:

The mailbox export job description.

roleArn

public final String roleArn()

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.

kmsKeyArn

public final String kmsKeyArn()

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.

s3BucketName

public final String s3BucketName()

The name of the S3 bucket.

Returns:

The name of the S3 bucket.

s3Prefix

public final String s3Prefix()

The S3 bucket prefix.

Returns:

The S3 bucket prefix.

toBuilder

public StartMailboxExportJobRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<StartMailboxExportJobRequest.Builder,StartMailboxExportJobRequest>

Specified by:

toBuilder in class WorkMailRequest

builder

public static StartMailboxExportJobRequest.Builder builder()

serializableBuilderClass

public static Class<? extends StartMailboxExportJobRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo