Class CatRecoveryRequest

Request for Recovery

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

Inheritance
object
RequestBase<CatRecoveryRequestParameters>
PlainRequestBase<CatRecoveryRequestParameters>
CatRecoveryRequest
Implements
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class CatRecoveryRequest : PlainRequestBase<CatRecoveryRequestParameters>, ICatRecoveryRequest, IRequest<CatRecoveryRequestParameters>, IRequest

Constructors

| Edit this page View Source

CatRecoveryRequest()

/_cat/recovery

Declaration
public CatRecoveryRequest()
| Edit this page View Source

CatRecoveryRequest(Indices)

/_cat/recovery/{index}

Declaration
public CatRecoveryRequest(Indices index)
Parameters
Type Name Description
Indices index

Optional, accepts null

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 units used to display byte values.

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

Detailed

When true, 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, such as json or yaml.

Declaration
public string Format { get; set; }
Property Value
Type Description
string
| Edit this page View Source

Headers

A 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

Returns help information.

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

Self

Declaration
protected ICatRecoveryRequest Self { get; }
Property Value
Type Description
ICatRecoveryRequest
| Edit this page View Source

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[]
| Edit this page View Source

Verbose

Enables verbose mode, which displays column headers.

Declaration
public bool? Verbose { get; set; }
Property Value
Type Description
bool?

Implements

Extension Methods