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

Class CreateArchiveRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.mailmanager.model.MailManagerRequest

software.amazon.awssdk.services.mailmanager.model.CreateArchiveRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateArchiveRequest.Builder,CreateArchiveRequest>

@Generated("software.amazon.awssdk:codegen")
public final class CreateArchiveRequest
extends MailManagerRequest
implements ToCopyableBuilder<CreateArchiveRequest.Builder,CreateArchiveRequest>

The request to create a new email archive.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateArchiveRequest.Builder

Method Summary

Modifier and Type	Method	Description
String	archiveName()	A unique name for the new archive.
static CreateArchiveRequest.Builder	builder()
String	clientToken()	A unique token Amazon SES uses to recognize retries of this request.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags()	For responses, this returns true if the service returned a value for the Tags property.
String	kmsKeyArn()	The Amazon Resource Name (ARN) of the KMS key for encrypting emails in the archive.
ArchiveRetention	retention()	The period for retaining emails in the archive before automatic deletion.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateArchiveRequest.Builder>	serializableBuilderClass()
List<Tag>	tags()	The tags used to organize, track, or control access for the resource.
CreateArchiveRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

archiveName

public final String archiveName()

A unique name for the new archive.

Returns:

A unique name for the new archive.

clientToken

public final String clientToken()

A unique token Amazon SES uses to recognize retries of this request.

Returns:

A unique token Amazon SES uses to recognize retries of this request.

kmsKeyArn

public final String kmsKeyArn()

The Amazon Resource Name (ARN) of the KMS key for encrypting emails in the archive.

Returns:

The Amazon Resource Name (ARN) of the KMS key for encrypting emails in the archive.

retention

public final ArchiveRetention retention()

The period for retaining emails in the archive before automatic deletion.

Returns:

The period for retaining emails in the archive before automatic deletion.

hasTags

public final boolean hasTags()

For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

tags

public final List<Tag> tags()

The tags used to organize, track, or control access for the resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

Returns:

The tags used to organize, track, or control access for the resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.

toBuilder

public CreateArchiveRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateArchiveRequest.Builder,CreateArchiveRequest>

Specified by:

toBuilder in class MailManagerRequest

builder

public static CreateArchiveRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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 SdkRequest

sdkFields

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

Specified by:

sdkFields in interface SdkPojo