Class CatRecoveryRequestParameters

Request options for Recovery

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

Inheritance

object

RequestParameters<CatRecoveryRequestParameters>

CatRecoveryRequestParameters

Implements

IRequestParameters

Inherited Members

RequestParameters<CatRecoveryRequestParameters>.CustomResponseBuilder

RequestParameters<CatRecoveryRequestParameters>.QueryString

RequestParameters<CatRecoveryRequestParameters>.RequestConfiguration

RequestParameters<CatRecoveryRequestParameters>.ContainsQueryString(string)

RequestParameters<CatRecoveryRequestParameters>.GetQueryStringValue<TOut>(string)

RequestParameters<CatRecoveryRequestParameters>.GetResolvedQueryStringValue(string, IConnectionConfigurationValues)

RequestParameters<CatRecoveryRequestParameters>.SetQueryString(string, object)

RequestParameters<CatRecoveryRequestParameters>.Q<TOut>(string)

RequestParameters<CatRecoveryRequestParameters>.Q(string, object)

RequestParameters<CatRecoveryRequestParameters>.SetAcceptHeader(string)

RequestParameters<CatRecoveryRequestParameters>.AcceptHeaderFromFormat(string)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: OpenSearch.Net.Specification.CatApi

Assembly: OpenSearch.Net.dll

Syntax

public class CatRecoveryRequestParameters : RequestParameters<CatRecoveryRequestParameters>, IRequestParameters

Properties

ActiveOnly

If true, the response only includes ongoing shard recoveries.

Declaration

public bool? ActiveOnly { get; set; }

Property Value

Type	Description
bool?

Bytes

The units used to display byte values.

Declaration

public ByteUnit? Bytes { get; set; }

Property Value

Type	Description
ByteUnit?

DefaultHttpMethod

Declaration

public override HttpMethod DefaultHttpMethod { get; }

Property Value

Type	Description
HttpMethod

Overrides

RequestParameters<CatRecoveryRequestParameters>.DefaultHttpMethod

Detailed

When true, includes detailed information about shard recoveries.

Declaration

public bool? Detailed { get; set; }

Property Value

Type	Description
bool?

Format

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?

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[]

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

RequestParameters<CatRecoveryRequestParameters>.SupportsBody

Verbose

Enables verbose mode, which displays column headers.

Declaration

public bool? Verbose { get; set; }

Property Value

Type	Description
bool?

Implements

IRequestParameters

Extension Methods

SuffixExtensions.Suffix(object, string)