Class ClusterRerouteRequest

Request for Reroute

https://opensearch.org/docs/latest

Inheritance
object
RequestBase<ClusterRerouteRequestParameters>
PlainRequestBase<ClusterRerouteRequestParameters>
ClusterRerouteRequest
Implements
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class ClusterRerouteRequest : PlainRequestBase<ClusterRerouteRequestParameters>, IClusterRerouteRequest, IRequest<ClusterRerouteRequestParameters>, IRequest

Properties

| Edit this page View Source

ClusterManagerTimeout

Operation timeout for connection to cluster-manager node.

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

Supported by OpenSearch servers of version 2.0.0 or greater.

| Edit this page View Source

Commands

Declaration
public IList<IClusterRerouteCommand> Commands { get; set; }
Property Value
Type Description
IList<IClusterRerouteCommand>
| 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 Time MasterTimeout { get; set; }
Property Value
Type Description
Time
| 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

Self

Declaration
protected IClusterRerouteRequest Self { get; }
Property Value
Type Description
IClusterRerouteRequest
| 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 Time Timeout { get; set; }
Property Value
Type Description
Time

Implements

Extension Methods