Class DescribeMailboxExportJobResponse
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<DescribeMailboxExportJobResponse.Builder,
DescribeMailboxExportJobResponse>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final String
The mailbox export job description.final Instant
endTime()
The mailbox export job end timestamp.final String
entityId()
The identifier of the user or resource associated with the mailbox.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final String
Error information for failed mailbox export jobs.final Integer
The estimated progress of the mailbox export job, in percentage points.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkResponse
.final int
hashCode()
final String
The Amazon Resource Name (ARN) of the symmetric AWS Key Management Service (AWS KMS) key that encrypts the exported mailbox content.final 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.final String
The name of the S3 bucket.final String
s3Path()
The path to the S3 bucket and file that the mailbox export job is exporting to.final String
s3Prefix()
The S3 bucket prefix.static Class
<? extends DescribeMailboxExportJobResponse.Builder> final Instant
The mailbox export job start timestamp.final MailboxExportJobState
state()
The state of the mailbox export job.final String
The state of the mailbox export job.Take this object and create a builder that contains all of the current property values of this object.final 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 interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
The mailbox export job description.
- Returns:
- The mailbox export job description.
-
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
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
The name of the S3 bucket.
- Returns:
- The name of the S3 bucket.
-
s3Prefix
The S3 bucket prefix.
- Returns:
- The S3 bucket prefix.
-
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
The estimated progress of the mailbox export job, in percentage points.
- Returns:
- The estimated progress of the mailbox export job, in percentage points.
-
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 returnMailboxExportJobState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstateAsString()
.- Returns:
- The state of the mailbox export job.
- See Also:
-
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 returnMailboxExportJobState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstateAsString()
.- Returns:
- The state of the mailbox export job.
- See Also:
-
errorInfo
Error information for failed mailbox export jobs.
- Returns:
- Error information for failed mailbox export jobs.
-
startTime
The mailbox export job start timestamp.
- Returns:
- The mailbox export job start timestamp.
-
endTime
The mailbox export job end timestamp.
- Returns:
- The mailbox export job end timestamp.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<DescribeMailboxExportJobResponse.Builder,
DescribeMailboxExportJobResponse> - Specified by:
toBuilder
in classAwsResponse
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsResponse
-
equals
- Overrides:
equals
in classAwsResponse
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkResponse
Used to retrieve the value of a field from any class that extendsSdkResponse
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkResponse.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkResponse
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-