Package org.opensearch.client.opensearch.cat

Class TasksRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.cat.CatRequestBase.CatRequestBaseBuilder<TasksRequest.Builder>

org.opensearch.client.opensearch.cat.TasksRequest.Builder

All Implemented Interfaces:

ObjectBuilder

Enclosing class:

TasksRequest

public static class TasksRequest.Builder
extends CatRequestBase.CatRequestBaseBuilder<TasksRequest.Builder>

Builder for TasksRequest.

Field Summary

Fields inherited from class org.opensearch.client.opensearch.cat.CatRequestBase.CatRequestBaseBuilder

headers, sort

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
TasksRequest.Builder	actions(java.lang.String value, java.lang.String... values)	A comma-separated list of actions that should be returned.
TasksRequest.Builder	actions(java.util.List<java.lang.String> list)	A comma-separated list of actions that should be returned.
TasksRequest	build()	Builds a TasksRequest.
TasksRequest.Builder	detailed(java.lang.Boolean value)	Return detailed task information (default: false)
TasksRequest.Builder	nodeId(java.lang.String value, java.lang.String... values)	API name: node_id
TasksRequest.Builder	nodeId(java.util.List<java.lang.String> list)	API name: node_id
TasksRequest.Builder	parentTask(java.lang.Long value)	API name: parent_task
protected TasksRequest.Builder	self()

Methods inherited from class org.opensearch.client.opensearch.cat.CatRequestBase.CatRequestBaseBuilder

headers, sort

Methods inherited from class org.opensearch.client.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

Constructor Detail

Builder

public Builder()

Method Detail

actions

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

A comma-separated list of actions that should be returned. Leave empty to return all.

API name: actions

Adds all elements of list to actions.

actions

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

A comma-separated list of actions that should be returned. Leave empty to return all.

API name: actions

Adds one or more values to actions.

detailed

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

Return detailed task information (default: false)

API name: detailed

nodeId

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

API name: node_id

Adds all elements of list to nodeId.

nodeId

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

API name: node_id

Adds one or more values to nodeId.

parentTask

public final TasksRequest.Builder parentTask(@Nullable
                                             java.lang.Long value)

API name: parent_task

build

public TasksRequest build()

Builds a TasksRequest.

Throws:

java.lang.NullPointerException - if some of the required fields are null.

self

protected TasksRequest.Builder self()

Specified by:

self in class CatRequestBase.CatRequestBaseBuilder<TasksRequest.Builder>