Package software.amazon.awssdk.services.opensearch.model

Class StartServiceSoftwareUpdateRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.opensearch.model.OpenSearchRequest

software.amazon.awssdk.services.opensearch.model.StartServiceSoftwareUpdateRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<StartServiceSoftwareUpdateRequest.Builder,StartServiceSoftwareUpdateRequest>

@Generated("software.amazon.awssdk:codegen")
public final class StartServiceSoftwareUpdateRequest
extends OpenSearchRequest
implements ToCopyableBuilder<StartServiceSoftwareUpdateRequest.Builder,StartServiceSoftwareUpdateRequest>

Container for the request parameters to the StartServiceSoftwareUpdate operation.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	StartServiceSoftwareUpdateRequest.Builder

Method Summary

Modifier and Type	Method	Description
static StartServiceSoftwareUpdateRequest.Builder	builder()
Long	desiredStartTime()	The Epoch timestamp when you want the service software update to start.
String	domainName()	The name of the domain that you want to update to the latest service software.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
ScheduleAt	scheduleAt()	When to start the service software update.
String	scheduleAtAsString()	When to start the service software update.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends StartServiceSoftwareUpdateRequest.Builder>	serializableBuilderClass()
StartServiceSoftwareUpdateRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

domainName

public final String domainName()

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.

scheduleAt

public final 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.

If the service returns an enum value that is not available in the current SDK version, scheduleAt will return ScheduleAt.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from scheduleAtAsString().

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

scheduleAtAsString

public final String scheduleAtAsString()

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.

If the service returns an enum value that is not available in the current SDK version, scheduleAt will return ScheduleAt.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from scheduleAtAsString().

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

desiredStartTime

public final 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.

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.

toBuilder

public StartServiceSoftwareUpdateRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<StartServiceSoftwareUpdateRequest.Builder,StartServiceSoftwareUpdateRequest>

Specified by:

toBuilder in class OpenSearchRequest

builder

public static StartServiceSoftwareUpdateRequest.Builder builder()

serializableBuilderClass

public static Class<? extends StartServiceSoftwareUpdateRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo