Class Archive

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

An archive resource for storing and retaining emails.

See Also:

  • Method Details

    • archiveId

      public final String archiveId()

      The unique identifier of the archive.

      Returns:
      The unique identifier of the archive.

    • archiveName

      public final String archiveName()

      The unique name assigned to the archive.

      Returns:
      The unique name assigned to the archive.

    • archiveState

      public final ArchiveState archiveState()

      The current state of the archive:

      • ACTIVE – The archive is ready and available for use.

      • PENDING_DELETION – The archive has been marked for deletion and will be permanently deleted in 30 days. No further modifications can be made in this state.

      If the service returns an enum value that is not available in the current SDK version, archiveState will return ArchiveState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from archiveStateAsString().

      Returns:
      The current state of the archive:

      • ACTIVE – The archive is ready and available for use.

      • PENDING_DELETION – The archive has been marked for deletion and will be permanently deleted in 30 days. No further modifications can be made in this state.

      See Also:

    • archiveStateAsString

      public final String archiveStateAsString()

      The current state of the archive:

      • ACTIVE – The archive is ready and available for use.

      • PENDING_DELETION – The archive has been marked for deletion and will be permanently deleted in 30 days. No further modifications can be made in this state.

      If the service returns an enum value that is not available in the current SDK version, archiveState will return ArchiveState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from archiveStateAsString().

      Returns:
      The current state of the archive:

      • ACTIVE – The archive is ready and available for use.

      • PENDING_DELETION – The archive has been marked for deletion and will be permanently deleted in 30 days. No further modifications can be made in this state.

      See Also:

    • lastUpdatedTimestamp

      public final Instant lastUpdatedTimestamp()

      The timestamp of when the archive was last updated.

      Returns:
      The timestamp of when the archive was last updated.

    • toBuilder

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

    • builder

      public static Archive.Builder builder()

    • serializableBuilderClass

      public static Class<? extends Archive.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.