org.elasticsearch.index.reindex

Class RethrottleRequest

java.lang.Object

<any>

org.elasticsearch.index.reindex.RethrottleRequest

public class RethrottleRequest
extends <any>

A request to change throttling on a task.

Constructor Summary

Constructors

Constructor and Description
RethrottleRequest()

Method Summary

Modifier and Type	Method and Description
float	getRequestsPerSecond() The throttle to apply to all matching requests in sub-requests per second.
void	readFrom(StreamInput in)
RethrottleRequest	setRequestsPerSecond(float requestsPerSecond) Set the throttle to apply to all matching requests in sub-requests per second.
ActionRequestValidationException	validate()
void	writeTo(StreamOutput out)

Methods inherited from class java.lang.Object

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

Constructor Detail

RethrottleRequest

public RethrottleRequest()

Method Detail

getRequestsPerSecond

public float getRequestsPerSecond()

The throttle to apply to all matching requests in sub-requests per second. 0 means set no throttle and that is the default.

setRequestsPerSecond

public RethrottleRequest 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.

validate

public ActionRequestValidationException validate()

readFrom

public void readFrom(StreamInput in)
              throws java.io.IOException

Throws:

java.io.IOException

writeTo

public void writeTo(StreamOutput out)
             throws java.io.IOException

Throws:

java.io.IOException