ScheduledAction (AWS SDK for Java

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

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ScheduledAction
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Information about a scheduled configuration change for an OpenSearch Service domain. This actions can be a service software update or a blue/green Auto-Tune enhancement.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

ScheduledAction()

Constructors
Constructor and Description
`ScheduledAction()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ScheduledAction`	`clone()`
`boolean`	`equals(Object obj)`
`Boolean`	`getCancellable()` Whether or not the scheduled action is cancellable.
`String`	`getDescription()` A description of the action to be taken.
`String`	`getId()` The unique identifier of the scheduled action.
`Boolean`	`getMandatory()` Whether the action is required or optional.
`String`	`getScheduledBy()` Whether the action was scheduled manually (`CUSTOMER`, or by OpenSearch Service automatically ( `SYSTEM`).
`Long`	`getScheduledTime()` The time when the change is scheduled to happen.
`String`	`getSeverity()` The severity of the action.
`String`	`getStatus()` The current status of the scheduled action.
`String`	`getType()` The type of action that will be taken on the domain.
`int`	`hashCode()`
`Boolean`	`isCancellable()` Whether or not the scheduled action is cancellable.
`Boolean`	`isMandatory()` Whether the action is required or optional.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setCancellable(Boolean cancellable)` Whether or not the scheduled action is cancellable.
`void`	`setDescription(String description)` A description of the action to be taken.
`void`	`setId(String id)` The unique identifier of the scheduled action.
`void`	`setMandatory(Boolean mandatory)` Whether the action is required or optional.
`void`	`setScheduledBy(String scheduledBy)` Whether the action was scheduled manually (`CUSTOMER`, or by OpenSearch Service automatically ( `SYSTEM`).
`void`	`setScheduledTime(Long scheduledTime)` The time when the change is scheduled to happen.
`void`	`setSeverity(String severity)` The severity of the action.
`void`	`setStatus(String status)` The current status of the scheduled action.
`void`	`setType(String type)` The type of action that will be taken on the domain.
`String`	`toString()` Returns a string representation of this object.
`ScheduledAction`	`withCancellable(Boolean cancellable)` Whether or not the scheduled action is cancellable.
`ScheduledAction`	`withDescription(String description)` A description of the action to be taken.
`ScheduledAction`	`withId(String id)` The unique identifier of the scheduled action.
`ScheduledAction`	`withMandatory(Boolean mandatory)` Whether the action is required or optional.
`ScheduledAction`	`withScheduledBy(ScheduledBy scheduledBy)` Whether the action was scheduled manually (`CUSTOMER`, or by OpenSearch Service automatically ( `SYSTEM`).
`ScheduledAction`	`withScheduledBy(String scheduledBy)` Whether the action was scheduled manually (`CUSTOMER`, or by OpenSearch Service automatically ( `SYSTEM`).
`ScheduledAction`	`withScheduledTime(Long scheduledTime)` The time when the change is scheduled to happen.
`ScheduledAction`	`withSeverity(ActionSeverity severity)` The severity of the action.
`ScheduledAction`	`withSeverity(String severity)` The severity of the action.
`ScheduledAction`	`withStatus(ActionStatus status)` The current status of the scheduled action.
`ScheduledAction`	`withStatus(String status)` The current status of the scheduled action.
`ScheduledAction`	`withType(ActionType type)` The type of action that will be taken on the domain.
`ScheduledAction`	`withType(String type)` The type of action that will be taken on the domain.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - ScheduledAction
```
public ScheduledAction()
```
- Method Detail
  - setId
```
public void setId(String id)
```
    The unique identifier of the scheduled action.
    
    Parameters:
    
    id - The unique identifier of the scheduled action.
  - getId
```
public String getId()
```
    The unique identifier of the scheduled action.
    
    Returns:
    
    The unique identifier of the scheduled action.
  - withId
```
public ScheduledAction withId(String id)
```
    The unique identifier of the scheduled action.
    
    Parameters:
    
    id - The unique identifier of the scheduled action.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setType
```
public void setType(String type)
```
    The type of action that will be taken on the domain.
    
    Parameters:
    
    type - The type of action that will be taken on the domain.
    
    See Also:
    
    ActionType
  - getType
```
public String getType()
```
    The type of action that will be taken on the domain.
    
    Returns:
    
    The type of action that will be taken on the domain.
    
    See Also:
    
    ActionType
  - withType
```
public ScheduledAction withType(String type)
```
    The type of action that will be taken on the domain.
    
    Parameters:
    
    type - The type of action that will be taken on the domain.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ActionType
  - withType
```
public ScheduledAction withType(ActionType type)
```
    The type of action that will be taken on the domain.
    
    Parameters:
    
    type - The type of action that will be taken on the domain.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ActionType
  - setSeverity
```
public void setSeverity(String severity)
```
    The severity of the action.
    
    Parameters:
    
    severity - The severity of the action.
    
    See Also:
    
    ActionSeverity
  - getSeverity
```
public String getSeverity()
```
    The severity of the action.
    
    Returns:
    
    The severity of the action.
    
    See Also:
    
    ActionSeverity
  - withSeverity
```
public ScheduledAction withSeverity(String severity)
```
    The severity of the action.
    
    Parameters:
    
    severity - The severity of the action.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ActionSeverity
  - withSeverity
```
public ScheduledAction withSeverity(ActionSeverity severity)
```
    The severity of the action.
    
    Parameters:
    
    severity - The severity of the action.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ActionSeverity
  - setScheduledTime
```
public void setScheduledTime(Long scheduledTime)
```
    The time when the change is scheduled to happen.
    
    Parameters:
    
    scheduledTime - The time when the change is scheduled to happen.
  - getScheduledTime
```
public Long getScheduledTime()
```
    The time when the change is scheduled to happen.
    
    Returns:
    
    The time when the change is scheduled to happen.
  - withScheduledTime
```
public ScheduledAction withScheduledTime(Long scheduledTime)
```
    The time when the change is scheduled to happen.
    
    Parameters:
    
    scheduledTime - The time when the change is scheduled to happen.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDescription
```
public void setDescription(String description)
```
    A description of the action to be taken.
    
    Parameters:
    
    description - A description of the action to be taken.
  - getDescription
```
public String getDescription()
```
    A description of the action to be taken.
    
    Returns:
    
    A description of the action to be taken.
  - withDescription
```
public ScheduledAction withDescription(String description)
```
    A description of the action to be taken.
    
    Parameters:
    
    description - A description of the action to be taken.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setScheduledBy
```
public void setScheduledBy(String scheduledBy)
```
    Whether the action was scheduled manually (CUSTOMER, or by OpenSearch Service automatically ( SYSTEM).
    
    Parameters:
    
    scheduledBy - Whether the action was scheduled manually (CUSTOMER, or by OpenSearch Service automatically ( SYSTEM).
    
    See Also:
    
    ScheduledBy
  - getScheduledBy
```
public String getScheduledBy()
```
    Whether the action was scheduled manually (CUSTOMER, or by OpenSearch Service automatically ( SYSTEM).
    
    Returns:
    
    Whether the action was scheduled manually (CUSTOMER, or by OpenSearch Service automatically (SYSTEM).
    
    See Also:
    
    ScheduledBy
  - withScheduledBy
```
public ScheduledAction withScheduledBy(String scheduledBy)
```
    Whether the action was scheduled manually (CUSTOMER, or by OpenSearch Service automatically ( SYSTEM).
    
    Parameters:
    
    scheduledBy - Whether the action was scheduled manually (CUSTOMER, or by OpenSearch Service automatically ( SYSTEM).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ScheduledBy
  - withScheduledBy
```
public ScheduledAction withScheduledBy(ScheduledBy scheduledBy)
```
    Whether the action was scheduled manually (CUSTOMER, or by OpenSearch Service automatically ( SYSTEM).
    
    Parameters:
    
    scheduledBy - Whether the action was scheduled manually (CUSTOMER, or by OpenSearch Service automatically ( SYSTEM).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ScheduledBy
  - setStatus
```
public void setStatus(String status)
```
    The current status of the scheduled action.
    
    Parameters:
    
    status - The current status of the scheduled action.
    
    See Also:
    
    ActionStatus
  - getStatus
```
public String getStatus()
```
    The current status of the scheduled action.
    
    Returns:
    
    The current status of the scheduled action.
    
    See Also:
    
    ActionStatus
  - withStatus
```
public ScheduledAction withStatus(String status)
```
    The current status of the scheduled action.
    
    Parameters:
    
    status - The current status of the scheduled action.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ActionStatus
  - withStatus
```
public ScheduledAction withStatus(ActionStatus status)
```
    The current status of the scheduled action.
    
    Parameters:
    
    status - The current status of the scheduled action.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ActionStatus
  - setMandatory
```
public void setMandatory(Boolean mandatory)
```
    Whether the action is required or optional.
    
    Parameters:
    
    mandatory - Whether the action is required or optional.
  - getMandatory
```
public Boolean getMandatory()
```
    Whether the action is required or optional.
    
    Returns:
    
    Whether the action is required or optional.
  - withMandatory
```
public ScheduledAction withMandatory(Boolean mandatory)
```
    Whether the action is required or optional.
    
    Parameters:
    
    mandatory - Whether the action is required or optional.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isMandatory
```
public Boolean isMandatory()
```
    Whether the action is required or optional.
    
    Returns:
    
    Whether the action is required or optional.
  - setCancellable
```
public void setCancellable(Boolean cancellable)
```
    Whether or not the scheduled action is cancellable.
    
    Parameters:
    
    cancellable - Whether or not the scheduled action is cancellable.
  - getCancellable
```
public Boolean getCancellable()
```
    Whether or not the scheduled action is cancellable.
    
    Returns:
    
    Whether or not the scheduled action is cancellable.
  - withCancellable
```
public ScheduledAction withCancellable(Boolean cancellable)
```
    Whether or not the scheduled action is cancellable.
    
    Parameters:
    
    cancellable - Whether or not the scheduled action is cancellable.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isCancellable
```
public Boolean isCancellable()
```
    Whether or not the scheduled action is cancellable.
    
    Returns:
    
    Whether or not the scheduled action is cancellable.
  - 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 ScheduledAction 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.779

Class ScheduledAction

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ScheduledAction

Method Detail

setId

getId

withId

setType

getType

withType

withType

setSeverity

getSeverity

withSeverity

withSeverity

setScheduledTime

getScheduledTime

withScheduledTime

setDescription

getDescription

withDescription

setScheduledBy

getScheduledBy

withScheduledBy

withScheduledBy

setStatus

getStatus

withStatus

withStatus

setMandatory

getMandatory

withMandatory

isMandatory

setCancellable

getCancellable

withCancellable

isCancellable

toString

equals

hashCode

clone

marshall