Package co.elastic.clients.elasticsearch.core

Class UpdateByQueryRethrottleRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.core.UpdateByQueryRethrottleRequest

public class UpdateByQueryRethrottleRequest
extends RequestBase

Throttle an update by query operation.

Change the number of requests per second for a particular update by query operation. Rethrottling that speeds up the query takes effect immediately but rethrotting that slows down the query takes effect after completing the current batch to prevent scroll timeouts.

See Also:

• API specification

Nested Class Summary

Nested Classes

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

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<UpdateByQueryRethrottleRequest,UpdateByQueryRethrottleResponse,ErrorResponse>	_ENDPOINT	Endpoint "update_by_query_rethrottle".

Method Summary

Modifier and Type	Method	Description
static UpdateByQueryRethrottleRequest	of(Function<UpdateByQueryRethrottleRequest.Builder,ObjectBuilder<UpdateByQueryRethrottleRequest>> fn)
UpdateByQueryRethrottleRequest.Builder	rebuild()
final float	requestsPerSecond()	Required - The maximum number of documents to update per second, across the entire update_by_query operation (including slices).
final String	taskId()	Required - The ID for the task.

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<UpdateByQueryRethrottleRequest,UpdateByQueryRethrottleResponse,ErrorResponse> _ENDPOINT

Endpoint "update_by_query_rethrottle".

Method Details

of

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

requestsPerSecond

public final float requestsPerSecond()

Required - The maximum number of documents to update per second, across the entire update_by_query operation (including slices). 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 ID for the task.

API name: task_id

rebuild

public UpdateByQueryRethrottleRequest.Builder rebuild()

Returns:

New UpdateByQueryRethrottleRequest.Builder initialized with field values of this instance