Class OffPeakWindowOptions

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

Options for a domain's off-peak window, during which OpenSearch Service can perform mandatory configuration changes on the domain.

See Also:

  • Method Details

    • enabled

      public final Boolean enabled()

      Whether to enable an off-peak window.

      This option is only available when modifying a domain created prior to February 16, 2023, not when creating a new domain. All domains created after this date have the off-peak window enabled by default. You can't disable the off-peak window after it's enabled for a domain.

      Returns:
      Whether to enable an off-peak window.

      This option is only available when modifying a domain created prior to February 16, 2023, not when creating a new domain. All domains created after this date have the off-peak window enabled by default. You can't disable the off-peak window after it's enabled for a domain.

    • offPeakWindow

      public final OffPeakWindow offPeakWindow()

      Off-peak window settings for the domain.

      Returns:
      Off-peak window settings for the domain.

    • toBuilder

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

    • builder

      public static OffPeakWindowOptions.Builder builder()

    • serializableBuilderClass

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