Package org.opensearch.client

Class RethrottleRequest

java.lang.Object

org.opensearch.client.RethrottleRequest

All Implemented Interfaces:

Validatable

public class RethrottleRequest
extends java.lang.Object
implements Validatable

A request changing throttling of a task.

Field Summary

Fields inherited from interface org.opensearch.client.Validatable

EMPTY

Constructor Summary

Constructors

Constructor	Description
RethrottleRequest(org.opensearch.tasks.TaskId taskId)	Create a new RethrottleRequest which disables any throttling for the given taskId.
RethrottleRequest(org.opensearch.tasks.TaskId taskId, float requestsPerSecond)	Create a new RethrottleRequest which changes the throttling for the given taskId.

Method Summary

Modifier and Type	Method	Description
float	getRequestsPerSecond()
org.opensearch.tasks.TaskId	getTaskId()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.client.Validatable

validate

Constructor Detail

RethrottleRequest

public RethrottleRequest(org.opensearch.tasks.TaskId taskId)

Create a new RethrottleRequest which disables any throttling for the given taskId.

Parameters:

taskId - the task for which throttling will be disabled

RethrottleRequest

public RethrottleRequest(org.opensearch.tasks.TaskId taskId,
                         float requestsPerSecond)

Create a new RethrottleRequest which changes the throttling for the given taskId.

Parameters:

taskId - the task that throttling changes will be applied to

requestsPerSecond - the number of requests per second that the task should perform. This needs to be a positive value.

Method Detail

getTaskId

public org.opensearch.tasks.TaskId getTaskId()

Returns:

the task Id

getRequestsPerSecond

public float getRequestsPerSecond()

Returns:

the requests per seconds value

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object