Class ListTasksRequestParameters

Request options for List

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

Inheritance
object
RequestParameters<ListTasksRequestParameters>
ListTasksRequestParameters
Implements
Inherited Members
Namespace: OpenSearch.Net.Specification.TasksApi
Assembly: OpenSearch.Net.dll
Syntax
public class ListTasksRequestParameters : RequestParameters<ListTasksRequestParameters>, IRequestParameters

Properties

| Edit this page View Source

Actions

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

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

DefaultHttpMethod

Declaration
public override HttpMethod DefaultHttpMethod { get; }
Property Value
Type Description
HttpMethod
Overrides
| Edit this page View Source

Detailed

If 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

Key used to group tasks in the response.

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

Nodes

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

ParentTaskId

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

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

SupportsBody

Declaration
public override bool SupportsBody { get; }
Property Value
Type Description
bool
Overrides
| Edit this page View Source

Timeout

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

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

WaitForCompletion

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

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

Implements

Extension Methods