DescribeMailboxExportJobResponse (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.core.SdkResponse
- - software.amazon.awssdk.awscore.AwsResponse
  - - software.amazon.awssdk.services.workmail.model.WorkMailResponse
    - - software.amazon.awssdk.services.workmail.model.DescribeMailboxExportJobResponse

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<DescribeMailboxExportJobResponse.Builder,DescribeMailboxExportJobResponse>

@Generated(value="software.amazon.awssdk:codegen")
public final class DescribeMailboxExportJobResponse
extends WorkMailResponse
implements ToCopyableBuilder<DescribeMailboxExportJobResponse.Builder,DescribeMailboxExportJobResponse>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface DescribeMailboxExportJobResponse.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`DescribeMailboxExportJobResponse.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static DescribeMailboxExportJobResponse.Builder`	`builder()`
`String`	`description()` The mailbox export job description.
`Instant`	`endTime()` The mailbox export job end timestamp.
`String`	`entityId()` The identifier of the user or resource associated with the mailbox.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`String`	`errorInfo()` Error information for failed mailbox export jobs.
`Integer`	`estimatedProgress()` The estimated progress of the mailbox export job, in percentage points.
`<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`	`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.
`String`	`s3BucketName()` The name of the S3 bucket.
`String`	`s3Path()` The path to the S3 bucket and file that the mailbox export job is exporting to.
`String`	`s3Prefix()` The S3 bucket prefix.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends DescribeMailboxExportJobResponse.Builder>`	`serializableBuilderClass()`
`Instant`	`startTime()` The mailbox export job start timestamp.
`MailboxExportJobState`	`state()` The state of the mailbox export job.
`String`	`stateAsString()` The state of the mailbox export job.
`DescribeMailboxExportJobResponse.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.workmail.model.WorkMailResponse
responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse

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
  - entityId
```
public String entityId()
```
    The identifier of the user or resource associated with the mailbox.
    
    Returns:
    
    The identifier of the user or resource associated with the mailbox.
  - description
```
public String description()
```
    The mailbox export job description.
    
    Returns:
    
    The mailbox export job description.
  - roleArn
```
public 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.
    
    Returns:
    
    The ARN of the AWS Identity and Access Management (IAM) role that grants write permission to the Amazon Simple Storage Service (Amazon S3) bucket.
  - kmsKeyArn
```
public 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 String s3BucketName()
```
    The name of the S3 bucket.
    
    Returns:
    
    The name of the S3 bucket.
  - s3Prefix
```
public String s3Prefix()
```
    The S3 bucket prefix.
    
    Returns:
    
    The S3 bucket prefix.
  - s3Path
```
public String s3Path()
```
    The path to the S3 bucket and file that the mailbox export job is exporting to.
    
    Returns:
    
    The path to the S3 bucket and file that the mailbox export job is exporting to.
  - estimatedProgress
```
public Integer estimatedProgress()
```
    The estimated progress of the mailbox export job, in percentage points.
    
    Returns:
    
    The estimated progress of the mailbox export job, in percentage points.
  - state
```
public MailboxExportJobState state()
```
    The state of the mailbox export job.
    
    If the service returns an enum value that is not available in the current SDK version, state will return MailboxExportJobState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().
    
    Returns:
    
    The state of the mailbox export job.
    
    See Also:
    
    MailboxExportJobState
  - stateAsString
```
public String stateAsString()
```
    The state of the mailbox export job.
    
    If the service returns an enum value that is not available in the current SDK version, state will return MailboxExportJobState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().
    
    Returns:
    
    The state of the mailbox export job.
    
    See Also:
    
    MailboxExportJobState
  - errorInfo
```
public String errorInfo()
```
    Error information for failed mailbox export jobs.
    
    Returns:
    
    Error information for failed mailbox export jobs.
  - startTime
```
public Instant startTime()
```
    The mailbox export job start timestamp.
    
    Returns:
    
    The mailbox export job start timestamp.
  - endTime
```
public Instant endTime()
```
    The mailbox export job end timestamp.
    
    Returns:
    
    The mailbox export job end timestamp.
  - toBuilder
```
public DescribeMailboxExportJobResponse.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<DescribeMailboxExportJobResponse.Builder,DescribeMailboxExportJobResponse>
    
    Overrides:
    
    toBuilder in class AwsResponse
  - builder
```
public static DescribeMailboxExportJobResponse.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends DescribeMailboxExportJobResponse.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class AwsResponse
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsResponse
  - equalsBySdkFields
```
public boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkResponse
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class DescribeMailboxExportJobResponse

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.services.workmail.model.WorkMailResponse

Methods inherited from class software.amazon.awssdk.core.SdkResponse

Methods inherited from class java.lang.Object

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

Method Detail

entityId

description

roleArn

kmsKeyArn

s3BucketName

s3Prefix

s3Path

estimatedProgress

state

stateAsString

errorInfo

startTime

endTime

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields