Class AutomatedSnapshotPauseOptions

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

Specifies the automated snapshot pause options for the domain. These options allow you to temporarily pause automated snapshots for a specified time period.

See Also:

  • Method Details

    • enabled

      public final Boolean enabled()

      Whether automated snapshot pause is enabled for the domain.

      Returns:
      Whether automated snapshot pause is enabled for the domain.

    • startTime

      public final Instant startTime()

      The timestamp at which the automated snapshot pause begins.

      Returns:
      The timestamp at which the automated snapshot pause begins.

    • endTime

      public final Instant endTime()

      The timestamp at which the automated snapshot pause ends.

      Returns:
      The timestamp at which the automated snapshot pause ends.

    • state

      public final PauseState state()

      The current state of the automated snapshot pause. Valid values are Active, Completed, Scheduled, and Disabled.

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

      Returns:
      The current state of the automated snapshot pause. Valid values are Active, Completed, Scheduled, and Disabled.
      See Also:

    • stateAsString

      public final String stateAsString()

      The current state of the automated snapshot pause. Valid values are Active, Completed, Scheduled, and Disabled.

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

      Returns:
      The current state of the automated snapshot pause. Valid values are Active, Completed, Scheduled, and Disabled.
      See Also:

    • toBuilder

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

    • builder

      public static AutomatedSnapshotPauseOptions.Builder builder()

    • serializableBuilderClass

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