Package org.opensearch.client.opensearch.core

Class UpdateByQueryRethrottleRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch._types.RequestBase.AbstractBuilder<UpdateByQueryRethrottleRequest.Builder>

org.opensearch.client.opensearch.core.UpdateByQueryRethrottleRequest.Builder

All Implemented Interfaces:

CopyableBuilder<UpdateByQueryRethrottleRequest.Builder,UpdateByQueryRethrottleRequest>, MutableBuilder<UpdateByQueryRethrottleRequest.Builder,UpdateByQueryRethrottleRequest>, ObjectBuilder<UpdateByQueryRethrottleRequest>

Enclosing class:

UpdateByQueryRethrottleRequest

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

Builder for UpdateByQueryRethrottleRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
UpdateByQueryRethrottleRequest	build()	Builds a UpdateByQueryRethrottleRequest.
UpdateByQueryRethrottleRequest.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
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 org.opensearch.client.opensearch._types.RequestBase.AbstractBuilder

errorTrace, human

Methods inherited from class org.opensearch.client.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _listCopy, _mapCopy, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.client.util.MutableBuilder

applyMutation

Constructor Details

Builder

public Builder()

Method Details

copy

@Nonnull
public UpdateByQueryRethrottleRequest.Builder copy()

Description copied from interface: CopyableBuilder

Create a new builder CopyableBuilder that is a copy of this one.

Specified by:

copy in interface CopyableBuilder<UpdateByQueryRethrottleRequest.Builder,UpdateByQueryRethrottleRequest>

Returns:

a new builder instance.

self

@Nonnull
protected UpdateByQueryRethrottleRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<UpdateByQueryRethrottleRequest.Builder>

requestsPerSecond

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

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

API name: requests_per_second

taskId

@Nonnull
public final UpdateByQueryRethrottleRequest.Builder taskId(String value)

Required - The ID for the task.

API name: task_id

build

@Nonnull
public UpdateByQueryRethrottleRequest build()

Builds a UpdateByQueryRethrottleRequest.

Specified by:

build in interface ObjectBuilder<UpdateByQueryRethrottleRequest>

Throws:

NullPointerException - if some of the required fields are null.