Class CatShardsDescriptor

Descriptor for Shards

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

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

Constructors

| Edit this page View Source

CatShardsDescriptor()

/_cat/shards

Declaration
public CatShardsDescriptor()
| Edit this page View Source

CatShardsDescriptor(Indices)

/_cat/shards/{index}

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

Optional, accepts null

Methods

| Edit this page View Source

AllIndices()

A shortcut into calling Index(Indices.All)

Declaration
public CatShardsDescriptor AllIndices()
Returns
Type Description
CatShardsDescriptor
| Edit this page View Source

Bytes(ByteUnit?)

The unit used to display byte values.

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

ClusterManagerTimeout(Time)

Operation timeout for connection to cluster-manager node.

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

Headers(params string[])

Comma-separated list of column names to display.

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

Help(bool?)

Return help information.

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

Index(Indices)

A comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indices, omit this parameter or use * or _all.

Declaration
public CatShardsDescriptor Index(Indices index)
Parameters
Type Name Description
Indices index
Returns
Type Description
CatShardsDescriptor
| Edit this page View Source

Index<TOther>()

a shortcut into calling Index(typeof(TOther))

Declaration
public CatShardsDescriptor Index<TOther>() where TOther : class
Returns
Type Description
CatShardsDescriptor
Type Parameters
Name Description
TOther
| Edit this page View Source

Local(bool?)

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

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

SortByColumns(params string[])

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

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

Verbose(bool?)

Verbose mode. Display column headers.

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

Implements

Extension Methods