Class CatTasksRequestParameters

Request options for Tasks

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

Inheritance

object

RequestParameters<CatTasksRequestParameters>

CatTasksRequestParameters

Implements

IRequestParameters

Inherited Members

RequestParameters<CatTasksRequestParameters>.CustomResponseBuilder

RequestParameters<CatTasksRequestParameters>.QueryString

RequestParameters<CatTasksRequestParameters>.RequestConfiguration

RequestParameters<CatTasksRequestParameters>.ContainsQueryString(string)

RequestParameters<CatTasksRequestParameters>.GetQueryStringValue<TOut>(string)

RequestParameters<CatTasksRequestParameters>.GetResolvedQueryStringValue(string, IConnectionConfigurationValues)

RequestParameters<CatTasksRequestParameters>.SetQueryString(string, object)

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

RequestParameters<CatTasksRequestParameters>.Q(string, object)

RequestParameters<CatTasksRequestParameters>.SetAcceptHeader(string)

RequestParameters<CatTasksRequestParameters>.AcceptHeaderFromFormat(string)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: OpenSearch.Net.Specification.CatApi

Assembly: OpenSearch.Net.dll

Syntax

public class CatTasksRequestParameters : RequestParameters<CatTasksRequestParameters>, IRequestParameters

Properties

Actions

The task action names used to limit the response.

Declaration

public string[] Actions { get; set; }

Property Value

Type	Description
string[]

DefaultHttpMethod

Declaration

public override HttpMethod DefaultHttpMethod { get; }

Property Value

Type	Description
HttpMethod

Overrides

RequestParameters<CatTasksRequestParameters>.DefaultHttpMethod

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

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

SupportsBody

Declaration

public override bool SupportsBody { get; }

Property Value

Type	Description
bool

Overrides

RequestParameters<CatTasksRequestParameters>.SupportsBody

Verbose

Enables verbose mode, which displays column headers.

Declaration

public bool? Verbose { get; set; }

Property Value

Type	Description
bool?

Implements

IRequestParameters

Extension Methods

SuffixExtensions.Suffix(object, string)