Package org.opensearch.index.reindex

Class RethrottleRequest

java.lang.Object

org.opensearch.core.transport.TransportMessage

org.opensearch.transport.TransportRequest

org.opensearch.action.ActionRequest

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

org.opensearch.index.reindex.RethrottleRequest

All Implemented Interfaces:

org.opensearch.core.common.io.stream.Writeable, TaskAwareRequest

public class RethrottleRequest
extends BaseTasksRequest<RethrottleRequest>

A request to change throttling on a task.

Nested Class Summary

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

TransportRequest.Empty

Nested classes/interfaces inherited from interface org.opensearch.core.common.io.stream.Writeable

org.opensearch.core.common.io.stream.Writeable.Reader<V>, org.opensearch.core.common.io.stream.Writeable.WriteableRegistry, org.opensearch.core.common.io.stream.Writeable.Writer<V>

Field Summary

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

ALL_ACTIONS, ALL_NODES

Constructor Summary

Constructors

Constructor	Description
RethrottleRequest()
RethrottleRequest(org.opensearch.core.common.io.stream.StreamInput in)

Method Summary

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

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

getActions, getNodes, getParentTaskId, getTaskId, getTimeout, match, setActions, setNodes, setParentTaskId, setTaskId, setTimeout, setTimeout

Methods inherited from class org.opensearch.action.ActionRequest

getShouldStoreResult

Methods inherited from class org.opensearch.transport.TransportRequest

getParentTask, setParentTask

Methods inherited from class org.opensearch.core.transport.TransportMessage

remoteAddress, remoteAddress

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.tasks.TaskAwareRequest

createTask, getDescription, setParentTask

Constructor Details

RethrottleRequest

public RethrottleRequest()

RethrottleRequest

public RethrottleRequest(org.opensearch.core.common.io.stream.StreamInput in)
                  throws IOException

Throws:

IOException

Method Details

writeTo

public void writeTo(org.opensearch.core.common.io.stream.StreamOutput out)
             throws IOException

Specified by:

writeTo in interface org.opensearch.core.common.io.stream.Writeable

Overrides:

writeTo in class BaseTasksRequest<RethrottleRequest>

Throws:

IOException

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>