Package software.amazon.awssdk.services.workmail.model

Class PutRetentionPolicyRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.workmail.model.WorkMailRequest

software.amazon.awssdk.services.workmail.model.PutRetentionPolicyRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<PutRetentionPolicyRequest.Builder,PutRetentionPolicyRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	PutRetentionPolicyRequest.Builder

Method Summary

Modifier and Type	Method	Description
static PutRetentionPolicyRequest.Builder	builder()
String	description()	The retention policy description.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<FolderConfiguration>	folderConfigurations()	The retention policy folder configurations.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasFolderConfigurations()	For responses, this returns true if the service returned a value for the FolderConfigurations property.
int	hashCode()
String	id()	The retention policy ID.
String	name()	The retention policy name.
String	organizationId()	The organization ID.
List<SdkField<?>>	sdkFields()
static Class<? extends PutRetentionPolicyRequest.Builder>	serializableBuilderClass()
PutRetentionPolicyRequest.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

organizationId

public final String organizationId()

The organization ID.

Returns:

The organization ID.

id

public final String id()

The retention policy ID.

Returns:

The retention policy ID.

name

public final String name()

The retention policy name.

Returns:

The retention policy name.

description

public final String description()

The retention policy description.

Returns:

The retention policy description.

hasFolderConfigurations

public final boolean hasFolderConfigurations()

For responses, this returns true if the service returned a value for the FolderConfigurations 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.

folderConfigurations

public final List<FolderConfiguration> folderConfigurations()

The retention policy folder configurations.

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 hasFolderConfigurations() method.

Returns:

The retention policy folder configurations.

toBuilder

public PutRetentionPolicyRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<PutRetentionPolicyRequest.Builder,PutRetentionPolicyRequest>

Specified by:

toBuilder in class WorkMailRequest

builder

public static PutRetentionPolicyRequest.Builder builder()

serializableBuilderClass

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