Class PITPolicyRule

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

A rule in the Point in Time (PIT) policy representing when to take snapshots and how long to retain them for.

See Also:

  • Method Details

    • enabled

      public final Boolean enabled()

      Whether this rule is enabled or not.

      Returns:
      Whether this rule is enabled or not.

    • interval

      public final Integer interval()

      How often, in the chosen units, a snapshot should be taken.

      Returns:
      How often, in the chosen units, a snapshot should be taken.

    • retentionDuration

      public final Integer retentionDuration()

      The duration to retain a snapshot for, in the chosen units.

      Returns:
      The duration to retain a snapshot for, in the chosen units.

    • ruleID

      public final Long ruleID()

      The ID of the rule.

      Returns:
      The ID of the rule.

    • units

      public final PITPolicyRuleUnits units()

      The units used to measure the interval and retentionDuration.

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

      Returns:
      The units used to measure the interval and retentionDuration.
      See Also:

    • unitsAsString

      public final String unitsAsString()

      The units used to measure the interval and retentionDuration.

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

      Returns:
      The units used to measure the interval and retentionDuration.
      See Also:

    • toBuilder

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

    • builder

      public static PITPolicyRule.Builder builder()

    • serializableBuilderClass

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