Class CatShardsRequest

Request for Shards

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

Inheritance
object
RequestBase<CatShardsRequestParameters>
PlainRequestBase<CatShardsRequestParameters>
CatShardsRequest
Implements
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class CatShardsRequest : PlainRequestBase<CatShardsRequestParameters>, ICatShardsRequest, IRequest<CatShardsRequestParameters>, IRequest

Constructors

| Edit this page View Source

CatShardsRequest()

/_cat/shards

Declaration
public CatShardsRequest()
| Edit this page View Source

CatShardsRequest(Indices)

/_cat/shards/{index}

Declaration
public CatShardsRequest(Indices index)
Parameters
Type Name Description
Indices index

Optional, accepts null

Properties

| Edit this page View Source

Bytes

The units used to display byte values.

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

ClusterManagerTimeout

The amount of time allowed to establish a connection to the 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, such as json or yaml.

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

Headers

A 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

Returns help information.

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

Local

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

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

MasterTimeout

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 Time MasterTimeout { get; set; }
Property Value
Type Description
Time
| Edit this page View Source

Self

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

SortByColumns

A 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

Enables verbose mode, which displays column headers.

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

Implements

Extension Methods