com.amazonaws.services.opensearch.model

Class UpdateScheduledActionRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.opensearch.model.UpdateScheduledActionRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class UpdateScheduledActionRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
UpdateScheduledActionRequest()

Method Summary

Modifier and Type	Method and Description
UpdateScheduledActionRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getActionID() The unique identifier of the action to reschedule.
String	getActionType() The type of action to reschedule.
Long	getDesiredStartTime() The time to implement the change, in Coordinated Universal Time (UTC).
String	getDomainName() The name of the domain to reschedule an action for.
String	getScheduleAt() When to schedule the action.
int	hashCode()
void	setActionID(String actionID) The unique identifier of the action to reschedule.
void	setActionType(String actionType) The type of action to reschedule.
void	setDesiredStartTime(Long desiredStartTime) The time to implement the change, in Coordinated Universal Time (UTC).
void	setDomainName(String domainName) The name of the domain to reschedule an action for.
void	setScheduleAt(String scheduleAt) When to schedule the action.
String	toString() Returns a string representation of this object.
UpdateScheduledActionRequest	withActionID(String actionID) The unique identifier of the action to reschedule.
UpdateScheduledActionRequest	withActionType(ActionType actionType) The type of action to reschedule.
UpdateScheduledActionRequest	withActionType(String actionType) The type of action to reschedule.
UpdateScheduledActionRequest	withDesiredStartTime(Long desiredStartTime) The time to implement the change, in Coordinated Universal Time (UTC).
UpdateScheduledActionRequest	withDomainName(String domainName) The name of the domain to reschedule an action for.
UpdateScheduledActionRequest	withScheduleAt(ScheduleAt scheduleAt) When to schedule the action.
UpdateScheduledActionRequest	withScheduleAt(String scheduleAt) When to schedule the action.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

UpdateScheduledActionRequest

public UpdateScheduledActionRequest()

Method Detail

setDomainName

public void setDomainName(String domainName)

The name of the domain to reschedule an action for.

Parameters:

domainName - The name of the domain to reschedule an action for.

getDomainName

public String getDomainName()

The name of the domain to reschedule an action for.

Returns:

The name of the domain to reschedule an action for.

withDomainName

public UpdateScheduledActionRequest withDomainName(String domainName)

The name of the domain to reschedule an action for.

Parameters:

domainName - The name of the domain to reschedule an action for.

Returns:

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

setActionID

public void setActionID(String actionID)

The unique identifier of the action to reschedule. To retrieve this ID, send a ListScheduledActions request.

Parameters:

actionID - The unique identifier of the action to reschedule. To retrieve this ID, send a ListScheduledActions request.

getActionID

public String getActionID()

The unique identifier of the action to reschedule. To retrieve this ID, send a ListScheduledActions request.

Returns:

The unique identifier of the action to reschedule. To retrieve this ID, send a ListScheduledActions request.

withActionID

public UpdateScheduledActionRequest withActionID(String actionID)

The unique identifier of the action to reschedule. To retrieve this ID, send a ListScheduledActions request.

Parameters:

actionID - The unique identifier of the action to reschedule. To retrieve this ID, send a ListScheduledActions request.

Returns:

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

setActionType

public void setActionType(String actionType)

The type of action to reschedule. Can be one of SERVICE_SOFTWARE_UPDATE, JVM_HEAP_SIZE_TUNING, or JVM_YOUNG_GEN_TUNING. To retrieve this value, send a ListScheduledActions request.

Parameters:

actionType - The type of action to reschedule. Can be one of SERVICE_SOFTWARE_UPDATE, JVM_HEAP_SIZE_TUNING, or JVM_YOUNG_GEN_TUNING. To retrieve this value, send a ListScheduledActions request.

See Also:

ActionType

getActionType

public String getActionType()

The type of action to reschedule. Can be one of SERVICE_SOFTWARE_UPDATE, JVM_HEAP_SIZE_TUNING, or JVM_YOUNG_GEN_TUNING. To retrieve this value, send a ListScheduledActions request.

Returns:

The type of action to reschedule. Can be one of SERVICE_SOFTWARE_UPDATE, JVM_HEAP_SIZE_TUNING, or JVM_YOUNG_GEN_TUNING. To retrieve this value, send a ListScheduledActions request.

See Also:

ActionType

withActionType

public UpdateScheduledActionRequest withActionType(String actionType)

The type of action to reschedule. Can be one of SERVICE_SOFTWARE_UPDATE, JVM_HEAP_SIZE_TUNING, or JVM_YOUNG_GEN_TUNING. To retrieve this value, send a ListScheduledActions request.

Parameters:

actionType - The type of action to reschedule. Can be one of SERVICE_SOFTWARE_UPDATE, JVM_HEAP_SIZE_TUNING, or JVM_YOUNG_GEN_TUNING. To retrieve this value, send a ListScheduledActions request.

Returns:

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

See Also:

ActionType

withActionType

public UpdateScheduledActionRequest withActionType(ActionType actionType)

The type of action to reschedule. Can be one of SERVICE_SOFTWARE_UPDATE, JVM_HEAP_SIZE_TUNING, or JVM_YOUNG_GEN_TUNING. To retrieve this value, send a ListScheduledActions request.

Parameters:

actionType - The type of action to reschedule. Can be one of SERVICE_SOFTWARE_UPDATE, JVM_HEAP_SIZE_TUNING, or JVM_YOUNG_GEN_TUNING. To retrieve this value, send a ListScheduledActions request.

