AutoTuneOptions (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.opensearch.model.AutoTuneOptions

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AutoTuneOptions
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Auto-Tune settings when updating a domain. For more information, see Auto-Tune for Amazon OpenSearch Service.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

AutoTuneOptions()

Constructors
Constructor and Description
`AutoTuneOptions()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AutoTuneOptions`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getDesiredState()` Whether Auto-Tune is enabled or disabled.
`List<AutoTuneMaintenanceSchedule>`	`getMaintenanceSchedules()` DEPRECATED.
`String`	`getRollbackOnDisable()` When disabling Auto-Tune, specify `NO_ROLLBACK` to retain all prior Auto-Tune settings or `DEFAULT_ROLLBACK` to revert to the OpenSearch Service defaults.
`Boolean`	`getUseOffPeakWindow()` Whether to use the domain's off-peak window to deploy configuration changes on the domain rather than a maintenance schedule.
`int`	`hashCode()`
`Boolean`	`isUseOffPeakWindow()` Whether to use the domain's off-peak window to deploy configuration changes on the domain rather than a maintenance schedule.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setDesiredState(String desiredState)` Whether Auto-Tune is enabled or disabled.
`void`	`setMaintenanceSchedules(Collection<AutoTuneMaintenanceSchedule> maintenanceSchedules)` DEPRECATED.
`void`	`setRollbackOnDisable(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.
`void`	`setUseOffPeakWindow(Boolean useOffPeakWindow)` Whether to use the domain's off-peak window to deploy configuration changes on the domain rather than a maintenance schedule.
`String`	`toString()` Returns a string representation of this object.
`AutoTuneOptions`	`withDesiredState(AutoTuneDesiredState desiredState)` Whether Auto-Tune is enabled or disabled.
`AutoTuneOptions`	`withDesiredState(String desiredState)` Whether Auto-Tune is enabled or disabled.
`AutoTuneOptions`	`withMaintenanceSchedules(AutoTuneMaintenanceSchedule... maintenanceSchedules)` DEPRECATED.
`AutoTuneOptions`	`withMaintenanceSchedules(Collection<AutoTuneMaintenanceSchedule> maintenanceSchedules)` DEPRECATED.
`AutoTuneOptions`	`withRollbackOnDisable(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`	`withRollbackOnDisable(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`	`withUseOffPeakWindow(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
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - AutoTuneOptions
```
public AutoTuneOptions()
```
- Method Detail
  - setDesiredState
```
public void setDesiredState(String desiredState)
```
    Whether Auto-Tune is enabled or disabled.
    
    Parameters:
    
    desiredState - Whether Auto-Tune is enabled or disabled.
    
    See Also:
    
    AutoTuneDesiredState
  - getDesiredState
```
public String getDesiredState()
```
    Whether Auto-Tune is enabled or disabled.
    
    Returns:
    
    Whether Auto-Tune is enabled or disabled.
    
    See Also:
    
    AutoTuneDesiredState
  - withDesiredState
```
public AutoTuneOptions withDesiredState(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
  - withDesiredState
```
public AutoTuneOptions withDesiredState(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
  - setRollbackOnDisable
```
public void setRollbackOnDisable(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.
    
    See Also:
    
    RollbackOnDisable
  - getRollbackOnDisable
```
public String getRollbackOnDisable()
```
    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:
    
    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
  - withRollbackOnDisable
```
public AutoTuneOptions withRollbackOnDisable(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
  - withRollbackOnDisable
```
public AutoTuneOptions withRollbackOnDisable(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
  - getMaintenanceSchedules
```
public List<AutoTuneMaintenanceSchedule> getMaintenanceSchedules()
```
    DEPRECATED. Use off-peak window instead.
    
    A list of maintenance schedules during which Auto-Tune can deploy changes.
    
    Returns:
    
    DEPRECATED. Use off-peak window instead.
    
    A list of maintenance schedules during which Auto-Tune can deploy changes.
  - setMaintenanceSchedules
```
public void setMaintenanceSchedules(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.
  - withMaintenanceSchedules
```
public AutoTuneOptions withMaintenanceSchedules(AutoTuneMaintenanceSchedule... maintenanceSchedules)
```
    DEPRECATED. Use off-peak window instead.
    
    A list of maintenance schedules during which Auto-Tune can deploy changes.
    
    NOTE: This method appends the values to the existing list (if any). Use setMaintenanceSchedules(java.util.Collection) or withMaintenanceSchedules(java.util.Collection) if you want to override the existing values.
    
    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.
  - withMaintenanceSchedules
```
public AutoTuneOptions withMaintenanceSchedules(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.
  - setUseOffPeakWindow
```
public void setUseOffPeakWindow(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.
  - getUseOffPeakWindow
```
public Boolean getUseOffPeakWindow()
```
    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.
  - withUseOffPeakWindow
```
public AutoTuneOptions withUseOffPeakWindow(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.
  - isUseOffPeakWindow
```
public Boolean isUseOffPeakWindow()
```
    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.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public AutoTuneOptions clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.793

Class AutoTuneOptions

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AutoTuneOptions

Method Detail

setDesiredState

getDesiredState

withDesiredState

withDesiredState

setRollbackOnDisable

getRollbackOnDisable

withRollbackOnDisable

withRollbackOnDisable

getMaintenanceSchedules

setMaintenanceSchedules

withMaintenanceSchedules

withMaintenanceSchedules

setUseOffPeakWindow

getUseOffPeakWindow

withUseOffPeakWindow

isUseOffPeakWindow

toString

equals

hashCode

clone

marshall