Class CatCountDescriptor

Descriptor for Count

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

Inheritance
object
RequestBase<CatCountRequestParameters>
RequestDescriptorBase<CatCountDescriptor, CatCountRequestParameters, ICatCountRequest>
CatCountDescriptor
Implements
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class CatCountDescriptor : RequestDescriptorBase<CatCountDescriptor, CatCountRequestParameters, ICatCountRequest>, IDescriptor, ICatCountRequest, IRequest<CatCountRequestParameters>, IRequest

Constructors

| Edit this page View Source

CatCountDescriptor()

/_cat/count

Declaration
public CatCountDescriptor()
| Edit this page View Source

CatCountDescriptor(Indices)

/_cat/count/{index}

Declaration
public CatCountDescriptor(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 CatCountDescriptor AllIndices()
Returns
Type Description
CatCountDescriptor
| Edit this page View Source

Format(string)

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

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

Headers(params string[])

Comma-separated list of column names to display.

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

Help(bool?)

Return help information.

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

Index(Indices)

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

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

Index<TOther>()

a shortcut into calling Index(typeof(TOther))

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

SortByColumns(params string[])

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

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

Verbose(bool?)

Verbose mode. Display column headers.

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

Implements

Extension Methods