Search Results for

    Show / Hide Table of Contents

    Class ClusterStatsRequestParameters

    Request options for Stats

    https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-stats/

    Inheritance
    object
    RequestParameters<ClusterStatsRequestParameters>
    ClusterStatsRequestParameters
    Implements
    IRequestParameters
    Inherited Members
    RequestParameters<ClusterStatsRequestParameters>.CustomResponseBuilder
    RequestParameters<ClusterStatsRequestParameters>.QueryString
    RequestParameters<ClusterStatsRequestParameters>.RequestConfiguration
    RequestParameters<ClusterStatsRequestParameters>.ContainsQueryString(string)
    RequestParameters<ClusterStatsRequestParameters>.GetQueryStringValue<TOut>(string)
    RequestParameters<ClusterStatsRequestParameters>.GetResolvedQueryStringValue(string, IConnectionConfigurationValues)
    RequestParameters<ClusterStatsRequestParameters>.SetQueryString(string, object)
    RequestParameters<ClusterStatsRequestParameters>.Q<TOut>(string)
    RequestParameters<ClusterStatsRequestParameters>.Q(string, object)
    RequestParameters<ClusterStatsRequestParameters>.SetAcceptHeader(string)
    RequestParameters<ClusterStatsRequestParameters>.AcceptHeaderFromFormat(string)
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: OpenSearch.Net.Specification.ClusterApi
    Assembly: OpenSearch.Net.dll
    Syntax
    public class ClusterStatsRequestParameters : RequestParameters<ClusterStatsRequestParameters>, IRequestParameters

    Properties

    | Edit this page View Source

    DefaultHttpMethod

    Declaration
    public override HttpMethod DefaultHttpMethod { get; }
    Property Value
    Type Description
    HttpMethod
    Overrides
    RequestParameters<ClusterStatsRequestParameters>.DefaultHttpMethod
    | Edit this page View Source

    FlatSettings

    Whether to return settings in the flat form, which can improve readability, especially for heavily nested settings. For example, the flat form of "cluster": { "max_shards_per_node": 500 } is "cluster.max_shards_per_node": "500".

    Declaration
    public bool? FlatSettings { get; set; }
    Property Value
    Type Description
    bool?
    | Edit this page View Source

    SupportsBody

    Declaration
    public override bool SupportsBody { get; }
    Property Value
    Type Description
    bool
    Overrides
    RequestParameters<ClusterStatsRequestParameters>.SupportsBody
    | Edit this page View Source

    Timeout

    The amount of time to wait for each node to respond. If a node does not respond before its timeout expires, the response does not include its stats. However, timed out nodes are included in the response's _nodes.failed property. Defaults to no timeout.

    Declaration
    public TimeSpan Timeout { get; set; }
    Property Value
    Type Description
    TimeSpan

    Implements

    IRequestParameters

    Extension Methods

    SuffixExtensions.Suffix(object, string)
    • Edit this page
    • View Source
    In this article
    • Properties
      • DefaultHttpMethod
      • FlatSettings
      • SupportsBody
      • Timeout
    • Implements
    • Extension Methods
    Back to top Generated by DocFX