Returns:

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

See Also:

ActionType

setScheduleAt

public void setScheduleAt(String scheduleAt)

When to schedule the action.

• NOW - Immediately schedules the update to happen in the current hour if there's capacity available.

• TIMESTAMP - Lets you specify a custom date and time to apply the update. If you specify this value, you must also provide a value for DesiredStartTime.

• OFF_PEAK_WINDOW - Marks the action to be picked up during an upcoming off-peak window. There's no guarantee that the change will be implemented during the next immediate window. Depending on capacity, it might happen in subsequent days.

Parameters:

scheduleAt - When to schedule the action.

• NOW - Immediately schedules the update to happen in the current hour if there's capacity available.

• TIMESTAMP - Lets you specify a custom date and time to apply the update. If you specify this value, you must also provide a value for DesiredStartTime.

• OFF_PEAK_WINDOW - Marks the action to be picked up during an upcoming off-peak window. There's no guarantee that the change will be implemented during the next immediate window. Depending on capacity, it might happen in subsequent days.

See Also:

ScheduleAt

getScheduleAt

public String getScheduleAt()

When to schedule the action.

• NOW - Immediately schedules the update to happen in the current hour if there's capacity available.

• TIMESTAMP - Lets you specify a custom date and time to apply the update. If you specify this value, you must also provide a value for DesiredStartTime.

• OFF_PEAK_WINDOW - Marks the action to be picked up during an upcoming off-peak window. There's no guarantee that the change will be implemented during the next immediate window. Depending on capacity, it might happen in subsequent days.

Returns:

When to schedule the action.

• NOW - Immediately schedules the update to happen in the current hour if there's capacity available.

• TIMESTAMP - Lets you specify a custom date and time to apply the update. If you specify this value, you must also provide a value for DesiredStartTime.

• OFF_PEAK_WINDOW - Marks the action to be picked up during an upcoming off-peak window. There's no guarantee that the change will be implemented during the next immediate window. Depending on capacity, it might happen in subsequent days.

See Also:

ScheduleAt

withScheduleAt

public UpdateScheduledActionRequest withScheduleAt(String scheduleAt)

When to schedule the action.

• NOW - Immediately schedules the update to happen in the current hour if there's capacity available.

• TIMESTAMP - Lets you specify a custom date and time to apply the update. If you specify this value, you must also provide a value for DesiredStartTime.

• OFF_PEAK_WINDOW - Marks the action to be picked up during an upcoming off-peak window. There's no guarantee that the change will be implemented during the next immediate window. Depending on capacity, it might happen in subsequent days.

Parameters:

scheduleAt - When to schedule the action.

• NOW - Immediately schedules the update to happen in the current hour if there's capacity available.

• TIMESTAMP - Lets you specify a custom date and time to apply the update. If you specify this value, you must also provide a value for DesiredStartTime.

• OFF_PEAK_WINDOW - Marks the action to be picked up during an upcoming off-peak window. There's no guarantee that the change will be implemented during the next immediate window. Depending on capacity, it might happen in subsequent days.

Returns:

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

See Also:

ScheduleAt

withScheduleAt

public UpdateScheduledActionRequest withScheduleAt(ScheduleAt scheduleAt)

When to schedule the action.

• NOW - Immediately schedules the update to happen in the current hour if there's capacity available.

• TIMESTAMP - Lets you specify a custom date and time to apply the update. If you specify this value, you must also provide a value for DesiredStartTime.

• OFF_PEAK_WINDOW - Marks the action to be picked up during an upcoming off-peak window. There's no guarantee that the change will be implemented during the next immediate window. Depending on capacity, it might happen in subsequent days.

Parameters:

scheduleAt - When to schedule the action.

• NOW - Immediately schedules the update to happen in the current hour if there's capacity available.

• TIMESTAMP - Lets you specify a custom date and time to apply the update. If you specify this value, you must also provide a value for DesiredStartTime.

• OFF_PEAK_WINDOW - Marks the action to be picked up during an upcoming off-peak window. There's no guarantee that the change will be implemented during the next immediate window. Depending on capacity, it might happen in subsequent days.

Returns:

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

See Also:

ScheduleAt

setDesiredStartTime

public void setDesiredStartTime(Long desiredStartTime)

The time to implement the change, in Coordinated Universal Time (UTC). Only specify this parameter if you set ScheduleAt to TIMESTAMP.

Parameters:

desiredStartTime - The time to implement the change, in Coordinated Universal Time (UTC). Only specify this parameter if you set ScheduleAt to TIMESTAMP.

getDesiredStartTime

public Long getDesiredStartTime()

The time to implement the change, in Coordinated Universal Time (UTC). Only specify this parameter if you set ScheduleAt to TIMESTAMP.

Returns:

The time to implement the change, in Coordinated Universal Time (UTC). Only specify this parameter if you set ScheduleAt to TIMESTAMP.

withDesiredStartTime

public UpdateScheduledActionRequest withDesiredStartTime(Long desiredStartTime)

The time to implement the change, in Coordinated Universal Time (UTC). Only specify this parameter if you set ScheduleAt to TIMESTAMP.

Parameters:

desiredStartTime - The time to implement the change, in Coordinated Universal Time (UTC). Only specify this parameter if you set ScheduleAt to TIMESTAMP.

Returns:

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

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 UpdateScheduledActionRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()