Search Results for

    Show / Hide Table of Contents

    Class ClusterPendingTasksDescriptor

    Descriptor for PendingTasks

    https://opensearch.org/docs/latest

    Inheritance
    object
    RequestBase<ClusterPendingTasksRequestParameters>
    RequestDescriptorBase<ClusterPendingTasksDescriptor, ClusterPendingTasksRequestParameters, IClusterPendingTasksRequest>
    ClusterPendingTasksDescriptor
    Implements
    IDescriptor
    IClusterPendingTasksRequest
    IRequest<ClusterPendingTasksRequestParameters>
    IRequest
    Inherited Members
    RequestDescriptorBase<ClusterPendingTasksDescriptor, ClusterPendingTasksRequestParameters, IClusterPendingTasksRequest>.Self
    RequestDescriptorBase<ClusterPendingTasksDescriptor, ClusterPendingTasksRequestParameters, IClusterPendingTasksRequest>.Assign<TValue>(TValue, Action<IClusterPendingTasksRequest, TValue>)
    RequestDescriptorBase<ClusterPendingTasksDescriptor, ClusterPendingTasksRequestParameters, IClusterPendingTasksRequest>.Qs(string, object)
    RequestDescriptorBase<ClusterPendingTasksDescriptor, ClusterPendingTasksRequestParameters, IClusterPendingTasksRequest>.RequestConfiguration(Func<RequestConfigurationDescriptor, IRequestConfiguration>)
    RequestDescriptorBase<ClusterPendingTasksDescriptor, ClusterPendingTasksRequestParameters, IClusterPendingTasksRequest>.ErrorTrace(bool?)
    RequestDescriptorBase<ClusterPendingTasksDescriptor, ClusterPendingTasksRequestParameters, IClusterPendingTasksRequest>.FilterPath(params string[])
    RequestDescriptorBase<ClusterPendingTasksDescriptor, ClusterPendingTasksRequestParameters, IClusterPendingTasksRequest>.FilterPath(IEnumerable<string>)
    RequestDescriptorBase<ClusterPendingTasksDescriptor, ClusterPendingTasksRequestParameters, IClusterPendingTasksRequest>.Human(bool?)
    RequestDescriptorBase<ClusterPendingTasksDescriptor, ClusterPendingTasksRequestParameters, IClusterPendingTasksRequest>.Pretty(bool?)
    RequestDescriptorBase<ClusterPendingTasksDescriptor, ClusterPendingTasksRequestParameters, IClusterPendingTasksRequest>.SourceQueryString(string)
    RequestBase<ClusterPendingTasksRequestParameters>.HttpMethod
    RequestBase<ClusterPendingTasksRequestParameters>.RequestState
    RequestBase<ClusterPendingTasksRequestParameters>.ContentType
    RequestBase<ClusterPendingTasksRequestParameters>.ResolveUrl(RouteValues, IConnectionSettingsValues)
    RequestBase<ClusterPendingTasksRequestParameters>.RequestDefaults(ClusterPendingTasksRequestParameters)
    RequestBase<ClusterPendingTasksRequestParameters>.Q<TOut>(string)
    RequestBase<ClusterPendingTasksRequestParameters>.Q(string, object)
    RequestBase<ClusterPendingTasksRequestParameters>.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 ClusterPendingTasksDescriptor : RequestDescriptorBase<ClusterPendingTasksDescriptor, ClusterPendingTasksRequestParameters, IClusterPendingTasksRequest>, IDescriptor, IClusterPendingTasksRequest, IRequest<ClusterPendingTasksRequestParameters>, IRequest

    Methods

    | 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 ClusterPendingTasksDescriptor ClusterManagerTimeout(Time clustermanagertimeout)
    Parameters
    Type Name Description
    Time clustermanagertimeout
    Returns
    Type Description
    ClusterPendingTasksDescriptor
    Remarks

    Supported by OpenSearch servers of version 2.0.0 or greater.

    | Edit this page View Source

    Local(bool?)

    When true, the request retrieves information from the local node only. When false, information is retrieved from the cluster manager node.

    Declaration
    public ClusterPendingTasksDescriptor Local(bool? local = true)
    Parameters
    Type Name Description
    bool? local
    Returns
    Type Description
    ClusterPendingTasksDescriptor
    | 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 ClusterPendingTasksDescriptor MasterTimeout(Time mastertimeout)
    Parameters
    Type Name Description
    Time mastertimeout
    Returns
    Type Description
    ClusterPendingTasksDescriptor

    Implements

    IDescriptor
    IClusterPendingTasksRequest
    IRequest<TParameters>
    IRequest

    Extension Methods

    SuffixExtensions.Suffix(object, string)
    • Edit this page
    • View Source
    In this article
    • Methods
      • ClusterManagerTimeout(Time)
      • Local(bool?)
      • MasterTimeout(Time)
    • Implements
    • Extension Methods
    Back to top Generated by DocFX