Class CatTasksRequest
Request for Tasks
https://opensearch.org/docs/latest/api-reference/cat/cat-tasks/
Inheritance
CatTasksRequest
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class CatTasksRequest : PlainRequestBase<CatTasksRequestParameters>, ICatTasksRequest, IRequest<CatTasksRequestParameters>, IRequest
Properties
| Edit this page View SourceActions
The task action names, which are used to limit the response.
Declaration
public string[] Actions { get; set; }
Property Value
Type | Description |
---|---|
string[] |
Detailed
If true
, the response includes detailed information about shard recoveries.
Declaration
public bool? Detailed { get; set; }
Property Value
Type | Description |
---|---|
bool? |
Format
A short version of the Accept header (for example, json
, yaml
).
Declaration
public string Format { get; set; }
Property Value
Type | Description |
---|---|
string |
Headers
Comma-separated list of column names to display.
Declaration
public string[] Headers { get; set; }
Property Value
Type | Description |
---|---|
string[] |
Help
Return help information.
Declaration
public bool? Help { get; set; }
Property Value
Type | Description |
---|---|
bool? |
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[] |
ParentTaskId
The parent task identifier, which is used to limit the response.
Declaration
public string ParentTaskId { get; set; }
Property Value
Type | Description |
---|---|
string |
Self
Declaration
protected ICatTasksRequest Self { get; }
Property Value
Type | Description |
---|---|
ICatTasksRequest |
SortByColumns
Comma-separated list of column names or column aliases to sort by.
Declaration
public string[] SortByColumns { get; set; }
Property Value
Type | Description |
---|---|
string[] |
Verbose
Verbose mode. Display column headers.
Declaration
public bool? Verbose { get; set; }
Property Value
Type | Description |
---|---|
bool? |