Class CatTasksRequestParameters

Request options for Tasks

<p>https://docs.opensearch.org/latest/api-reference/cat/cat-tasks/</p>
Inheritance
object
RequestParameters<CatTasksRequestParameters>
CatTasksRequestParameters
Implements
Inherited Members
Namespace: OpenSearch.Net.Specification.CatApi
Assembly: OpenSearch.Net.dll
Syntax
public class CatTasksRequestParameters : RequestParameters<CatTasksRequestParameters>, IRequestParameters

Properties

| Edit this page View Source

Actions

The task action names used to limit the response.

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

Format

A short version of the Accept header, such as json or yaml.

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

Headers

A comma-separated list of column names to display.

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

Help

Returns help information.

Declaration
public bool? Help { get; set; }
Property Value
Type Description
bool?
| 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 to which you're connecting, specify a specific node from which to get information, 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

OperationName

The OpenSearch REST API operation name this request maps to (for example search or indices.create), used as the OpenTelemetry span name and db.operation tag. null for requests that do not correspond to a named API operation.

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

ParentTaskId

The parent task identifier, which is used to limit the response.

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

SortByColumns

A comma-separated list of column names or column aliases to sort by.

Declaration
public string[] SortByColumns { 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

Verbose

Enables verbose mode, which displays column headers.

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

Implements

Extension Methods