Class CatHealthDescriptor

Descriptor for Health

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

Inheritance
object
RequestBase<CatHealthRequestParameters>
RequestDescriptorBase<CatHealthDescriptor, CatHealthRequestParameters, ICatHealthRequest>
CatHealthDescriptor
Implements
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class CatHealthDescriptor : RequestDescriptorBase<CatHealthDescriptor, CatHealthRequestParameters, ICatHealthRequest>, IDescriptor, ICatHealthRequest, IRequest<CatHealthRequestParameters>, IRequest

Methods

| Edit this page View Source

Format(string)

A short version of the Accept header, such as json or yaml.

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

Headers(params string[])

A comma-separated list of column names to display.

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

Help(bool?)

Returns help information.

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

IncludeTimestamp(bool?)

When true, returns HH:MM:SS and Unix epoch timestamps.

Declaration
public CatHealthDescriptor IncludeTimestamp(bool? includetimestamp = true)
Parameters
Type Name Description
bool? includetimestamp
Returns
Type Description
CatHealthDescriptor
| Edit this page View Source

SortByColumns(params string[])

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

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

Verbose(bool?)

Enables verbose mode, which displays column headers.

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

Implements

Extension Methods