Class CatTasksDescriptor

Descriptor for Tasks

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

Inheritance
object
RequestBase<CatTasksRequestParameters>
RequestDescriptorBase<CatTasksDescriptor, CatTasksRequestParameters, ICatTasksRequest>
CatTasksDescriptor
Implements
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class CatTasksDescriptor : RequestDescriptorBase<CatTasksDescriptor, CatTasksRequestParameters, ICatTasksRequest>, IDescriptor, ICatTasksRequest, IRequest<CatTasksRequestParameters>, IRequest

Methods

| Edit this page View Source

Actions(params string[])

The task action names used to limit the response.

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

Detailed(bool?)

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

Declaration
public CatTasksDescriptor Detailed(bool? detailed = true)
Parameters
Type Name Description
bool? detailed
Returns
Type Description
CatTasksDescriptor
| Edit this page View Source

Format(string)

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

Declaration
public CatTasksDescriptor Format(string format)
Parameters
Type Name Description
string format
Returns
Type Description
CatTasksDescriptor
| Edit this page View Source

Headers(params string[])

A comma-separated list of column names to display.

Declaration
public CatTasksDescriptor Headers(params string[] headers)
Parameters
Type Name Description
string[] headers
Returns
Type Description
CatTasksDescriptor
| Edit this page View Source

Help(bool?)

Returns help information.

Declaration
public CatTasksDescriptor Help(bool? help = true)
Parameters
Type Name Description
bool? help
Returns
Type Description
CatTasksDescriptor
| Edit this page View Source

Nodes(params string[])

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 CatTasksDescriptor Nodes(params string[] nodes)
Parameters
Type Name Description
string[] nodes
Returns
Type Description
CatTasksDescriptor
| Edit this page View Source

ParentTaskId(string)

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

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

SortByColumns(params string[])

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

Declaration
public CatTasksDescriptor SortByColumns(params string[] sortbycolumns)
Parameters
Type Name Description
string[] sortbycolumns
Returns
Type Description
CatTasksDescriptor
| Edit this page View Source

Verbose(bool?)

Enables verbose mode, which displays column headers.

Declaration
public CatTasksDescriptor Verbose(bool? verbose = true)
Parameters
Type Name Description
bool? verbose
Returns
Type Description
CatTasksDescriptor

Implements

Extension Methods