Search Results for

    Show / Hide Table of Contents

    Class LowLevelNeuralNamespace

    Neural APIs.

    Not intended to be instantiated directly. Use the Neural property on IOpenSearchLowLevelClient.

    Inheritance
    object
    NamespacedClientProxy
    LowLevelNeuralNamespace
    Inherited Members
    NamespacedClientProxy.DoRequest<TResponse>(HttpMethod, string, PostData, IRequestParameters)
    NamespacedClientProxy.DoRequestAsync<TResponse>(HttpMethod, string, CancellationToken, PostData, IRequestParameters)
    NamespacedClientProxy.Url(FormattableString)
    NamespacedClientProxy.RequestParams<TRequestParams>(TRequestParams, string)
    NamespacedClientProxy.RequestParams<TRequestParams>(TRequestParams)
    NamespacedClientProxy.ContentType
    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 LowLevelNeuralNamespace : NamespacedClientProxy

    Methods

    | Edit this page View Source

    StatsAsync<TResponse>(string, StatsRequestParameters, CancellationToken)

    GET on /_plugins/_neural/{node_id}/stats

    Declaration
    public Task<TResponse> StatsAsync<TResponse>(string nodeId, StatsRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()
    Parameters
    Type Name Description
    string nodeId

    A comma-separated list of node IDs or names to limit the returned information; leave empty to get information from all nodes.

    StatsRequestParameters requestParameters

    Request specific configuration such as querystring parameters & request specific connection settings.

    CancellationToken ctx
    Returns
    Type Description
    Task<TResponse>
    Type Parameters
    Name Description
    TResponse
    Remarks

    Supported by OpenSearch servers of version 3.0.0 or greater.

    | Edit this page View Source

    StatsAsync<TResponse>(string, NeuralStatName?, StatsRequestParameters, CancellationToken)

    GET on /_plugins/_neural/{node_id}/stats/{stat}

    Declaration
    public Task<TResponse> StatsAsync<TResponse>(string nodeId, NeuralStatName? stat, StatsRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()
    Parameters
    Type Name Description
    string nodeId

    A comma-separated list of node IDs or names to limit the returned information; leave empty to get information from all nodes.

    NeuralStatName? stat

    A comma-separated list of stats to retrieve; use empty string to retrieve all stats.

    StatsRequestParameters requestParameters

    Request specific configuration such as querystring parameters & request specific connection settings.

    CancellationToken ctx
    Returns
    Type Description
    Task<TResponse>
    Type Parameters
    Name Description
    TResponse
    Remarks

    Supported by OpenSearch servers of version 3.0.0 or greater.

    | Edit this page View Source

    StatsForAllAsync<TResponse>(StatsRequestParameters, CancellationToken)

    GET on /_plugins/_neural/stats

    Declaration
    public Task<TResponse> StatsForAllAsync<TResponse>(StatsRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()
    Parameters
    Type Name Description
    StatsRequestParameters requestParameters

    Request specific configuration such as querystring parameters & request specific connection settings.

    CancellationToken ctx
    Returns
    Type Description
    Task<TResponse>
    Type Parameters
    Name Description
    TResponse
    Remarks

    Supported by OpenSearch servers of version 3.0.0 or greater.

    | Edit this page View Source

    StatsForAllAsync<TResponse>(NeuralStatName?, StatsRequestParameters, CancellationToken)

    GET on /_plugins/_neural/stats/{stat}

    Declaration
    public Task<TResponse> StatsForAllAsync<TResponse>(NeuralStatName? stat, StatsRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()
    Parameters
    Type Name Description
    NeuralStatName? stat

    A comma-separated list of stats to retrieve; use empty string to retrieve all stats.

    StatsRequestParameters requestParameters

    Request specific configuration such as querystring parameters & request specific connection settings.

    CancellationToken ctx
    Returns
    Type Description
    Task<TResponse>
    Type Parameters
    Name Description
    TResponse
    Remarks

    Supported by OpenSearch servers of version 3.0.0 or greater.

    | Edit this page View Source

    StatsForAll<TResponse>(StatsRequestParameters)

    GET on /_plugins/_neural/stats

    Declaration
    public TResponse StatsForAll<TResponse>(StatsRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()
    Parameters
    Type Name Description
    StatsRequestParameters requestParameters

    Request specific configuration such as querystring parameters & request specific connection settings.

    Returns
    Type Description
    TResponse
    Type Parameters
    Name Description
    TResponse
    Remarks

    Supported by OpenSearch servers of version 3.0.0 or greater.

    | Edit this page View Source

    StatsForAll<TResponse>(NeuralStatName?, StatsRequestParameters)

    GET on /_plugins/_neural/stats/{stat}

    Declaration
    public TResponse StatsForAll<TResponse>(NeuralStatName? stat, StatsRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()
    Parameters
    Type Name Description
    NeuralStatName? stat

    A comma-separated list of stats to retrieve; use empty string to retrieve all stats.

    StatsRequestParameters requestParameters

    Request specific configuration such as querystring parameters & request specific connection settings.

    Returns
    Type Description
    TResponse
    Type Parameters
    Name Description
    TResponse
    Remarks

    Supported by OpenSearch servers of version 3.0.0 or greater.

    | Edit this page View Source

    Stats<TResponse>(string, StatsRequestParameters)

    GET on /_plugins/_neural/{node_id}/stats

    Declaration
    public TResponse Stats<TResponse>(string nodeId, StatsRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()
    Parameters
    Type Name Description
    string nodeId

    A comma-separated list of node IDs or names to limit the returned information; leave empty to get information from all nodes.

    StatsRequestParameters requestParameters

    Request specific configuration such as querystring parameters & request specific connection settings.

    Returns
    Type Description
    TResponse
    Type Parameters
    Name Description
    TResponse
    Remarks

    Supported by OpenSearch servers of version 3.0.0 or greater.

    | Edit this page View Source

    Stats<TResponse>(string, NeuralStatName?, StatsRequestParameters)

    GET on /_plugins/_neural/{node_id}/stats/{stat}

    Declaration
    public TResponse Stats<TResponse>(string nodeId, NeuralStatName? stat, StatsRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()
    Parameters
    Type Name Description
    string nodeId

    A comma-separated list of node IDs or names to limit the returned information; leave empty to get information from all nodes.

    NeuralStatName? stat

    A comma-separated list of stats to retrieve; use empty string to retrieve all stats.

    StatsRequestParameters requestParameters

    Request specific configuration such as querystring parameters & request specific connection settings.

    Returns
    Type Description
    TResponse
    Type Parameters
    Name Description
    TResponse
    Remarks

    Supported by OpenSearch servers of version 3.0.0 or greater.

    Extension Methods

    SuffixExtensions.Suffix(object, string)
    • Edit this page
    • View Source
    In this article
    • Methods
      • StatsAsync<TResponse>(string, StatsRequestParameters, CancellationToken)
      • StatsAsync<TResponse>(string, NeuralStatName?, StatsRequestParameters, CancellationToken)
      • StatsForAllAsync<TResponse>(StatsRequestParameters, CancellationToken)
      • StatsForAllAsync<TResponse>(NeuralStatName?, StatsRequestParameters, CancellationToken)
      • StatsForAll<TResponse>(StatsRequestParameters)
      • StatsForAll<TResponse>(NeuralStatName?, StatsRequestParameters)
      • Stats<TResponse>(string, StatsRequestParameters)
      • Stats<TResponse>(string, NeuralStatName?, StatsRequestParameters)
    • Extension Methods
    Back to top Generated by DocFX