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

Interface UpdateScheduledActionRequest.Builder

All Superinterfaces:

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

Enclosing class:

UpdateScheduledActionRequest

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

Method Summary

Modifier and Type	Method	Description
UpdateScheduledActionRequest.Builder	actionID(String actionID)	The unique identifier of the action to reschedule.
UpdateScheduledActionRequest.Builder	actionType(String actionType)	The type of action to reschedule.
UpdateScheduledActionRequest.Builder	actionType(ActionType actionType)	The type of action to reschedule.
UpdateScheduledActionRequest.Builder	desiredStartTime(Long desiredStartTime)	The time to implement the change, in Coordinated Universal Time (UTC).
UpdateScheduledActionRequest.Builder	domainName(String domainName)	The name of the domain to reschedule an action for.
UpdateScheduledActionRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
UpdateScheduledActionRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
UpdateScheduledActionRequest.Builder	scheduleAt(String scheduleAt)	When to schedule the action.
UpdateScheduledActionRequest.Builder	scheduleAt(ScheduleAt scheduleAt)	When to schedule the action.

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

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

actionID

UpdateScheduledActionRequest.Builder actionID(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.

actionType

UpdateScheduledActionRequest.Builder actionType(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, ActionType

actionType

UpdateScheduledActionRequest.Builder actionType(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, ActionType

scheduleAt

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

scheduleAt

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

desiredStartTime

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

overrideConfiguration

UpdateScheduledActionRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

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

Specified by:

overrideConfiguration in interface AwsRequest.Builder