Class GetArchiveResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.mailmanager.model.MailManagerResponse
software.amazon.awssdk.services.mailmanager.model.GetArchiveResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetArchiveResponse.Builder,GetArchiveResponse>
@Generated("software.amazon.awssdk:codegen") public final class GetArchiveResponse extends MailManagerResponse implements ToCopyableBuilder<GetArchiveResponse.Builder,GetArchiveResponse>

The response containing details of the requested archive.

  • Method Details

    • archiveArn

      public final String archiveArn()

      The Amazon Resource Name (ARN) of the archive.

      Returns:
      The Amazon Resource Name (ARN) of the archive.

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

    • createdTimestamp

      public final Instant createdTimestamp()

      The timestamp of when the archive was created.

      Returns:
      The timestamp of when the archive was created.

    • kmsKeyArn

      public final String kmsKeyArn()

      The Amazon Resource Name (ARN) of the KMS key used to encrypt the archive.

      Returns:
      The Amazon Resource Name (ARN) of the KMS key used to encrypt the archive.

    • lastUpdatedTimestamp

      public final Instant lastUpdatedTimestamp()

      The timestamp of when the archive was modified.

      Returns:
      The timestamp of when the archive was modified.

    • retention

      public final ArchiveRetention retention()

      The retention period for emails in this archive.

      Returns:
      The retention period for emails in this archive.

    • toBuilder

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

    • builder

      public static GetArchiveResponse.Builder builder()

    • serializableBuilderClass

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