software.amazon.awssdk.services.opensearch.model

Class AutoTuneOptionsInput

java.lang.Object

software.amazon.awssdk.services.opensearch.model.AutoTuneOptionsInput

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<AutoTuneOptionsInput.Builder,AutoTuneOptionsInput>

@Generated(value="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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AutoTuneOptionsInput.Builder

Method Summary

Modifier and Type	Method and Description
static AutoTuneOptionsInput.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() A list of maintenance schedules during which Auto-Tune can deploy changes.
List<SdkField<?>>	sdkFields()
static Class<? extends AutoTuneOptionsInput.Builder>	serializableBuilderClass()
AutoTuneOptionsInput.Builder	toBuilder()
String	toString() Returns a string representation of this object.

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

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 schedules are overwrite, not append. If your request includes no schedules, the request deletes all existing schedules. To preserve existing schedules, make a call to DescribeDomainConfig first and use the MaintenanceSchedules portion of the response as the basis for this section.

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 schedules are overwrite, not append. If your request includes no schedules, the request deletes all existing schedules. To preserve existing schedules, make a call to DescribeDomainConfig first and use the MaintenanceSchedules portion of the response as the basis for this section.

toBuilder

public AutoTuneOptionsInput.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AutoTuneOptionsInput.Builder,AutoTuneOptionsInput>

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)

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