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
public static interface UpdateScheduledActionRequest.Builder extends OpenSearchRequest.Builder, SdkPojo, CopyableBuilder<UpdateScheduledActionRequest.Builder,UpdateScheduledActionRequest>

  • Method Details

    • 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

      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:

    • 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

      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:

    • 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)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      UpdateScheduledActionRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.