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.
UpdateByQueryRethrottleRequest.Builder	requestsPerSecond(java.lang.Float value)	The throttle to set on this request in floating sub-requests per second.
protected UpdateByQueryRethrottleRequest.Builder	self()
UpdateByQueryRethrottleRequest.Builder	taskId(java.lang.String value)	Required - The task id to rethrottle

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
java.lang.Float value)

The throttle to set on this request in floating sub-requests per second. -1 means set no throttle.

API name: requests_per_second

taskId

public final UpdateByQueryRethrottleRequest.Builder taskId(java.lang.String value)

Required - The task id to rethrottle

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:

java.lang.NullPointerException - if some of the required fields are null.