Package co.elastic.clients.elasticsearch.core

Class ReindexRethrottleRequest.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>

co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<ReindexRethrottleRequest.Builder>

co.elastic.clients.elasticsearch.core.ReindexRethrottleRequest.Builder

All Implemented Interfaces:

WithJson<ReindexRethrottleRequest.Builder>, ObjectBuilder<ReindexRethrottleRequest>

Enclosing class:

ReindexRethrottleRequest

public static class ReindexRethrottleRequest.Builder
extends RequestBase.AbstractBuilder<ReindexRethrottleRequest.Builder>
implements ObjectBuilder<ReindexRethrottleRequest>

Builder for ReindexRethrottleRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ReindexRethrottleRequest	build()	Builds a ReindexRethrottleRequest.
final ReindexRethrottleRequest.Builder	groupBy(GroupBy value)	The way to group the tasks in the response.
final ReindexRethrottleRequest.Builder	requestsPerSecond(float value)	Required - The maximum number of documents to index per second, across the entire reindex operation (including slices).
protected ReindexRethrottleRequest.Builder	self()
final ReindexRethrottleRequest.Builder	taskId(String value)	Required - The task identifier, returned when creating a reindex task, or by listing tasks via GET /_reindex or GET /_tasks.

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

groupBy

public final ReindexRethrottleRequest.Builder groupBy(@Nullable
 GroupBy value)

The way to group the tasks in the response. We recommend setting this to none, which provides the cleanest response format.

API name: group_by

requestsPerSecond

public final ReindexRethrottleRequest.Builder requestsPerSecond(float value)

Required - The maximum number of documents to index per second, across the entire reindex operation (including slices). It can be either -1 to turn off throttling or any decimal number like 1.7 or 12 to throttle to that level.

API name: requests_per_second

taskId

public final ReindexRethrottleRequest.Builder taskId(String value)

Required - The task identifier, returned when creating a reindex task, or by listing tasks via GET /_reindex or GET /_tasks. In stack, can be either the original task ID or the task ID of the relocated task.

API name: task_id

self

protected ReindexRethrottleRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<ReindexRethrottleRequest.Builder>

build

public ReindexRethrottleRequest build()

Builds a ReindexRethrottleRequest.

Specified by:

build in interface ObjectBuilder<ReindexRethrottleRequest>

Throws:

NullPointerException - if some of the required fields are null.