Package co.elastic.clients.elasticsearch.core

Class UpdateByQueryRethrottleRequest.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>

co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<UpdateByQueryRethrottleRequest.Builder>

co.elastic.clients.elasticsearch.core.UpdateByQueryRethrottleRequest.Builder

All Implemented Interfaces:

WithJson<UpdateByQueryRethrottleRequest.Builder>, ObjectBuilder<UpdateByQueryRethrottleRequest>

Enclosing class:

UpdateByQueryRethrottleRequest

public static class UpdateByQueryRethrottleRequest.Builder
extends RequestBase.AbstractBuilder<UpdateByQueryRethrottleRequest.Builder>
implements ObjectBuilder<UpdateByQueryRethrottleRequest>

Builder for UpdateByQueryRethrottleRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
UpdateByQueryRethrottleRequest	build()	Builds a UpdateByQueryRethrottleRequest.
final UpdateByQueryRethrottleRequest.Builder	requestsPerSecond(Float value)	The throttle for this request in sub-requests per second.
protected UpdateByQueryRethrottleRequest.Builder	self()
final UpdateByQueryRethrottleRequest.Builder	taskId(String value)	Required - The ID for the task.

Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase

withJson

Methods inherited from class co.elastic.clients.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

Methods inherited from interface co.elastic.clients.json.WithJson

withJson, withJson

Constructor Details

Builder

public Builder()

Method Details

requestsPerSecond

public final UpdateByQueryRethrottleRequest.Builder requestsPerSecond(@Nullable
 Float value)

The throttle for this request in sub-requests per second. To turn off throttling, set it to -1.

API name: requests_per_second

taskId

public final UpdateByQueryRethrottleRequest.Builder taskId(String value)

Required - The ID for the task.

API name: task_id

self

protected UpdateByQueryRethrottleRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<UpdateByQueryRethrottleRequest.Builder>

build

public UpdateByQueryRethrottleRequest build()

Builds a UpdateByQueryRethrottleRequest.

Specified by:

build in interface ObjectBuilder<UpdateByQueryRethrottleRequest>

Throws:

NullPointerException - if some of the required fields are null.