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

Interface UpdateScheduledActionRequest.Builder

    • 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.

      • 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.