org.elasticsearch.index.reindex

Class RethrottleRequest

java.lang.Object

org.elasticsearch.common.ContextAndHeaderHolder

org.elasticsearch.transport.TransportMessage<TransportRequest>

org.elasticsearch.transport.TransportRequest

org.elasticsearch.action.ActionRequest<T>

org.elasticsearch.action.support.tasks.BaseTasksRequest<RethrottleRequest>

org.elasticsearch.index.reindex.RethrottleRequest

All Implemented Interfaces:

HasContext, HasContextAndHeaders, HasHeaders, Streamable

public class RethrottleRequest
extends BaseTasksRequest<RethrottleRequest>

A request to change throttling on a task.

Nested Class Summary

Nested classes/interfaces inherited from class org.elasticsearch.transport.TransportRequest

TransportRequest.Empty

Field Summary

Fields inherited from class org.elasticsearch.action.support.tasks.BaseTasksRequest

ALL_ACTIONS, ALL_NODES, ALL_TASKS

Fields inherited from class org.elasticsearch.common.ContextAndHeaderHolder

headers

Constructor Summary

Constructors

Constructor and Description
RethrottleRequest()

Method Summary

Methods

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 org.elasticsearch.action.support.tasks.BaseTasksRequest

getActions, getNodesIds, getParentTaskId, getTaskId, getTimeout, match, setActions, setNodesIds, setParentTaskId, setTaskId, setTimeout, setTimeout

Methods inherited from class org.elasticsearch.transport.TransportRequest

createTask, getDescription

Methods inherited from class org.elasticsearch.transport.TransportMessage

remoteAddress, remoteAddress

Methods inherited from class org.elasticsearch.common.ContextAndHeaderHolder

contextSize, copyContextAndHeadersFrom, copyContextFrom, copyHeadersFrom, getContext, getFromContext, getFromContext, getHeader, getHeaders, hasHeader, hasInContext, isContextEmpty, putAllInContext, putHeader, putInContext

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()

Overrides:

validate in class BaseTasksRequest<RethrottleRequest>

readFrom

public void readFrom(StreamInput in)
              throws IOException

Specified by:

readFrom in interface Streamable

Overrides:

readFrom in class BaseTasksRequest<RethrottleRequest>

Throws:

IOException

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Streamable

Overrides:

writeTo in class BaseTasksRequest<RethrottleRequest>

Throws:

IOException