Package org.opensearch.client.opensearch.tasks

Class ListRequest

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch.tasks.ListRequest

public class ListRequest
extends RequestBase

Returns a list of tasks.

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class org.opensearch.client.opensearch._types.RequestBase

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

Field Summary

Fields

Modifier and Type	Field	Description
static Endpoint<ListRequest,ListResponse,ErrorResponse>	_ENDPOINT	Endpoint "tasks.list".

Method Summary

Modifier and Type	Method	Description
java.util.List<java.lang.String>	actions()	A comma-separated list of actions that should be returned.
java.lang.Boolean	detailed()	Return detailed task information (default: false)
GroupBy	groupBy()	Group tasks by nodes or parent/child relationships
java.util.List<java.lang.String>	nodes()	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
static ListRequest	of(java.util.function.Function<ListRequest.Builder,ObjectBuilder<ListRequest>> fn)
java.lang.String	parentTaskId()	Return tasks with specified parent task id (node_id:task_number).
Time	timeout()	Explicit operation timeout
java.lang.Boolean	waitForCompletion()	Wait for the matching tasks to complete (default: false)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

_ENDPOINT

public static final Endpoint<ListRequest,ListResponse,ErrorResponse> _ENDPOINT

Endpoint "tasks.list".

Method Detail

of

public static ListRequest of(java.util.function.Function<ListRequest.Builder,ObjectBuilder<ListRequest>> fn)

actions

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

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

API name: actions

detailed

@Nullable
public final java.lang.Boolean detailed()

Return detailed task information (default: false)

API name: detailed

groupBy

@Nullable
public final GroupBy groupBy()

Group tasks by nodes or parent/child relationships

API name: group_by

nodes

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

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

parentTaskId

@Nullable
public final java.lang.String parentTaskId()

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

API name: parent_task_id

timeout

@Nullable
public final Time timeout()

Explicit operation timeout

API name: timeout

waitForCompletion

@Nullable
public final java.lang.Boolean waitForCompletion()

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

API name: wait_for_completion