Class CatHealthRequestParameters
Request options for Health
https://opensearch.org/docs/latest/api-reference/cat/cat-health/
Implements
Inherited Members
Namespace: OpenSearch .Net.Specification.CatApi
Assembly: OpenSearch.Net.dll
Syntax
public class CatHealthRequestParameters : RequestParameters<CatHealthRequestParameters>, IRequestParametersProperties
| Edit this page View SourceDefaultHttpMethod
Declaration
public override HttpMethod DefaultHttpMethod { get; }Property Value
| Type | Description |
|---|---|
| Http |
Overrides
| Edit this page View SourceFormat
A short version of the Accept header, such as json or yaml.
Declaration
public string Format { get; set; }Property Value
| Type | Description |
|---|---|
| string |
Headers
A comma-separated list of column names to display.
Declaration
public string[] Headers { get; set; }Property Value
| Type | Description |
|---|---|
| string[] |
Help
Returns help information.
Declaration
public bool? Help { get; set; }Property Value
| Type | Description |
|---|---|
| bool? |
IncludeTimestamp
When true, returns HH:MM:SS and Unix epoch timestamps.
Declaration
public bool? IncludeTimestamp { get; set; }Property Value
| Type | Description |
|---|---|
| bool? |
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[] |
SupportsBody
Declaration
public override bool SupportsBody { get; }Property Value
| Type | Description |
|---|---|
| bool |
Overrides
| Edit this page View SourceVerbose
Enables verbose mode, which displays column headers.
Declaration
public bool? Verbose { get; set; }Property Value
| Type | Description |
|---|---|
| bool? |