Class ShardsRequestParameters

Request options for Shards

<p>https://docs.opensearch.org/latest/api-reference/list/list-shards/</p>
Inheritance
object
RequestParameters<ShardsRequestParameters>
ShardsRequestParameters
Implements
Inherited Members
Namespace: OpenSearch.Net.Specification.ListApi
Assembly: OpenSearch.Net.dll
Syntax
public class ShardsRequestParameters : RequestParameters<ShardsRequestParameters>, IRequestParameters

Properties

| 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

ClusterManagerTimeout

Operation timeout for connection to cluster-manager node.

Declaration
public TimeSpan ClusterManagerTimeout { get; set; }
Property Value
Type Description
TimeSpan
Remarks

Supported by OpenSearch servers of version 2.0.0 or greater.

| Edit this page View Source

DefaultHttpMethod

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

Format

A short version of the Accept header, such as JSON, YAML.

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

Return help information.

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

Local

Return local information, do not retrieve the state from cluster-manager node.

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

MasterTimeout

Operation timeout for connection to cluster-manager node.

Declaration
[Obsolete("Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead.")]
public TimeSpan MasterTimeout { get; set; }
Property Value
Type Description
TimeSpan
| Edit this page View Source

NextToken

Token to retrieve next page of shards.

Declaration
public string NextToken { 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

Size

Maximum number of shards to be displayed in a page.

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

Sort

Defines order in which shards will be displayed. Accepted values are asc and desc. If desc, most recently created shards would be displayed first.

Declaration
public SortOrder? Sort { get; set; }
Property Value
Type Description
SortOrder?
| 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

Verbose mode. Display column headers.

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

Implements

Extension Methods