Class ClusterRerouteRequestParameters

Request options for Reroute

https://opensearch.org/docs/latest

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

Properties

| 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

DryRun

If true, then the request simulates the operation only and returns the resulting state.

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

Explain

If true, then the response contains an explanation of why the commands can or cannot be executed.

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

MasterTimeout

Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error.

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

Metric

Limits the information returned to the specified metrics.

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

RetryFailed

If true, then retries allocation of shards that are blocked due to too many subsequent allocation failures.

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

SupportsBody

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

Timeout

Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.

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

Implements

Extension Methods