Class ListTasksDescriptor

Descriptor for List

https://opensearch.org/docs/latest/api-reference/tasks/

Inheritance
object
RequestBase<ListTasksRequestParameters>
RequestDescriptorBase<ListTasksDescriptor, ListTasksRequestParameters, IListTasksRequest>
ListTasksDescriptor
Implements
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class ListTasksDescriptor : RequestDescriptorBase<ListTasksDescriptor, ListTasksRequestParameters, IListTasksRequest>, IDescriptor, IListTasksRequest, IRequest<ListTasksRequestParameters>, IRequest

Methods

| Edit this page View Source

Actions(params string[])

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

Declaration
public ListTasksDescriptor Actions(params string[] actions)
Parameters
Type Name Description
string[] actions
Returns
Type Description
ListTasksDescriptor
| Edit this page View Source

Detailed(bool?)

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

Declaration
public ListTasksDescriptor Detailed(bool? detailed = true)
Parameters
Type Name Description
bool? detailed
Returns
Type Description
ListTasksDescriptor
| Edit this page View Source

GroupBy(TasksGroupBy?)

Groups tasks by parent/child relationships or nodes.

Declaration
public ListTasksDescriptor GroupBy(TasksGroupBy? groupby)
Parameters
Type Name Description
TasksGroupBy? groupby
Returns
Type Description
ListTasksDescriptor
| Edit this page View Source

Nodes(params string[])

A comma-separated list of node IDs or names used to limit the returned information. Use _local to return information from the node you're connecting to, specify the node name to get information from a specific node, or keep the parameter empty to get information from all nodes.

Declaration
public ListTasksDescriptor Nodes(params string[] nodes)
Parameters
Type Name Description
string[] nodes
Returns
Type Description
ListTasksDescriptor
| Edit this page View Source

ParentTaskId(string)

Returns tasks with a specified parent task ID (node_id:task_number). Keep empty or set to -1 to return all.

Declaration
public ListTasksDescriptor ParentTaskId(string parenttaskid)
Parameters
Type Name Description
string parenttaskid
Returns
Type Description
ListTasksDescriptor
| Edit this page View Source

Timeout(Time)

The amount of time to wait for a response.

Declaration
public ListTasksDescriptor Timeout(Time timeout)
Parameters
Type Name Description
Time timeout
Returns
Type Description
ListTasksDescriptor
| Edit this page View Source

WaitForCompletion(bool?)

Waits for the matching task to complete. When true, the request is blocked until the task has completed.

Declaration
public ListTasksDescriptor WaitForCompletion(bool? waitforcompletion = true)
Parameters
Type Name Description
bool? waitforcompletion
Returns
Type Description
ListTasksDescriptor

Implements

Extension Methods