Class LifecyclePolicy

java.lang.Object
software.amazon.awssdk.services.efs.model.LifecyclePolicy
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<LifecyclePolicy.Builder,LifecyclePolicy>
@Generated("software.amazon.awssdk:codegen") public final class LifecyclePolicy extends Object implements SdkPojo, Serializable, ToCopyableBuilder<LifecyclePolicy.Builder,LifecyclePolicy>

Describes a policy used by lifecycle management that specifies when to transition files into and out of storage classes. For more information, see Managing file system storage.

When using the put-lifecycle-configuration CLI command or the PutLifecycleConfiguration API action, Amazon EFS requires that each LifecyclePolicy object have only a single transition. This means that in a request body, LifecyclePolicies must be structured as an array of LifecyclePolicy objects, one object for each transition. For more information, see the request examples in PutLifecycleConfiguration.

See Also:

  • Method Details

    • transitionToIA

      public final TransitionToIARules transitionToIA()

      The number of days after files were last accessed in primary storage (the Standard storage class) at which to move them to Infrequent Access (IA) storage. Metadata operations such as listing the contents of a directory don't count as file access events.

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

      Returns:
      The number of days after files were last accessed in primary storage (the Standard storage class) at which to move them to Infrequent Access (IA) storage. Metadata operations such as listing the contents of a directory don't count as file access events.
      See Also:

    • transitionToIAAsString

      public final String transitionToIAAsString()

      The number of days after files were last accessed in primary storage (the Standard storage class) at which to move them to Infrequent Access (IA) storage. Metadata operations such as listing the contents of a directory don't count as file access events.

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

      Returns:
      The number of days after files were last accessed in primary storage (the Standard storage class) at which to move them to Infrequent Access (IA) storage. Metadata operations such as listing the contents of a directory don't count as file access events.
      See Also:

    • transitionToPrimaryStorageClass

      public final TransitionToPrimaryStorageClassRules transitionToPrimaryStorageClass()

      Whether to move files back to primary (Standard) storage after they are accessed in IA or Archive storage. Metadata operations such as listing the contents of a directory don't count as file access events.

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

      Returns:
      Whether to move files back to primary (Standard) storage after they are accessed in IA or Archive storage. Metadata operations such as listing the contents of a directory don't count as file access events.
      See Also:

    • transitionToPrimaryStorageClassAsString

      public final String transitionToPrimaryStorageClassAsString()

      Whether to move files back to primary (Standard) storage after they are accessed in IA or Archive storage. Metadata operations such as listing the contents of a directory don't count as file access events.

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

      Returns:
      Whether to move files back to primary (Standard) storage after they are accessed in IA or Archive storage. Metadata operations such as listing the contents of a directory don't count as file access events.
      See Also:

    • transitionToArchive

      public final TransitionToArchiveRules transitionToArchive()

      The number of days after files were last accessed in primary storage (the Standard storage class) at which to move them to Archive storage. Metadata operations such as listing the contents of a directory don't count as file access events.

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

      Returns:
      The number of days after files were last accessed in primary storage (the Standard storage class) at which to move them to Archive storage. Metadata operations such as listing the contents of a directory don't count as file access events.
      See Also:

    • transitionToArchiveAsString

      public final String transitionToArchiveAsString()

      The number of days after files were last accessed in primary storage (the Standard storage class) at which to move them to Archive storage. Metadata operations such as listing the contents of a directory don't count as file access events.

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

      Returns:
      The number of days after files were last accessed in primary storage (the Standard storage class) at which to move them to Archive storage. Metadata operations such as listing the contents of a directory don't count as file access events.
      See Also:

    • toBuilder

      public LifecyclePolicy.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<LifecyclePolicy.Builder,LifecyclePolicy>
      Returns:
      a builder for type T

    • builder

      public static LifecyclePolicy.Builder builder()

    • serializableBuilderClass

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