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[])

Comma-separated list or wildcard expression of actions used to limit the request.

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

Detailed(bool?)

If 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?)

Key used to group tasks in the response.

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

Nodes(params string[])

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.

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

ParentTaskId(string)

Parent task ID used to limit returned information. To return all tasks, omit this parameter or use a value of -1.

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

Timeout(Time)

Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.

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

WaitForCompletion(bool?)

If true, the request blocks until the operation is complete.

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

Implements

Extension Methods