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

The amount of time to wait for a response from the cluster manager node. For more information about supported time units, see Common parameters.

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

When true, the request simulates the operation and returns the resulting state.

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

Explain

When true, the response contains an explanation of why reroute certain commands can or cannot be executed.

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

MasterTimeout

A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts 0 without a unit and -1 to indicate an unspecified value.

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

When true, retries shard allocation if it was blocked because of too many subsequent 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

A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts 0 without a unit and -1 to indicate an unspecified value.

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

Implements

Extension Methods