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:

  • Method Details

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

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

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

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

    • 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()
      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<FolderConfiguration.Builder,FolderConfiguration>
      Returns:
      a builder for type T

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

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