Class CatRecoveryRequestParameters

Request options for Recovery

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

Inheritance
object
RequestParameters<CatRecoveryRequestParameters>
CatRecoveryRequestParameters
Implements
Inherited Members
Namespace: OpenSearch.Net.Specification.CatApi
Assembly: OpenSearch.Net.dll
Syntax
public class CatRecoveryRequestParameters : RequestParameters<CatRecoveryRequestParameters>, IRequestParameters

Properties

| Edit this page View Source

ActiveOnly

If true, the response only includes ongoing shard recoveries.

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

Bytes

The unit used to display byte values.

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

DefaultHttpMethod

Declaration
public override HttpMethod DefaultHttpMethod { get; }
Property Value
Type Description
HttpMethod
Overrides
| Edit this page View Source

Detailed

If true, the response includes detailed information about shard recoveries.

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

Format

A short version of the Accept header, e.g. 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

Index

Comma-separated list or wildcard expression of index names to limit the returned information.

Declaration
public string[] Index { get; set; }
Property Value
Type Description
string[]
| 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

SupportsBody

Declaration
public override bool SupportsBody { get; }
Property Value
Type Description
bool
Overrides
| 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