Package org.opensearch.client.opensearch.core

Class UpdateByQueryRethrottleRequest

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch.core.UpdateByQueryRethrottleRequest

public class UpdateByQueryRethrottleRequest
extends RequestBase

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

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class org.opensearch.client.opensearch._types.RequestBase

RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static Endpoint<UpdateByQueryRethrottleRequest,UpdateByQueryRethrottleResponse,ErrorResponse>	_ENDPOINT	Endpoint "update_by_query_rethrottle".

Method Summary

Modifier and Type	Method	Description
static UpdateByQueryRethrottleRequest	of(java.util.function.Function<UpdateByQueryRethrottleRequest.Builder,ObjectBuilder<UpdateByQueryRethrottleRequest>> fn)
java.lang.Long	requestsPerSecond()	The throttle to set on this request in floating sub-requests per second.
java.lang.String	taskId()	Required - The task id to rethrottle

Methods inherited from class java.lang.Object

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

Field Detail

_ENDPOINT

public static final Endpoint<UpdateByQueryRethrottleRequest,UpdateByQueryRethrottleResponse,ErrorResponse> _ENDPOINT

Endpoint "update_by_query_rethrottle".

Method Detail

of

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

requestsPerSecond

@Nullable
public final java.lang.Long requestsPerSecond()

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 java.lang.String taskId()

Required - The task id to rethrottle

API name: task_id