Package software.amazon.awssdk.services.opensearch.model

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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	AutoTuneOptions.Builder

Method Summary

Modifier and Type	Method	Description
static AutoTuneOptions.Builder	builder()
AutoTuneDesiredState	desiredState()	Whether Auto-Tune is enabled or disabled.
String	desiredStateAsString()	Whether Auto-Tune is enabled or disabled.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasMaintenanceSchedules()	For responses, this returns true if the service returned a value for the MaintenanceSchedules property.
List<AutoTuneMaintenanceSchedule>	maintenanceSchedules()	DEPRECATED.
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.
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.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends AutoTuneOptions.Builder>	serializableBuilderClass()
AutoTuneOptions.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
Boolean	useOffPeakWindow()	Whether to use the domain's off-peak window to deploy configuration changes on the domain rather than a maintenance schedule.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

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:

AutoTuneDesiredState

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:

AutoTuneDesiredState

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:

RollbackOnDisable

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:

RollbackOnDisable

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()

Specified by:

toBuilder in interface ToCopyableBuilder<AutoTuneOptions.Builder,AutoTuneOptions>

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo