Class MailboxExportJob

java.lang.Object
software.amazon.awssdk.services.workmail.model.MailboxExportJob
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<MailboxExportJob.Builder,MailboxExportJob>
@Generated("software.amazon.awssdk:codegen") public final class MailboxExportJob extends Object implements SdkPojo, Serializable, ToCopyableBuilder<MailboxExportJob.Builder,MailboxExportJob>

The details of a mailbox export job, including the user or resource ID associated with the mailbox and the S3 bucket that the mailbox contents are exported to.

See Also:

  • Method Details

    • jobId

      public final String jobId()

      The identifier of the mailbox export job.

      Returns:
      The identifier of the mailbox export job.

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

    • s3BucketName

      public final String s3BucketName()

      The name of the S3 bucket.

      Returns:
      The name of the S3 bucket.

    • s3Path

      public final String s3Path()

      The path to the S3 bucket and file that the mailbox export job exports to.

      Returns:
      The path to the S3 bucket and file that the mailbox export job exports 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:

    • 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 MailboxExportJob.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<MailboxExportJob.Builder,MailboxExportJob>
      Returns:
      a builder for type T

    • builder

      public static MailboxExportJob.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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)

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