Package org.elasticsearch.index.reindex

Class RethrottleRequestBuilder

  • public class RethrottleRequestBuilder
extends org.elasticsearch.action.support.tasks.TasksRequestBuilder<RethrottleRequest,org.elasticsearch.action.admin.cluster.node.tasks.list.ListTasksResponse,RethrottleRequestBuilder>
    Java API support for changing the throttle on reindex tasks while they are running.

    • Field Summary

      • Fields inherited from class org.elasticsearch.action.ActionRequestBuilder

        action, client, request

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      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.elasticsearch.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

      • Methods inherited from class org.elasticsearch.action.support.tasks.TasksRequestBuilder

        setActions, setNodesIds, setParentTaskId, setTaskId, setTimeout

    • Constructor Detail

      • RethrottleRequestBuilder

        public RethrottleRequestBuilder​(org.elasticsearch.client.ElasticsearchClient client,
                                org.elasticsearch.action.Action<RethrottleRequest,org.elasticsearch.action.admin.cluster.node.tasks.list.ListTasksResponse,RethrottleRequestBuilder> 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.