Class CatMasterRequest

Request for Master

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

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

Deprecated as of OpenSearch 2.0, use CatClusterManagerRequest instead

Properties

| Edit this page View Source

ClusterManagerTimeout

Operation timeout for connection to cluster-manager node.

Declaration
public Time ClusterManagerTimeout { get; set; }
Property Value
Type Description
Time
Remarks

Supported by OpenSearch servers of version 2.0.0 or greater.

| Edit this page View Source

Format

A short version of the Accept header (for example, json, yaml).

Declaration
public string Format { get; set; }
Property Value
Type Description
string
| Edit this page View Source

Headers

Comma-separated list of column names to display.

Declaration
public string[] Headers { get; set; }
Property Value
Type Description
string[]
| Edit this page View Source

Help

Return help information.

Declaration
public bool? Help { get; set; }
Property Value
Type Description
bool?
| Edit this page View Source

Local

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

Declaration
public bool? Local { get; set; }
Property Value
Type Description
bool?
| Edit this page View Source

MasterTimeout

Operation timeout for connection to cluster-manager node.

Declaration
[Obsolete("Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead.")]
public Time MasterTimeout { get; set; }
Property Value
Type Description
Time
| Edit this page View Source

Self

Declaration
protected ICatMasterRequest Self { get; }
Property Value
Type Description
ICatMasterRequest
| Edit this page View Source

SortByColumns

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

Declaration
public string[] SortByColumns { get; set; }
Property Value
Type Description
string[]
| Edit this page View Source

Verbose

Verbose mode. Display column headers.

Declaration
public bool? Verbose { get; set; }
Property Value
Type Description
bool?

Implements

Extension Methods