Class CatHealthRequest

Request for Health

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

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

Properties

| 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

IncludeTimestamp

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

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

Self

Declaration
protected ICatHealthRequest Self { get; }
Property Value
Type Description
ICatHealthRequest
| 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