Class AutomatedSnapshotPauseRequestOptions

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

Specifies the automated snapshot pause request options for the domain.

Suspending snapshots reduces data protection. You cannot restore your domain to points in time when snapshots are suspended. Use this feature only for short-term operational needs such as migrations or maintenance windows.

Maximum suspension duration: 3 days.

See Also:

  • Method Details

    • enabled

      public final Boolean enabled()

      Whether to enable or disable automated snapshot pause for the domain.

      Returns:
      Whether to enable or disable automated snapshot pause for the domain.

    • startTime

      public final Instant startTime()

      The timestamp at which the automated snapshot pause should begin.

      Returns:
      The timestamp at which the automated snapshot pause should begin.

    • endTime

      public final Instant endTime()

      The timestamp at which the automated snapshot pause should end. The maximum allowed duration between StartTime and EndTime is 3 days.

      Returns:
      The timestamp at which the automated snapshot pause should end. The maximum allowed duration between StartTime and EndTime is 3 days.

    • toBuilder

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

    • builder

      public static AutomatedSnapshotPauseRequestOptions.Builder builder()

    • serializableBuilderClass

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