Package org.opensearch.client.opensearch.tasks

Class ListRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.tasks.ListRequest.Builder

All Implemented Interfaces:

ObjectBuilder<ListRequest>

Enclosing class:

ListRequest

public static class ListRequest.Builder
extends ObjectBuilderBase
implements ObjectBuilder<ListRequest>

Builder for ListRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ListRequest.Builder	actions(java.lang.String value, java.lang.String... values)	A comma-separated list of actions that should be returned.
ListRequest.Builder	actions(java.util.List<java.lang.String> list)	A comma-separated list of actions that should be returned.
ListRequest	build()	Builds a ListRequest.
ListRequest.Builder	detailed(java.lang.Boolean value)	Return detailed task information (default: false)
ListRequest.Builder	groupBy(GroupBy value)	Group tasks by nodes or parent/child relationships
ListRequest.Builder	nodes(java.lang.String value, java.lang.String... values)	A comma-separated list of node IDs or names to limit the returned information; use _local to return information from the node you're connecting to, leave empty to get information from all nodes
ListRequest.Builder	nodes(java.util.List<java.lang.String> list)	A comma-separated list of node IDs or names to limit the returned information; use _local to return information from the node you're connecting to, leave empty to get information from all nodes
ListRequest.Builder	parentTaskId(java.lang.String value)	Return tasks with specified parent task id (node_id:task_number).
ListRequest.Builder	timeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)	Explicit operation timeout
ListRequest.Builder	timeout(Time value)	Explicit operation timeout
ListRequest.Builder	waitForCompletion(java.lang.Boolean value)	Wait for the matching tasks to complete (default: false)

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 ListRequest.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 ListRequest.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 ListRequest.Builder detailed(@Nullable
                                          java.lang.Boolean value)

Return detailed task information (default: false)

API name: detailed

groupBy

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

Group tasks by nodes or parent/child relationships

API name: group_by

nodes

public final ListRequest.Builder nodes(java.util.List<java.lang.String> list)

A comma-separated list of node IDs or names to limit the returned information; use _local to return information from the node you're connecting to, leave empty to get information from all nodes

API name: nodes

Adds all elements of list to nodes.

nodes

public final ListRequest.Builder nodes(java.lang.String value,
                                       java.lang.String... values)

A comma-separated list of node IDs or names to limit the returned information; use _local to return information from the node you're connecting to, leave empty to get information from all nodes

API name: nodes

Adds one or more values to nodes.

parentTaskId

public final ListRequest.Builder parentTaskId(@Nullable
                                              java.lang.String value)

Return tasks with specified parent task id (node_id:task_number). Set to -1 to return all.

API name: parent_task_id

timeout

public final ListRequest.Builder timeout(@Nullable
                                         Time value)

Explicit operation timeout

API name: timeout

timeout

public final ListRequest.Builder timeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)

Explicit operation timeout

API name: timeout

waitForCompletion

public final ListRequest.Builder waitForCompletion(@Nullable
                                                   java.lang.Boolean value)

Wait for the matching tasks to complete (default: false)

API name: wait_for_completion

build

public ListRequest build()

Builds a ListRequest.

Specified by:

build in interface ObjectBuilder<ListRequest>

Throws:

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