Package co.elastic.clients.elasticsearch.core

Class ReindexRethrottleRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.core.ReindexRethrottleRequest

public class ReindexRethrottleRequest
extends RequestBase

Throttle a reindex operation.

Change the number of requests per second for a particular reindex operation. For example:

 POST _reindex/r1A2WoRbTwKZ516z6NEs5A:36619/_rethrottle?requests_per_second=-1
 
 

Rethrottling that speeds up the query takes effect immediately. Rethrottling that slows down the query will take effect after completing the current batch. This behavior prevents scroll timeouts.

See Also:

• API specification

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ReindexRethrottleRequest.Builder	Builder for ReindexRethrottleRequest.

Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase

RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static final Endpoint<ReindexRethrottleRequest,ReindexRethrottleResponse,ErrorResponse>	_ENDPOINT	Endpoint "reindex_rethrottle".

Method Summary

Modifier and Type	Method	Description
static ReindexRethrottleRequest	of(Function<ReindexRethrottleRequest.Builder,ObjectBuilder<ReindexRethrottleRequest>> fn)
final Float	requestsPerSecond()	The throttle for this request in sub-requests per second.
final String	taskId()	Required - The task identifier, which can be found by using the tasks API.

Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase

toString

Methods inherited from class java.lang.Object

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

Field Details

_ENDPOINT

public static final Endpoint<ReindexRethrottleRequest,ReindexRethrottleResponse,ErrorResponse> _ENDPOINT

Endpoint "reindex_rethrottle".

Method Details

of

public static ReindexRethrottleRequest of(Function<ReindexRethrottleRequest.Builder,ObjectBuilder<ReindexRethrottleRequest>> fn)

requestsPerSecond

@Nullable
public final Float requestsPerSecond()

The throttle for this request in sub-requests per second. It can be either -1 to turn off throttling or any decimal number like 1.7 or 12 to throttle to that level.

API name: requests_per_second

taskId

public final String taskId()

Required - The task identifier, which can be found by using the tasks API.

API name: task_id