Package org.elasticsearch.client
Class RethrottleRequest
java.lang.Object
org.elasticsearch.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.elasticsearch.client.Validatable
EMPTY
-
Constructor Summary
Constructors Constructor Description RethrottleRequest(org.elasticsearch.tasks.TaskId taskId)
Create a newRethrottleRequest
which disables any throttling for the given taskId.RethrottleRequest(org.elasticsearch.tasks.TaskId taskId, float requestsPerSecond)
Create a newRethrottleRequest
which changes the throttling for the given taskId. -
Method Summary
Modifier and Type Method Description float
getRequestsPerSecond()
org.elasticsearch.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.elasticsearch.client.Validatable
validate
-
Constructor Details
-
RethrottleRequest
public RethrottleRequest(org.elasticsearch.tasks.TaskId taskId)Create a newRethrottleRequest
which disables any throttling for the given taskId.- Parameters:
taskId
- the task for which throttling will be disabled
-
RethrottleRequest
public RethrottleRequest(org.elasticsearch.tasks.TaskId taskId, float requestsPerSecond)Create a newRethrottleRequest
which changes the throttling for the given taskId.- Parameters:
taskId
- the task that throttling changes will be applied torequestsPerSecond
- the number of requests per second that the task should perform. This needs to be a positive value.
-
-
Method Details
-
getTaskId
public org.elasticsearch.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 classjava.lang.Object
-