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

Interface StartServiceSoftwareUpdateRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<StartServiceSoftwareUpdateRequest.Builder,StartServiceSoftwareUpdateRequest>, OpenSearchRequest.Builder, SdkBuilder<StartServiceSoftwareUpdateRequest.Builder,StartServiceSoftwareUpdateRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

StartServiceSoftwareUpdateRequest

@Mutable
@NotThreadSafe
public static interface StartServiceSoftwareUpdateRequest.Builder
extends OpenSearchRequest.Builder, SdkPojo, CopyableBuilder<StartServiceSoftwareUpdateRequest.Builder,StartServiceSoftwareUpdateRequest>

Method Summary

Modifier and Type	Method	Description
StartServiceSoftwareUpdateRequest.Builder	desiredStartTime(Long desiredStartTime)	The Epoch timestamp when you want the service software update to start.
StartServiceSoftwareUpdateRequest.Builder	domainName(String domainName)	The name of the domain that you want to update to the latest service software.
StartServiceSoftwareUpdateRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
StartServiceSoftwareUpdateRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
StartServiceSoftwareUpdateRequest.Builder	scheduleAt(String scheduleAt)	When to start the service software update.
StartServiceSoftwareUpdateRequest.Builder	scheduleAt(ScheduleAt scheduleAt)	When to start the service software update.

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

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

copy

Methods inherited from interface software.amazon.awssdk.services.opensearch.model.OpenSearchRequest.Builder

build

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

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Detail

domainName

StartServiceSoftwareUpdateRequest.Builder domainName(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.

scheduleAt

StartServiceSoftwareUpdateRequest.Builder scheduleAt(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, ScheduleAt

scheduleAt

StartServiceSoftwareUpdateRequest.Builder scheduleAt(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, ScheduleAt

desiredStartTime

StartServiceSoftwareUpdateRequest.Builder desiredStartTime(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.

overrideConfiguration

StartServiceSoftwareUpdateRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

StartServiceSoftwareUpdateRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder