Search Results for

    Show / Hide Table of Contents

    Class ClusterRerouteRequest

    Request for Reroute

    https://opensearch.org/docs/latest

    Inheritance
    object
    RequestBase<ClusterRerouteRequestParameters>
    PlainRequestBase<ClusterRerouteRequestParameters>
    ClusterRerouteRequest
    Implements
    IClusterRerouteRequest
    IRequest<ClusterRerouteRequestParameters>
    IRequest
    Inherited Members
    PlainRequestBase<ClusterRerouteRequestParameters>.RequestConfiguration
    PlainRequestBase<ClusterRerouteRequestParameters>.ErrorTrace
    PlainRequestBase<ClusterRerouteRequestParameters>.FilterPath
    PlainRequestBase<ClusterRerouteRequestParameters>.Human
    PlainRequestBase<ClusterRerouteRequestParameters>.Pretty
    PlainRequestBase<ClusterRerouteRequestParameters>.SourceQueryString
    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 ClusterRerouteRequest : PlainRequestBase<ClusterRerouteRequestParameters>, IClusterRerouteRequest, IRequest<ClusterRerouteRequestParameters>, IRequest

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

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

    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

    Self

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

    Implements

    IClusterRerouteRequest
    IRequest<TParameters>
    IRequest

    Extension Methods

    SuffixExtensions.Suffix(object, string)
    • Edit this page
    • View Source
    In this article
    • Properties
      • ClusterManagerTimeout
      • Commands
      • DryRun
      • Explain
      • MasterTimeout
      • Metric
      • RetryFailed
      • Self
      • Timeout
    • Implements
    • Extension Methods
    Back to top Generated by DocFX