Class ListTasksRequest

Request for List

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

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

Properties

| Edit this page View Source

Actions

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

Declaration
public string[] Actions { get; set; }
Property Value
Type Description
string[]
| Edit this page View Source

Detailed

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

Declaration
public bool? Detailed { get; set; }
Property Value
Type Description
bool?
| Edit this page View Source

GroupBy

Groups tasks by parent/child relationships or nodes.

Declaration
public TasksGroupBy? GroupBy { get; set; }
Property Value
Type Description
TasksGroupBy?
| Edit this page View Source

Nodes

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 string[] Nodes { get; set; }
Property Value
Type Description
string[]
| Edit this page View Source

ParentTaskId

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

Declaration
public string ParentTaskId { get; set; }
Property Value
Type Description
string
| Edit this page View Source

Self

Declaration
protected IListTasksRequest Self { get; }
Property Value
Type Description
IListTasksRequest
| Edit this page View Source

Timeout

The amount of time to wait for a response.

Declaration
public Time Timeout { get; set; }
Property Value
Type Description
Time
| Edit this page View Source

WaitForCompletion

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

Declaration
public bool? WaitForCompletion { get; set; }
Property Value
Type Description
bool?

Implements

Extension Methods