software.amazon.awssdk.services.opensearch.model

Interface AutoTuneOptions.Builder

All Superinterfaces:

Buildable, CopyableBuilder<AutoTuneOptions.Builder,AutoTuneOptions>, SdkBuilder<AutoTuneOptions.Builder,AutoTuneOptions>, SdkPojo

Enclosing class:

AutoTuneOptions

public static interface AutoTuneOptions.Builder
extends SdkPojo, CopyableBuilder<AutoTuneOptions.Builder,AutoTuneOptions>

Method Summary

Modifier and Type	Method and Description
AutoTuneOptions.Builder	desiredState(AutoTuneDesiredState desiredState) Whether Auto-Tune is enabled or disabled.
AutoTuneOptions.Builder	desiredState(String desiredState) Whether Auto-Tune is enabled or disabled.
AutoTuneOptions.Builder	maintenanceSchedules(AutoTuneMaintenanceSchedule... maintenanceSchedules) DEPRECATED.
AutoTuneOptions.Builder	maintenanceSchedules(Collection<AutoTuneMaintenanceSchedule> maintenanceSchedules) DEPRECATED.
AutoTuneOptions.Builder	maintenanceSchedules(Consumer<AutoTuneMaintenanceSchedule.Builder>... maintenanceSchedules) DEPRECATED.
AutoTuneOptions.Builder	rollbackOnDisable(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.
AutoTuneOptions.Builder	rollbackOnDisable(String 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.
AutoTuneOptions.Builder	useOffPeakWindow(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 interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

desiredState

AutoTuneOptions.Builder desiredState(String desiredState)

Whether Auto-Tune is enabled or disabled.

Parameters:

desiredState - Whether Auto-Tune is enabled or disabled.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

AutoTuneDesiredState, AutoTuneDesiredState

desiredState

AutoTuneOptions.Builder desiredState(AutoTuneDesiredState desiredState)

Whether Auto-Tune is enabled or disabled.

Parameters:

desiredState - Whether Auto-Tune is enabled or disabled.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

AutoTuneDesiredState, AutoTuneDesiredState

rollbackOnDisable

AutoTuneOptions.Builder rollbackOnDisable(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

RollbackOnDisable, RollbackOnDisable

rollbackOnDisable

AutoTuneOptions.Builder rollbackOnDisable(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

RollbackOnDisable, RollbackOnDisable

maintenanceSchedules

AutoTuneOptions.Builder maintenanceSchedules(Collection<AutoTuneMaintenanceSchedule> maintenanceSchedules)

DEPRECATED. Use off-peak window instead.

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

Parameters:

maintenanceSchedules - DEPRECATED. Use off-peak window instead.

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

Returns:

Returns a reference to this object so that method calls can be chained together.

maintenanceSchedules

AutoTuneOptions.Builder maintenanceSchedules(AutoTuneMaintenanceSchedule... maintenanceSchedules)

DEPRECATED. Use off-peak window instead.

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

Parameters:

maintenanceSchedules - DEPRECATED. Use off-peak window instead.

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

Returns:

Returns a reference to this object so that method calls can be chained together.

maintenanceSchedules

AutoTuneOptions.Builder maintenanceSchedules(Consumer<AutoTuneMaintenanceSchedule.Builder>... maintenanceSchedules)

DEPRECATED. Use off-peak window instead.

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

This is a convenience method that creates an instance of the AutoTuneMaintenanceSchedule.Builder avoiding the need to create one manually via AutoTuneMaintenanceSchedule.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #maintenanceSchedules(List).

Parameters:

maintenanceSchedules - a consumer that will call methods on AutoTuneMaintenanceSchedule.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#maintenanceSchedules(java.util.Collection)

useOffPeakWindow

AutoTuneOptions.Builder useOffPeakWindow(Boolean useOffPeakWindow)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.