Class CatMasterDescriptor

Descriptor for Master

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

Inheritance
object
RequestBase<CatMasterRequestParameters>
RequestDescriptorBase<CatMasterDescriptor, CatMasterRequestParameters, ICatMasterRequest>
CatMasterDescriptor
Implements
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class CatMasterDescriptor : RequestDescriptorBase<CatMasterDescriptor, CatMasterRequestParameters, ICatMasterRequest>, IDescriptor, ICatMasterRequest, IRequest<CatMasterRequestParameters>, IRequest
Remarks

Deprecated as of OpenSearch 2.0, use CatClusterManagerDescriptor instead

Methods

| Edit this page View Source

ClusterManagerTimeout(Time)

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

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

Headers(params string[])

A comma-separated list of column names to display.

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

Help(bool?)

Returns help information.

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

Local(bool?)

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

Declaration
public CatMasterDescriptor Local(bool? local = true)
Parameters
Type Name Description
bool? local
Returns
Type Description
CatMasterDescriptor
| 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 CatMasterDescriptor MasterTimeout(Time mastertimeout)
Parameters
Type Name Description
Time mastertimeout
Returns
Type Description
CatMasterDescriptor
| Edit this page View Source

SortByColumns(params string[])

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

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

Verbose(bool?)

Enables verbose mode, which displays column headers.

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

Implements

Extension Methods