Class CatTasksRequest

Request for Tasks

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

Inheritance

object

RequestBase<CatTasksRequestParameters>

PlainRequestBase<CatTasksRequestParameters>

CatTasksRequest

Implements

ICatTasksRequest

IRequest<CatTasksRequestParameters>

IRequest

Inherited Members

PlainRequestBase<CatTasksRequestParameters>.RequestConfiguration

PlainRequestBase<CatTasksRequestParameters>.ErrorTrace

PlainRequestBase<CatTasksRequestParameters>.FilterPath

PlainRequestBase<CatTasksRequestParameters>.Human

PlainRequestBase<CatTasksRequestParameters>.Pretty

PlainRequestBase<CatTasksRequestParameters>.SourceQueryString

RequestBase<CatTasksRequestParameters>.HttpMethod

RequestBase<CatTasksRequestParameters>.RequestState

RequestBase<CatTasksRequestParameters>.ContentType

RequestBase<CatTasksRequestParameters>.ResolveUrl(RouteValues, IConnectionSettingsValues)

RequestBase<CatTasksRequestParameters>.RequestDefaults(CatTasksRequestParameters)

RequestBase<CatTasksRequestParameters>.Q<TOut>(string)

RequestBase<CatTasksRequestParameters>.Q(string, object)

RequestBase<CatTasksRequestParameters>.SetAcceptHeader(string)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: OpenSearch.Client

Assembly: OpenSearch.Client.dll

Syntax

public class CatTasksRequest : PlainRequestBase<CatTasksRequestParameters>, ICatTasksRequest, IRequest<CatTasksRequestParameters>, IRequest

Properties

Actions

The task action names 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, such as json or yaml.

Declaration

public string Format { get; set; }

Property Value

Type	Description
string

Headers

A comma-separated list of column names to display.

Declaration

public string[] Headers { get; set; }

Property Value

Type	Description
string[]

Help

Returns help information.

Declaration

public bool? Help { get; set; }

Property Value

Type	Description
bool?

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[]

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

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

Declaration

public string[] SortByColumns { get; set; }

Property Value

Type	Description
string[]

Verbose

Enables verbose mode, which displays column headers.

Declaration

public bool? Verbose { get; set; }

Property Value

Type	Description
bool?

Implements

ICatTasksRequest

IRequest<TParameters>

IRequest

Extension Methods

SuffixExtensions.Suffix(object, string)