Class AutoTuneOptions
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<AutoTuneOptions.Builder,
AutoTuneOptions>
Auto-Tune settings when updating a domain. For more information, see Auto-Tune for Amazon OpenSearch Service.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic AutoTuneOptions.Builder
builder()
final AutoTuneDesiredState
Whether Auto-Tune is enabled or disabled.final String
Whether Auto-Tune is enabled or disabled.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the MaintenanceSchedules property.final List
<AutoTuneMaintenanceSchedule> DEPRECATED.final RollbackOnDisable
When disabling Auto-Tune, specifyNO_ROLLBACK
to retain all prior Auto-Tune settings orDEFAULT_ROLLBACK
to revert to the OpenSearch Service defaults.final String
When disabling Auto-Tune, specifyNO_ROLLBACK
to retain all prior Auto-Tune settings orDEFAULT_ROLLBACK
to revert to the OpenSearch Service defaults.static Class
<? extends AutoTuneOptions.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final Boolean
Whether to use the domain's off-peak window to deploy configuration changes on the domain rather than a maintenance schedule.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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 returnAutoTuneDesiredState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromdesiredStateAsString()
.- Returns:
- Whether Auto-Tune is enabled or disabled.
- See Also:
-
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 returnAutoTuneDesiredState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromdesiredStateAsString()
.- Returns:
- Whether Auto-Tune is enabled or disabled.
- See Also:
-
rollbackOnDisable
When disabling Auto-Tune, specify
NO_ROLLBACK
to retain all prior Auto-Tune settings orDEFAULT_ROLLBACK
to revert to the OpenSearch Service defaults. If you specifyDEFAULT_ROLLBACK
, you must include aMaintenanceSchedule
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 returnRollbackOnDisable.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromrollbackOnDisableAsString()
.- Returns:
- When disabling Auto-Tune, specify
NO_ROLLBACK
to retain all prior Auto-Tune settings orDEFAULT_ROLLBACK
to revert to the OpenSearch Service defaults. If you specifyDEFAULT_ROLLBACK
, you must include aMaintenanceSchedule
in the request. Otherwise, OpenSearch Service is unable to perform the rollback. - See Also:
-
rollbackOnDisableAsString
When disabling Auto-Tune, specify
NO_ROLLBACK
to retain all prior Auto-Tune settings orDEFAULT_ROLLBACK
to revert to the OpenSearch Service defaults. If you specifyDEFAULT_ROLLBACK
, you must include aMaintenanceSchedule
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 returnRollbackOnDisable.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromrollbackOnDisableAsString()
.- Returns:
- When disabling Auto-Tune, specify
NO_ROLLBACK
to retain all prior Auto-Tune settings orDEFAULT_ROLLBACK
to revert to the OpenSearch Service defaults. If you specifyDEFAULT_ROLLBACK
, you must include aMaintenanceSchedule
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 theisEmpty()
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
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
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
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 interfaceToCopyableBuilder<AutoTuneOptions.Builder,
AutoTuneOptions> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-