Search Results for

    Show / Hide Table of Contents

    Class ClusterRerouteDescriptor

    Descriptor for Reroute

    https://opensearch.org/docs/latest

    Inheritance
    object
    RequestBase<ClusterRerouteRequestParameters>
    RequestDescriptorBase<ClusterRerouteDescriptor, ClusterRerouteRequestParameters, IClusterRerouteRequest>
    ClusterRerouteDescriptor
    Implements
    IDescriptor
    IClusterRerouteRequest
    IRequest<ClusterRerouteRequestParameters>
    IRequest
    Inherited Members
    RequestDescriptorBase<ClusterRerouteDescriptor, ClusterRerouteRequestParameters, IClusterRerouteRequest>.Self
    RequestDescriptorBase<ClusterRerouteDescriptor, ClusterRerouteRequestParameters, IClusterRerouteRequest>.Assign<TValue>(TValue, Action<IClusterRerouteRequest, TValue>)
    RequestDescriptorBase<ClusterRerouteDescriptor, ClusterRerouteRequestParameters, IClusterRerouteRequest>.Qs(string, object)
    RequestDescriptorBase<ClusterRerouteDescriptor, ClusterRerouteRequestParameters, IClusterRerouteRequest>.RequestConfiguration(Func<RequestConfigurationDescriptor, IRequestConfiguration>)
    RequestDescriptorBase<ClusterRerouteDescriptor, ClusterRerouteRequestParameters, IClusterRerouteRequest>.ErrorTrace(bool?)
    RequestDescriptorBase<ClusterRerouteDescriptor, ClusterRerouteRequestParameters, IClusterRerouteRequest>.FilterPath(params string[])
    RequestDescriptorBase<ClusterRerouteDescriptor, ClusterRerouteRequestParameters, IClusterRerouteRequest>.FilterPath(IEnumerable<string>)
    RequestDescriptorBase<ClusterRerouteDescriptor, ClusterRerouteRequestParameters, IClusterRerouteRequest>.Human(bool?)
    RequestDescriptorBase<ClusterRerouteDescriptor, ClusterRerouteRequestParameters, IClusterRerouteRequest>.Pretty(bool?)
    RequestDescriptorBase<ClusterRerouteDescriptor, ClusterRerouteRequestParameters, IClusterRerouteRequest>.SourceQueryString(string)
    RequestBase<ClusterRerouteRequestParameters>.HttpMethod
    RequestBase<ClusterRerouteRequestParameters>.RequestState
    RequestBase<ClusterRerouteRequestParameters>.ContentType
    RequestBase<ClusterRerouteRequestParameters>.ResolveUrl(RouteValues, IConnectionSettingsValues)
    RequestBase<ClusterRerouteRequestParameters>.RequestDefaults(ClusterRerouteRequestParameters)
    RequestBase<ClusterRerouteRequestParameters>.Q<TOut>(string)
    RequestBase<ClusterRerouteRequestParameters>.Q(string, object)
    RequestBase<ClusterRerouteRequestParameters>.SetAcceptHeader(string)
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    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)

    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 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?)

    When true, the request simulates the operation 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?)

    When true, the response contains an explanation of why reroute certain 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)

    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 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?)

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

    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 ClusterRerouteDescriptor Timeout(Time timeout)
    Parameters
    Type Name Description
    Time timeout
    Returns
    Type Description
    ClusterRerouteDescriptor

    Implements

    IDescriptor
    IClusterRerouteRequest
    IRequest<TParameters>
    IRequest

    Extension Methods

    SuffixExtensions.Suffix(object, string)
    • Edit this page
    • View Source
    In this article
    • Methods
      • AllocateEmptyPrimary(Func<AllocateEmptyPrimaryRerouteCommandDescriptor, IAllocateEmptyPrimaryRerouteCommand>)
      • AllocateReplica(Func<AllocateReplicaClusterRerouteCommandDescriptor, IAllocateClusterRerouteCommand>)
      • AllocateStalePrimary(Func<AllocateStalePrimaryRerouteCommandDescriptor, IAllocateStalePrimaryRerouteCommand>)
      • Cancel(Func<CancelClusterRerouteCommandDescriptor, ICancelClusterRerouteCommand>)
      • ClusterManagerTimeout(Time)
      • DryRun(bool?)
      • Explain(bool?)
      • MasterTimeout(Time)
      • Metric(ClusterRerouteMetric?)
      • Move(Func<MoveClusterRerouteCommandDescriptor, IMoveClusterRerouteCommand>)
      • RetryFailed(bool?)
      • Timeout(Time)
    • Implements
    • Extension Methods
    Back to top Generated by DocFX