Class CatNodesDescriptor

Descriptor for Nodes

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

Inheritance
object
RequestBase<CatNodesRequestParameters>
RequestDescriptorBase<CatNodesDescriptor, CatNodesRequestParameters, ICatNodesRequest>
CatNodesDescriptor
Implements
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class CatNodesDescriptor : RequestDescriptorBase<CatNodesDescriptor, CatNodesRequestParameters, ICatNodesRequest>, IDescriptor, ICatNodesRequest, IRequest<CatNodesRequestParameters>, IRequest

Methods

| Edit this page View Source

Bytes(ByteUnit?)

The units used to display byte values.

Declaration
public CatNodesDescriptor Bytes(ByteUnit? bytes)
Parameters
Type Name Description
ByteUnit? bytes
Returns
Type Description
CatNodesDescriptor
| Edit this page View Source

ClusterManagerTimeout(Time)

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

Declaration
public CatNodesDescriptor ClusterManagerTimeout(Time clustermanagertimeout)
Parameters
Type Name Description
Time clustermanagertimeout
Returns
Type Description
CatNodesDescriptor
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 CatNodesDescriptor Format(string format)
Parameters
Type Name Description
string format
Returns
Type Description
CatNodesDescriptor
| Edit this page View Source

FullId(bool?)

When true, returns the full node ID. When false, returns the shortened node ID.

Declaration
public CatNodesDescriptor FullId(bool? fullid = true)
Parameters
Type Name Description
bool? fullid
Returns
Type Description
CatNodesDescriptor
| Edit this page View Source

Headers(params string[])

A comma-separated list of column names to display.

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

Help(bool?)

Returns help information.

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

Local(bool?)

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

Declaration
[Obsolete("Deprecated as of: 1.0.0, reason: This parameter does not cause this API to act locally.")]
public CatNodesDescriptor Local(bool? local = true)
Parameters
Type Name Description
bool? local
Returns
Type Description
CatNodesDescriptor
| 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 CatNodesDescriptor MasterTimeout(Time mastertimeout)
Parameters
Type Name Description
Time mastertimeout
Returns
Type Description
CatNodesDescriptor
| Edit this page View Source

SortByColumns(params string[])

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

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

Verbose(bool?)

Enables verbose mode, which displays column headers.

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

Implements

Extension Methods