Class CatClusterManagerDescriptor

Descriptor for ClusterManager

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

Inheritance
object
RequestBase<CatClusterManagerRequestParameters>
RequestDescriptorBase<CatClusterManagerDescriptor, CatClusterManagerRequestParameters, ICatClusterManagerRequest>
CatClusterManagerDescriptor
Implements
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class CatClusterManagerDescriptor : RequestDescriptorBase<CatClusterManagerDescriptor, CatClusterManagerRequestParameters, ICatClusterManagerRequest>, IDescriptor, ICatClusterManagerRequest, IRequest<CatClusterManagerRequestParameters>, IRequest
Remarks

Introduced in OpenSearch 2.0 instead of CatMasterDescriptor

Methods

| Edit this page View Source

ClusterManagerTimeout(Time)

Operation timeout for connection to cluster-manager node.

Declaration
public CatClusterManagerDescriptor ClusterManagerTimeout(Time clustermanagertimeout)
Parameters
Type Name Description
Time clustermanagertimeout
Returns
Type Description
CatClusterManagerDescriptor
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, e.g. json, yaml.

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

Headers(params string[])

Comma-separated list of column names to display.

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

Help(bool?)

Return help information.

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

Local(bool?)

Return local information, do not retrieve the state from cluster-manager node.

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

MasterTimeout(Time)

Operation timeout for connection to master node.

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

SortByColumns(params string[])

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

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

Verbose(bool?)

Verbose mode. Display column headers.

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

Implements

Extension Methods