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

Changes the number of requests per second for a particular Update By Query operation.

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)
final Float	requestsPerSecond()	The throttle for this request in sub-requests per second.
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

@Nullable
public final Float requestsPerSecond()

The throttle for this request in sub-requests per second.

API name: requests_per_second

taskId

public final String taskId()

Required - The ID for the task.

API name: task_id