Class DescribeMailboxExportJobResponse

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("software.amazon.awssdk:codegen") public final class DescribeMailboxExportJobResponse extends WorkMailResponse implements ToCopyableBuilder<DescribeMailboxExportJobResponse.Builder,DescribeMailboxExportJobResponse>

  • Method Details

    • entityId

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

    • s3Path

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

    • stateAsString

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

    • errorInfo

      public final String errorInfo()

      Error information for failed mailbox export jobs.

      Returns:
      Error information for failed mailbox export jobs.

    • startTime

      public final Instant startTime()

      The mailbox export job start timestamp.

      Returns:
      The mailbox export job start timestamp.

    • endTime

      public final Instant endTime()

      The mailbox export job end timestamp.

      Returns:
      The mailbox export job end timestamp.

    • toBuilder

      public DescribeMailboxExportJobResponse.Builder 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 interface ToCopyableBuilder<DescribeMailboxExportJobResponse.Builder,DescribeMailboxExportJobResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static DescribeMailboxExportJobResponse.Builder builder()

    • serializableBuilderClass

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

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsResponse

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsResponse

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. 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, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      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

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.