Package software.amazon.awssdk.services.mailmanager.model

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.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GetArchiveResponse.Builder

Method Summary

Modifier and Type	Method	Description
String	archiveArn()	The Amazon Resource Name (ARN) of the archive.
String	archiveId()	The unique identifier of the archive.
String	archiveName()	The unique name assigned to the archive.
ArchiveState	archiveState()	The current state of the archive:
String	archiveStateAsString()	The current state of the archive:
static GetArchiveResponse.Builder	builder()
Instant	createdTimestamp()	The timestamp of when the archive was created.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	kmsKeyArn()	The Amazon Resource Name (ARN) of the KMS key used to encrypt the archive.
Instant	lastUpdatedTimestamp()	The timestamp of when the archive was modified.
ArchiveRetention	retention()	The retention period for emails in this archive.
List<SdkField<?>>	sdkFields()
static Class<? extends GetArchiveResponse.Builder>	serializableBuilderClass()
GetArchiveResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.mailmanager.model.MailManagerResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

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:

ArchiveState

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:

ArchiveState

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

Specified by:

toBuilder in interface ToCopyableBuilder<GetArchiveResponse.Builder,GetArchiveResponse>

Specified by:

toBuilder in class AwsResponse

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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)

Overrides:

getValueForField in class SdkResponse

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo