Package co.elastic.clients.elasticsearch.cat

Class TasksRequest.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

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

co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<BuilderT>

co.elastic.clients.elasticsearch.cat.CatRequestBase.AbstractBuilder<TasksRequest.Builder>

co.elastic.clients.elasticsearch.cat.TasksRequest.Builder

All Implemented Interfaces:

WithJson<TasksRequest.Builder>, ObjectBuilder<TasksRequest>

Enclosing class:

TasksRequest

public static class TasksRequest.Builder
extends CatRequestBase.AbstractBuilder<TasksRequest.Builder>
implements ObjectBuilder<TasksRequest>

Builder for TasksRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final TasksRequest.Builder	actions(String value, String... values)	The task action names, which are used to limit the response.
final TasksRequest.Builder	actions(List<String> list)	The task action names, which are used to limit the response.
TasksRequest	build()	Builds a TasksRequest.
final TasksRequest.Builder	detailed(Boolean value)	If true, the response includes detailed information about shard recoveries.
final TasksRequest.Builder	nodeId(String value, String... values)	Unique node identifiers, which are used to limit the response.
final TasksRequest.Builder	nodeId(List<String> list)	Unique node identifiers, which are used to limit the response.
final TasksRequest.Builder	parentTaskId(String value)	The parent task identifier, which is used to limit the response.
protected TasksRequest.Builder	self()

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

actions

public final TasksRequest.Builder actions(List<String> list)

The task action names, which are used to limit the response.

API name: actions

Adds all elements of list to actions.

actions

public final TasksRequest.Builder actions(String value,
 String... values)

The task action names, which are used to limit the response.

API name: actions

Adds one or more values to actions.

detailed

public final TasksRequest.Builder detailed(@Nullable
 Boolean value)

If true, the response includes detailed information about shard recoveries.

API name: detailed

nodeId

public final TasksRequest.Builder nodeId(List<String> list)

Unique node identifiers, which are used to limit the response.

API name: node_id

Adds all elements of list to nodeId.

nodeId

public final TasksRequest.Builder nodeId(String value,
 String... values)

Unique node identifiers, which are used to limit the response.

API name: node_id

Adds one or more values to nodeId.

parentTaskId

public final TasksRequest.Builder parentTaskId(@Nullable
 String value)

The parent task identifier, which is used to limit the response.

API name: parent_task_id

self

protected TasksRequest.Builder self()

Specified by:

self in class CatRequestBase.AbstractBuilder<TasksRequest.Builder>

build

public TasksRequest build()

Builds a TasksRequest.

Specified by:

build in interface ObjectBuilder<TasksRequest>

Throws:

NullPointerException - if some of the required fields are null.