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

Class FolderConfiguration

java.lang.Object

software.amazon.awssdk.services.workmail.model.FolderConfiguration

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<FolderConfiguration.Builder,FolderConfiguration>

@Generated("software.amazon.awssdk:codegen")
public final class FolderConfiguration
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<FolderConfiguration.Builder,FolderConfiguration>

The configuration applied to an organization's folders by its retention policy.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	FolderConfiguration.Builder

Method Summary

Modifier and Type	Method	Description
RetentionAction	action()	The action to take on the folder contents at the end of the folder configuration period.
String	actionAsString()	The action to take on the folder contents at the end of the folder configuration period.
static FolderConfiguration.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
FolderName	name()	The folder name.
String	nameAsString()	The folder name.
Integer	period()	The number of days for which the folder-configuration action applies.
List<SdkField<?>>	sdkFields()
static Class<? extends FolderConfiguration.Builder>	serializableBuilderClass()
FolderConfiguration.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

name

public final FolderName name()

The folder name.

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

Returns:

The folder name.

See Also:

FolderName

nameAsString

public final String nameAsString()

The folder name.

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

Returns:

The folder name.

See Also:

FolderName

action

public final RetentionAction action()

The action to take on the folder contents at the end of the folder configuration period.

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

Returns:

The action to take on the folder contents at the end of the folder configuration period.

See Also:

RetentionAction

actionAsString

public final String actionAsString()

The action to take on the folder contents at the end of the folder configuration period.

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

Returns:

The action to take on the folder contents at the end of the folder configuration period.

See Also:

RetentionAction

period

public final Integer period()

The number of days for which the folder-configuration action applies.

Returns:

The number of days for which the folder-configuration action applies.

toBuilder

public FolderConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<FolderConfiguration.Builder,FolderConfiguration>

builder

public static FolderConfiguration.Builder builder()

serializableBuilderClass

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

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)

sdkFields

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

Specified by:

sdkFields in interface SdkPojo