Class AutoTuneOptions

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

Auto-Tune settings when updating a domain. 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:

    • rollbackOnDisable

      public final RollbackOnDisable rollbackOnDisable()

      When disabling Auto-Tune, specify NO_ROLLBACK to retain all prior Auto-Tune settings or DEFAULT_ROLLBACK to revert to the OpenSearch Service defaults. If you specify DEFAULT_ROLLBACK, you must include a MaintenanceSchedule in the request. Otherwise, OpenSearch Service is unable to perform the rollback.

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

      Returns:
      When disabling Auto-Tune, specify NO_ROLLBACK to retain all prior Auto-Tune settings or DEFAULT_ROLLBACK to revert to the OpenSearch Service defaults. If you specify DEFAULT_ROLLBACK, you must include a MaintenanceSchedule in the request. Otherwise, OpenSearch Service is unable to perform the rollback.
      See Also:

    • rollbackOnDisableAsString

      public final String rollbackOnDisableAsString()

      When disabling Auto-Tune, specify NO_ROLLBACK to retain all prior Auto-Tune settings or DEFAULT_ROLLBACK to revert to the OpenSearch Service defaults. If you specify DEFAULT_ROLLBACK, you must include a MaintenanceSchedule in the request. Otherwise, OpenSearch Service is unable to perform the rollback.

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

      Returns:
      When disabling Auto-Tune, specify NO_ROLLBACK to retain all prior Auto-Tune settings or DEFAULT_ROLLBACK to revert to the OpenSearch Service defaults. If you specify DEFAULT_ROLLBACK, you must include a MaintenanceSchedule in the request. Otherwise, OpenSearch Service is unable to perform the rollback.
      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()

      DEPRECATED. Use off-peak window instead.

      A list of maintenance schedules during which Auto-Tune can deploy changes.

      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:
      DEPRECATED. Use off-peak window instead.

      A list of maintenance schedules during which Auto-Tune can deploy changes.

    • useOffPeakWindow

      public final Boolean useOffPeakWindow()

      Whether to use the domain's off-peak window to deploy configuration changes on the domain rather than a maintenance schedule.

      Returns:
      Whether to use the domain's off-peak window to deploy configuration changes on the domain rather than a maintenance schedule.

    • toBuilder

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

    • builder

      public static AutoTuneOptions.Builder builder()

    • serializableBuilderClass

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