Search Results for

    Show / Hide Table of Contents

    Class StatsRequestParameters

    Request options for Stats

    Inheritance
    object
    RequestParameters<StatsRequestParameters>
    StatsRequestParameters
    Implements
    IRequestParameters
    Inherited Members
    RequestParameters<StatsRequestParameters>.CustomResponseBuilder
    RequestParameters<StatsRequestParameters>.QueryString
    RequestParameters<StatsRequestParameters>.RequestConfiguration
    RequestParameters<StatsRequestParameters>.ContainsQueryString(string)
    RequestParameters<StatsRequestParameters>.GetQueryStringValue<TOut>(string)
    RequestParameters<StatsRequestParameters>.GetResolvedQueryStringValue(string, IConnectionConfigurationValues)
    RequestParameters<StatsRequestParameters>.SetQueryString(string, object)
    RequestParameters<StatsRequestParameters>.Q<TOut>(string)
    RequestParameters<StatsRequestParameters>.Q(string, object)
    RequestParameters<StatsRequestParameters>.SetAcceptHeader(string)
    RequestParameters<StatsRequestParameters>.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.NeuralApi
    Assembly: OpenSearch.Net.dll
    Syntax
    public class StatsRequestParameters : RequestParameters<StatsRequestParameters>, IRequestParameters

    Properties

    | Edit this page View Source

    DefaultHttpMethod

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

    FlatStatPaths

    Whether to return stats in the flat form, which can improve readability, especially for heavily nested stats. For example, the flat form of "processors": { "ingest": { "text_embedding_executions": 20181212 } } is "processors.ingest.text_embedding_executions": "20181212".

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

    IncludeAllNodes

    When true includes aggregated statistics across all nodes in the all_nodes category. When false, excludes the all_nodes category from the response.

    Declaration
    public bool? IncludeAllNodes { get; set; }
    Property Value
    Type Description
    bool?
    Remarks

    Supported by OpenSearch servers of version 3.1.0 or greater.

    | Edit this page View Source

    IncludeIndividualNodes

    When true includes statistics for individual nodes in the nodes category. When false, excludes the nodes category from the response.

    Declaration
    public bool? IncludeIndividualNodes { get; set; }
    Property Value
    Type Description
    bool?
    Remarks

    Supported by OpenSearch servers of version 3.1.0 or greater.

    | Edit this page View Source

    IncludeInfo

    When true includes cluster-wide information in the info category. When false, excludes the info category from the response.

    Declaration
    public bool? IncludeInfo { get; set; }
    Property Value
    Type Description
    bool?
    Remarks

    Supported by OpenSearch servers of version 3.1.0 or greater.

    | Edit this page View Source

    IncludeMetadata

    Whether to return stat metadata instead of the raw stat value, includes additional information about the stat. These can include things like type hints, time since last stats being recorded, or recent rolling interval values.

    Declaration
    public bool? IncludeMetadata { 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<StatsRequestParameters>.SupportsBody

    Implements

    IRequestParameters

    Extension Methods

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