Package co.elastic.clients.elasticsearch.core

Class DeleteByQueryRethrottleRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.core.DeleteByQueryRethrottleRequest

All Implemented Interfaces:

ElasticsearchCommonRequest

public final class DeleteByQueryRethrottleRequest
extends RequestBase

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase

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

Field Summary

Fields

Modifier and Type	Field	Description
static Endpoint<DeleteByQueryRethrottleRequest,DeleteByQueryRethrottleResponse,ElasticsearchError>	ENDPOINT	Endpoint "delete_by_query_rethrottle".

Constructor Summary

Constructors

Constructor	Description
DeleteByQueryRethrottleRequest(DeleteByQueryRethrottleRequest.Builder builder)
DeleteByQueryRethrottleRequest(java.util.function.Function<DeleteByQueryRethrottleRequest.Builder,DeleteByQueryRethrottleRequest.Builder> fn)

Method Summary

Modifier and Type	Method	Description
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 Details

ENDPOINT

public static final Endpoint<DeleteByQueryRethrottleRequest,DeleteByQueryRethrottleResponse,ElasticsearchError> ENDPOINT

Endpoint "delete_by_query_rethrottle".

Constructor Details

DeleteByQueryRethrottleRequest

public DeleteByQueryRethrottleRequest(DeleteByQueryRethrottleRequest.Builder builder)

DeleteByQueryRethrottleRequest

public DeleteByQueryRethrottleRequest(java.util.function.Function<DeleteByQueryRethrottleRequest.Builder,DeleteByQueryRethrottleRequest.Builder> fn)

Method Details

taskId

public java.lang.String taskId()

Required - The task id to rethrottle

API name: task_id

requestsPerSecond

@Nullable
public 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