Package org.opensearch.client.opensearch.core

Class UpdateByQueryRethrottleRequest

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch.core.UpdateByQueryRethrottleRequest

All Implemented Interfaces:

ToCopyableBuilder<UpdateByQueryRethrottleRequest.Builder,UpdateByQueryRethrottleRequest>

@Generated("org.opensearch.client.codegen.CodeGenerator")
public final class UpdateByQueryRethrottleRequest
extends RequestBase
implements ToCopyableBuilder<UpdateByQueryRethrottleRequest.Builder,UpdateByQueryRethrottleRequest>

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 final Endpoint<UpdateByQueryRethrottleRequest,UpdateByQueryRethrottleResponse,ErrorResponse>	_ENDPOINT	Endpoint "update_by_query_rethrottle".

Method Summary

Modifier and Type	Method	Description
protected void	applyQueryParameters(Map<String,String> params)
static UpdateByQueryRethrottleRequest.Builder	builder()
boolean	equals(Object o)
int	hashCode()
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.
UpdateByQueryRethrottleRequest.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Methods inherited from class org.opensearch.client.opensearch._types.RequestBase

errorTrace, human

Methods inherited from class java.lang.Object

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

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

copy

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

@Nonnull
public final String taskId()

Required - The ID for the task.

API name: task_id

toBuilder

@Nonnull
public UpdateByQueryRethrottleRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<UpdateByQueryRethrottleRequest.Builder,UpdateByQueryRethrottleRequest>

Returns:

a new builder instance.

builder

@Nonnull
public static UpdateByQueryRethrottleRequest.Builder builder()

applyQueryParameters

protected void applyQueryParameters(@Nonnull
 Map<String,String> params)

Overrides:

applyQueryParameters in class RequestBase

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object