Class AutoTuneOptionsInput

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

Options for configuring Auto-Tune. For more information, see Auto-Tune for Amazon OpenSearch Service

See Also:

  • Method Details

    • desiredState

      public final AutoTuneDesiredState desiredState()

      Whether Auto-Tune is enabled or disabled.

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

      Returns:
      Whether Auto-Tune is enabled or disabled.
      See Also:

    • desiredStateAsString

      public final String desiredStateAsString()

      Whether Auto-Tune is enabled or disabled.

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

      Returns:
      Whether Auto-Tune is enabled or disabled.
      See Also:

    • hasMaintenanceSchedules

      public final boolean hasMaintenanceSchedules()
      For responses, this returns true if the service returned a value for the MaintenanceSchedules property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • maintenanceSchedules

      public final List<AutoTuneMaintenanceSchedule> maintenanceSchedules()

      A list of maintenance schedules during which Auto-Tune can deploy changes. Maintenance windows are deprecated and have been replaced with off-peak windows.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasMaintenanceSchedules() method.

      Returns:
      A list of maintenance schedules during which Auto-Tune can deploy changes. Maintenance windows are deprecated and have been replaced with off-peak windows.

    • useOffPeakWindow

      public final Boolean useOffPeakWindow()

      Whether to schedule Auto-Tune optimizations that require blue/green deployments during the domain's configured daily off-peak window.

      Returns:
      Whether to schedule Auto-Tune optimizations that require blue/green deployments during the domain's configured daily off-peak window.

    • toBuilder

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

    • builder

      public static AutoTuneOptionsInput.Builder builder()

    • serializableBuilderClass

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