Class ClusterRerouteDescriptor

Descriptor for Reroute

https://opensearch.org/docs/latest

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

Methods

| Edit this page View Source

AllocateEmptyPrimary(Func<AllocateEmptyPrimaryRerouteCommandDescriptor, IAllocateEmptyPrimaryRerouteCommand>)

Declaration
public ClusterRerouteDescriptor AllocateEmptyPrimary(Func<AllocateEmptyPrimaryRerouteCommandDescriptor, IAllocateEmptyPrimaryRerouteCommand> selector)
Parameters
Type Name Description
Func<AllocateEmptyPrimaryRerouteCommandDescriptor, IAllocateEmptyPrimaryRerouteCommand> selector
Returns
Type Description
ClusterRerouteDescriptor
| Edit this page View Source

AllocateReplica(Func<AllocateReplicaClusterRerouteCommandDescriptor, IAllocateClusterRerouteCommand>)

Declaration
public ClusterRerouteDescriptor AllocateReplica(Func<AllocateReplicaClusterRerouteCommandDescriptor, IAllocateClusterRerouteCommand> selector)
Parameters
Type Name Description
Func<AllocateReplicaClusterRerouteCommandDescriptor, IAllocateClusterRerouteCommand> selector
Returns
Type Description
ClusterRerouteDescriptor
| Edit this page View Source

AllocateStalePrimary(Func<AllocateStalePrimaryRerouteCommandDescriptor, IAllocateStalePrimaryRerouteCommand>)

Declaration
public ClusterRerouteDescriptor AllocateStalePrimary(Func<AllocateStalePrimaryRerouteCommandDescriptor, IAllocateStalePrimaryRerouteCommand> selector)
Parameters
Type Name Description
Func<AllocateStalePrimaryRerouteCommandDescriptor, IAllocateStalePrimaryRerouteCommand> selector
Returns
Type Description
ClusterRerouteDescriptor
| Edit this page View Source

Cancel(Func<CancelClusterRerouteCommandDescriptor, ICancelClusterRerouteCommand>)

Declaration
public ClusterRerouteDescriptor Cancel(Func<CancelClusterRerouteCommandDescriptor, ICancelClusterRerouteCommand> selector)
Parameters
Type Name Description
Func<CancelClusterRerouteCommandDescriptor, ICancelClusterRerouteCommand> selector
Returns
Type Description
ClusterRerouteDescriptor
| Edit this page View Source

ClusterManagerTimeout(Time)

Operation timeout for connection to cluster-manager node.

Declaration
public ClusterRerouteDescriptor ClusterManagerTimeout(Time clustermanagertimeout)
Parameters
Type Name Description
Time clustermanagertimeout
Returns
Type Description
ClusterRerouteDescriptor
Remarks

Supported by OpenSearch servers of version 2.0.0 or greater.

| Edit this page View Source

DryRun(bool?)

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

Declaration
public ClusterRerouteDescriptor DryRun(bool? dryrun = true)
Parameters
Type Name Description
bool? dryrun
Returns
Type Description
ClusterRerouteDescriptor
| Edit this page View Source

Explain(bool?)

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

Declaration
public ClusterRerouteDescriptor Explain(bool? explain = true)
Parameters
Type Name Description
bool? explain
Returns
Type Description
ClusterRerouteDescriptor
| Edit this page View Source

MasterTimeout(Time)

Period to wait for a connection to the master 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 ClusterRerouteDescriptor MasterTimeout(Time mastertimeout)
Parameters
Type Name Description
Time mastertimeout
Returns
Type Description
ClusterRerouteDescriptor
| Edit this page View Source

Metric(ClusterRerouteMetric?)

Limits the information returned to the specified metrics.

Declaration
public ClusterRerouteDescriptor Metric(ClusterRerouteMetric? metric)
Parameters
Type Name Description
ClusterRerouteMetric? metric
Returns
Type Description
ClusterRerouteDescriptor
| Edit this page View Source

Move(Func<MoveClusterRerouteCommandDescriptor, IMoveClusterRerouteCommand>)

Declaration
public ClusterRerouteDescriptor Move(Func<MoveClusterRerouteCommandDescriptor, IMoveClusterRerouteCommand> selector)
Parameters
Type Name Description
Func<MoveClusterRerouteCommandDescriptor, IMoveClusterRerouteCommand> selector
Returns
Type Description
ClusterRerouteDescriptor
| Edit this page View Source

RetryFailed(bool?)

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

Declaration
public ClusterRerouteDescriptor RetryFailed(bool? retryfailed = true)
Parameters
Type Name Description
bool? retryfailed
Returns
Type Description
ClusterRerouteDescriptor
| Edit this page View Source

Timeout(Time)

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

Declaration
public ClusterRerouteDescriptor Timeout(Time timeout)
Parameters
Type Name Description
Time timeout
Returns
Type Description
ClusterRerouteDescriptor

Implements

Extension Methods