Package org.opensearch.index.reindex

Class RethrottleRequestBuilder

java.lang.Object

org.opensearch.action.ActionRequestBuilder<Request,Response>

org.opensearch.action.support.tasks.TasksRequestBuilder<RethrottleRequest,ListTasksResponse,RethrottleRequestBuilder>

org.opensearch.index.reindex.RethrottleRequestBuilder

public class RethrottleRequestBuilder
extends TasksRequestBuilder<RethrottleRequest,ListTasksResponse,RethrottleRequestBuilder>

Java API support for changing the throttle on reindex tasks while they are running.

Field Summary

Fields inherited from class org.opensearch.action.ActionRequestBuilder

action, client, request

Constructor Summary

Constructors

Constructor	Description
RethrottleRequestBuilder(OpenSearchClient client, ActionType<ListTasksResponse> action)

Method Summary

Modifier and Type	Method	Description
RethrottleRequestBuilder	setRequestsPerSecond(float requestsPerSecond)	Set the throttle to apply to all matching requests in sub-requests per second.

Methods inherited from class org.opensearch.action.support.tasks.TasksRequestBuilder

setActions, setNodesIds, setParentTaskId, setTaskId, setTimeout

Methods inherited from class org.opensearch.action.ActionRequestBuilder

execute, execute, get, get, get, request

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RethrottleRequestBuilder

public RethrottleRequestBuilder(OpenSearchClient client,
                                ActionType<ListTasksResponse> action)

Method Detail

setRequestsPerSecond

public RethrottleRequestBuilder setRequestsPerSecond(float requestsPerSecond)

Set the throttle to apply to all matching requests in sub-requests per second. Float.POSITIVE_INFINITY means set no throttle. Throttling is done between batches, as we start the next scroll requests. That way we can increase the scroll's timeout to make sure that it contains any time that we might wait.