Class CatPendingTasksDescriptor

Descriptor for PendingTasks

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

Inheritance
object
RequestBase<CatPendingTasksRequestParameters>
RequestDescriptorBase<CatPendingTasksDescriptor, CatPendingTasksRequestParameters, ICatPendingTasksRequest>
CatPendingTasksDescriptor
Implements
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class CatPendingTasksDescriptor : RequestDescriptorBase<CatPendingTasksDescriptor, CatPendingTasksRequestParameters, ICatPendingTasksRequest>, IDescriptor, ICatPendingTasksRequest, IRequest<CatPendingTasksRequestParameters>, IRequest

Methods

| Edit this page View Source

ClusterManagerTimeout(Time)

The amount of time allowed to establish a connection to the cluster manager node.

Declaration
public CatPendingTasksDescriptor ClusterManagerTimeout(Time clustermanagertimeout)
Parameters
Type Name Description
Time clustermanagertimeout
Returns
Type Description
CatPendingTasksDescriptor
Remarks

Supported by OpenSearch servers of version 2.0.0 or greater.

| Edit this page View Source

Format(string)

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

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

Headers(params string[])

A comma-separated list of column names to display.

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

Help(bool?)

Returns help information.

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

Local(bool?)

Returns local information but does not retrieve the state from the cluster manager node.

Declaration
public CatPendingTasksDescriptor Local(bool? local = true)
Parameters
Type Name Description
bool? local
Returns
Type Description
CatPendingTasksDescriptor
| Edit this page View Source

MasterTimeout(Time)

The amount of time allowed to establish a connection to the cluster manager node.

Declaration
[Obsolete("Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead.")]
public CatPendingTasksDescriptor MasterTimeout(Time mastertimeout)
Parameters
Type Name Description
Time mastertimeout
Returns
Type Description
CatPendingTasksDescriptor
| Edit this page View Source

SortByColumns(params string[])

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

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

Verbose(bool?)

Enables verbose mode, which displays column headers.

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

Implements

Extension Methods