Class CatRecoveryRequestParameters

Request options for Recovery

<p>https://docs.opensearch.org/latest/api-reference/cat/cat-plugins/</p>
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 units 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

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 CatResponseFormat? Format { get; set; }
Property Value
Type Description
CatResponseFormat?
| 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

Index

A comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (). To target all data streams and indexes, omit this parameter or use or _all.

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

OperationName

The OpenSearch REST API operation name this request maps to (for example search or indices.create), used as the OpenTelemetry span name and db.operation tag. null for requests that do not correspond to a named API operation.

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

SupportsBody

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