com.amazonaws.services.opensearch.model

Class StartServiceSoftwareUpdateRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.opensearch.model.StartServiceSoftwareUpdateRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

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

Container for the request parameters to the StartServiceSoftwareUpdate operation.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
StartServiceSoftwareUpdateRequest()

Method Summary

Modifier and Type	Method and Description
StartServiceSoftwareUpdateRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
Long	getDesiredStartTime() The Epoch timestamp when you want the service software update to start.
String	getDomainName() The name of the domain that you want to update to the latest service software.
String	getScheduleAt() When to start the service software update.
int	hashCode()
void	setDesiredStartTime(Long desiredStartTime) The Epoch timestamp when you want the service software update to start.
void	setDomainName(String domainName) The name of the domain that you want to update to the latest service software.
void	setScheduleAt(String scheduleAt) When to start the service software update.
String	toString() Returns a string representation of this object.
StartServiceSoftwareUpdateRequest	withDesiredStartTime(Long desiredStartTime) The Epoch timestamp when you want the service software update to start.
StartServiceSoftwareUpdateRequest	withDomainName(String domainName) The name of the domain that you want to update to the latest service software.
StartServiceSoftwareUpdateRequest	withScheduleAt(ScheduleAt scheduleAt) When to start the service software update.
StartServiceSoftwareUpdateRequest	withScheduleAt(String scheduleAt) When to start the service software update.

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

StartServiceSoftwareUpdateRequest

public StartServiceSoftwareUpdateRequest()

Method Detail

setDomainName

public void setDomainName(String domainName)

The name of the domain that you want to update to the latest service software.

Parameters:

domainName - The name of the domain that you want to update to the latest service software.

getDomainName

public String getDomainName()

The name of the domain that you want to update to the latest service software.

Returns:

The name of the domain that you want to update to the latest service software.

withDomainName

public StartServiceSoftwareUpdateRequest withDomainName(String domainName)

The name of the domain that you want to update to the latest service software.

Parameters:

domainName - The name of the domain that you want to update to the latest service software.

Returns:

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

setScheduleAt

public void setScheduleAt(String scheduleAt)

When to start the service software update.

• 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 update to be picked up during an upcoming off-peak window. There's no guarantee that the update will happen during the next immediate window. Depending on capacity, it might happen in subsequent days.

Default: NOW if you don't specify a value for DesiredStartTime, and TIMESTAMP if you do.

Parameters:

scheduleAt - When to start the service software update.

• 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 update to be picked up during an upcoming off-peak window. There's no guarantee that the update will happen during the next immediate window. Depending on capacity, it might happen in subsequent days.

Default: NOW if you don't specify a value for DesiredStartTime, and TIMESTAMP if you do.

See Also:

ScheduleAt

getScheduleAt

public String getScheduleAt()

When to start the service software update.

• 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 update to be picked up during an upcoming off-peak window. There's no guarantee that the update will happen during the next immediate window. Depending on capacity, it might happen in subsequent days.

Default: NOW if you don't specify a value for DesiredStartTime, and TIMESTAMP if you do.

Returns:

When to start the service software update.

• 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 update to be picked up during an upcoming off-peak window. There's no guarantee that the update will happen during the next immediate window. Depending on capacity, it might happen in subsequent days.

Default: NOW if you don't specify a value for DesiredStartTime, and TIMESTAMP if you do.

See Also:

ScheduleAt

withScheduleAt

public StartServiceSoftwareUpdateRequest withScheduleAt(String scheduleAt)

When to start the service software update.

• 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 update to be picked up during an upcoming off-peak window. There's no guarantee that the update will happen during the next immediate window. Depending on capacity, it might happen in subsequent days.

Default: NOW if you don't specify a value for DesiredStartTime, and TIMESTAMP if you do.

Parameters:

scheduleAt - When to start the service software update.

• 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 update to be picked up during an upcoming off-peak window. There's no guarantee that the update will happen during the next immediate window. Depending on capacity, it might happen in subsequent days.

Default: NOW if you don't specify a value for DesiredStartTime, and TIMESTAMP if you do.

Returns:

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

See Also:

ScheduleAt

withScheduleAt

public StartServiceSoftwareUpdateRequest withScheduleAt(ScheduleAt scheduleAt)

When to start the service software update.

• 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 update to be picked up during an upcoming off-peak window. There's no guarantee that the update will happen during the next immediate window. Depending on capacity, it might happen in subsequent days.

Default: NOW if you don't specify a value for DesiredStartTime, and TIMESTAMP if you do.

Parameters:

scheduleAt - When to start the service software update.

• 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 update to be picked up during an upcoming off-peak window. There's no guarantee that the update will happen during the next immediate window. Depending on capacity, it might happen in subsequent days.

Default: NOW if you don't specify a value for DesiredStartTime, and TIMESTAMP if you do.

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 Epoch timestamp when you want the service software update to start. You only need to specify this parameter if you set ScheduleAt to TIMESTAMP.

Parameters:

desiredStartTime - The Epoch timestamp when you want the service software update to start. You only need to specify this parameter if you set ScheduleAt to TIMESTAMP.

getDesiredStartTime

public Long getDesiredStartTime()

The Epoch timestamp when you want the service software update to start. You only need to specify this parameter if you set ScheduleAt to TIMESTAMP.

Returns:

The Epoch timestamp when you want the service software update to start. You only need to specify this parameter if you set ScheduleAt to TIMESTAMP.

withDesiredStartTime

public StartServiceSoftwareUpdateRequest withDesiredStartTime(Long desiredStartTime)

The Epoch timestamp when you want the service software update to start. You only need to specify this parameter if you set ScheduleAt to TIMESTAMP.

Parameters:

desiredStartTime - The Epoch timestamp when you want the service software update to start. You only need to 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 StartServiceSoftwareUpdateRequest 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()