Search Results for

    Show / Hide Table of Contents

    Class LowLevelNodesNamespace

    Nodes APIs.

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

    Inheritance
    object
    NamespacedClientProxy
    LowLevelNodesNamespace
    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.NodesApi
    Assembly: OpenSearch.Net.dll
    Syntax
    public class LowLevelNodesNamespace : NamespacedClientProxy

    Methods

    | Edit this page View Source

    HotThreadsAsync<TResponse>(string, NodesHotThreadsRequestParameters, CancellationToken)

    GET on /_nodes/{node_id}/hot_threads

    https://opensearch.org/docs/latest/api-reference/nodes-apis/nodes-hot-threads/

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

    Comma-separated list of node IDs or names to limit the returned information; use _local to return information from the node you're connecting to, leave empty to get information from all nodes.

    NodesHotThreadsRequestParameters requestParameters

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

    CancellationToken ctx
    Returns
    Type Description
    Task<TResponse>
    Type Parameters
    Name Description
    TResponse
    | Edit this page View Source

    HotThreadsForAllAsync<TResponse>(NodesHotThreadsRequestParameters, CancellationToken)

    GET on /_nodes/hot_threads

    https://opensearch.org/docs/latest/api-reference/nodes-apis/nodes-hot-threads/

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

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

    CancellationToken ctx
    Returns
    Type Description
    Task<TResponse>
    Type Parameters
    Name Description
    TResponse
    | Edit this page View Source

    HotThreadsForAll<TResponse>(NodesHotThreadsRequestParameters)

    GET on /_nodes/hot_threads

    https://opensearch.org/docs/latest/api-reference/nodes-apis/nodes-hot-threads/

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

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

    Returns
    Type Description
    TResponse
    Type Parameters
    Name Description
    TResponse
    | Edit this page View Source

    HotThreads<TResponse>(string, NodesHotThreadsRequestParameters)

    GET on /_nodes/{node_id}/hot_threads

    https://opensearch.org/docs/latest/api-reference/nodes-apis/nodes-hot-threads/

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

    Comma-separated list of node IDs or names to limit the returned information; use _local to return information from the node you're connecting to, leave empty to get information from all nodes.

    NodesHotThreadsRequestParameters requestParameters

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

    Returns
    Type Description
    TResponse
    Type Parameters
    Name Description
    TResponse
    | Edit this page View Source

    InfoAsync<TResponse>(string, NodesInfoRequestParameters, CancellationToken)

    GET on /_nodes/{node_id}

    https://opensearch.org/docs/latest/api-reference/nodes-apis/nodes-info/

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

    Comma-separated list of node IDs or names used to limit returned information.

    NodesInfoRequestParameters requestParameters

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

    CancellationToken ctx
    Returns
    Type Description
    Task<TResponse>
    Type Parameters
    Name Description
    TResponse
    | Edit this page View Source

    InfoAsync<TResponse>(string, string, NodesInfoRequestParameters, CancellationToken)

    GET on /_nodes/{node_id}/{metric}

    https://opensearch.org/docs/latest/api-reference/nodes-apis/nodes-info/

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

    Comma-separated list of node IDs or names used to limit returned information.

    string metric

    Limits the information returned to the specific metrics. Supports a comma-separated list, such as http,ingest.

    NodesInfoRequestParameters requestParameters

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

    CancellationToken ctx
    Returns
    Type Description
    Task<TResponse>
    Type Parameters
    Name Description
    TResponse
    | Edit this page View Source

    InfoForAllAsync<TResponse>(NodesInfoRequestParameters, CancellationToken)

    GET on /_nodes

    https://opensearch.org/docs/latest/api-reference/nodes-apis/nodes-info/

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

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

    CancellationToken ctx
    Returns
    Type Description
    Task<TResponse>
    Type Parameters
    Name Description
    TResponse
    | Edit this page View Source

    InfoForAllAsync<TResponse>(string, NodesInfoRequestParameters, CancellationToken)

    GET on /_nodes/{metric}

    https://opensearch.org/docs/latest/api-reference/nodes-apis/nodes-info/

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

    Limits the information returned to the specific metrics. Supports a comma-separated list, such as http,ingest.

    NodesInfoRequestParameters requestParameters

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

    CancellationToken ctx
    Returns
    Type Description
    Task<TResponse>
    Type Parameters
    Name Description
    TResponse
    | Edit this page View Source

    InfoForAll<TResponse>(NodesInfoRequestParameters)

    GET on /_nodes

    https://opensearch.org/docs/latest/api-reference/nodes-apis/nodes-info/

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

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

    Returns
    Type Description
    TResponse
    Type Parameters
    Name Description
    TResponse
    | Edit this page View Source

    InfoForAll<TResponse>(string, NodesInfoRequestParameters)

    GET on /_nodes/{metric}

    https://opensearch.org/docs/latest/api-reference/nodes-apis/nodes-info/

    Declaration
    public TResponse InfoForAll<TResponse>(string metric, NodesInfoRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()
    Parameters
    Type Name Description
    string metric

    Limits the information returned to the specific metrics. Supports a comma-separated list, such as http,ingest.

    NodesInfoRequestParameters requestParameters

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

    Returns
    Type Description
    TResponse
    Type Parameters
    Name Description
    TResponse
    | Edit this page View Source

    Info<TResponse>(string, NodesInfoRequestParameters)

    GET on /_nodes/{node_id}

    https://opensearch.org/docs/latest/api-reference/nodes-apis/nodes-info/

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

    Comma-separated list of node IDs or names used to limit returned information.

    NodesInfoRequestParameters requestParameters

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

    Returns
    Type Description
    TResponse
    Type Parameters
    Name Description
    TResponse
    | Edit this page View Source

    Info<TResponse>(string, string, NodesInfoRequestParameters)

    GET on /_nodes/{node_id}/{metric}

    https://opensearch.org/docs/latest/api-reference/nodes-apis/nodes-info/

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

    Comma-separated list of node IDs or names used to limit returned information.

    string metric

    Limits the information returned to the specific metrics. Supports a comma-separated list, such as http,ingest.

    NodesInfoRequestParameters requestParameters

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

    Returns
    Type Description
    TResponse
    Type Parameters
    Name Description
    TResponse
    | Edit this page View Source

    ReloadSecureSettingsAsync<TResponse>(string, PostData, ReloadSecureSettingsRequestParameters, CancellationToken)

    POST on /_nodes/{node_id}/reload_secure_settings

    https://opensearch.org/docs/latest/api-reference/nodes-apis/nodes-reload-secure/

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

    The names of particular nodes in the cluster to target.

    PostData body

    An object containing the password for the OpenSearch keystore.

    ReloadSecureSettingsRequestParameters requestParameters

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

    CancellationToken ctx
    Returns
    Type Description
    Task<TResponse>
    Type Parameters
    Name Description
    TResponse
    | Edit this page View Source

    ReloadSecureSettingsAsync<TResponse>(string, ReloadSecureSettingsRequestParameters, CancellationToken)

    POST on /_nodes/{node_id}/reload_secure_settings

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

    A comma-separated list of node IDs to span the reload/reinit call. Should stay empty because reloading usually involves all cluster nodes.

    ReloadSecureSettingsRequestParameters requestParameters

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

    CancellationToken ctx
    Returns
    Type Description
    Task<TResponse>
    Type Parameters
    Name Description
    TResponse
    | Edit this page View Source

    ReloadSecureSettingsForAllAsync<TResponse>(PostData, ReloadSecureSettingsRequestParameters, CancellationToken)

    POST on /_nodes/reload_secure_settings

    https://opensearch.org/docs/latest/api-reference/nodes-apis/nodes-reload-secure/

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

    An object containing the password for the OpenSearch keystore.

    ReloadSecureSettingsRequestParameters requestParameters

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

    CancellationToken ctx
    Returns
    Type Description
    Task<TResponse>
    Type Parameters
    Name Description
    TResponse
    | Edit this page View Source

    ReloadSecureSettingsForAllAsync<TResponse>(ReloadSecureSettingsRequestParameters, CancellationToken)

    POST on /_nodes/reload_secure_settings

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

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

    CancellationToken ctx
    Returns
    Type Description
    Task<TResponse>
    Type Parameters
    Name Description
    TResponse
    | Edit this page View Source

    ReloadSecureSettingsForAll<TResponse>(PostData, ReloadSecureSettingsRequestParameters)

    POST on /_nodes/reload_secure_settings

    https://opensearch.org/docs/latest/api-reference/nodes-apis/nodes-reload-secure/

    Declaration
    public TResponse ReloadSecureSettingsForAll<TResponse>(PostData body, ReloadSecureSettingsRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()
    Parameters
    Type Name Description
    PostData body

    An object containing the password for the OpenSearch keystore.

    ReloadSecureSettingsRequestParameters requestParameters

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

    Returns
    Type Description
    TResponse
    Type Parameters
    Name Description
    TResponse
    | Edit this page View Source

    ReloadSecureSettingsForAll<TResponse>(ReloadSecureSettingsRequestParameters)

    POST on /_nodes/reload_secure_settings

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

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

    Returns
    Type Description
    TResponse
    Type Parameters
    Name Description
    TResponse
    | Edit this page View Source

    ReloadSecureSettings<TResponse>(string, PostData, ReloadSecureSettingsRequestParameters)

    POST on /_nodes/{node_id}/reload_secure_settings

    https://opensearch.org/docs/latest/api-reference/nodes-apis/nodes-reload-secure/

    Declaration
    public TResponse ReloadSecureSettings<TResponse>(string nodeId, PostData body, ReloadSecureSettingsRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()
    Parameters
    Type Name Description
    string nodeId

    The names of particular nodes in the cluster to target.

    PostData body

    An object containing the password for the OpenSearch keystore.

    ReloadSecureSettingsRequestParameters requestParameters

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

    Returns
    Type Description
    TResponse
    Type Parameters
    Name Description
    TResponse
    | Edit this page View Source

    ReloadSecureSettings<TResponse>(string, ReloadSecureSettingsRequestParameters)

    POST on /_nodes/{node_id}/reload_secure_settings

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

    A comma-separated list of node IDs to span the reload/reinit call. Should stay empty because reloading usually involves all cluster nodes.

    ReloadSecureSettingsRequestParameters requestParameters

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

    Returns
    Type Description
    TResponse
    Type Parameters
    Name Description
    TResponse
    | Edit this page View Source

    StatsAsync<TResponse>(string, NodesStatsRequestParameters, CancellationToken)

    GET on /_nodes/{node_id}/stats

    https://opensearch.org/docs/latest/api-reference/nodes-apis/nodes-usage/

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

    Comma-separated list of node IDs or names used to limit returned information.

    NodesStatsRequestParameters requestParameters

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

    CancellationToken ctx
    Returns
    Type Description
    Task<TResponse>
    Type Parameters
    Name Description
    TResponse
    | Edit this page View Source

    StatsAsync<TResponse>(string, string, NodesStatsRequestParameters, CancellationToken)

    GET on /_nodes/{node_id}/stats/{metric}

    https://opensearch.org/docs/latest/api-reference/nodes-apis/nodes-usage/

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

    Comma-separated list of node IDs or names used to limit returned information.

    string metric

    Limit the information returned to the specified metrics.

    NodesStatsRequestParameters requestParameters

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

    CancellationToken ctx
    Returns
    Type Description
    Task<TResponse>
    Type Parameters
    Name Description
    TResponse
    | Edit this page View Source

    StatsAsync<TResponse>(string, string, string, NodesStatsRequestParameters, CancellationToken)

    GET on /_nodes/{node_id}/stats/{metric}/{index_metric}

    https://opensearch.org/docs/latest/api-reference/nodes-apis/nodes-usage/

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

    Comma-separated list of node IDs or names used to limit returned information.

    string metric

    Limit the information returned to the specified metrics.

    string indexMetric

    Limit the information returned for indexes metric to the specific index metrics. It can be used only if indexes (or all) metric is specified.

    NodesStatsRequestParameters requestParameters

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

    CancellationToken ctx
    Returns
    Type Description
    Task<TResponse>
    Type Parameters
    Name Description
    TResponse
    | Edit this page View Source

    StatsForAllAsync<TResponse>(NodesStatsRequestParameters, CancellationToken)

    GET on /_nodes/stats

    https://opensearch.org/docs/latest/api-reference/nodes-apis/nodes-usage/

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

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

    CancellationToken ctx
    Returns
    Type Description
    Task<TResponse>
    Type Parameters
    Name Description
    TResponse
    | Edit this page View Source

    StatsForAllAsync<TResponse>(string, NodesStatsRequestParameters, CancellationToken)

    GET on /_nodes/stats/{metric}

    https://opensearch.org/docs/latest/api-reference/nodes-apis/nodes-usage/

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

    Limit the information returned to the specified metrics.

    NodesStatsRequestParameters requestParameters

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

    CancellationToken ctx
    Returns
    Type Description
    Task<TResponse>
    Type Parameters
    Name Description
    TResponse
    | Edit this page View Source

    StatsForAllAsync<TResponse>(string, string, NodesStatsRequestParameters, CancellationToken)

    GET on /_nodes/stats/{metric}/{index_metric}

    https://opensearch.org/docs/latest/api-reference/nodes-apis/nodes-usage/

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

    Limit the information returned to the specified metrics.

    string indexMetric

    Limit the information returned for indexes metric to the specific index metrics. It can be used only if indexes (or all) metric is specified.

    NodesStatsRequestParameters requestParameters

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

    CancellationToken ctx
    Returns
    Type Description
    Task<TResponse>
    Type Parameters
    Name Description
    TResponse
    | Edit this page View Source

    StatsForAll<TResponse>(NodesStatsRequestParameters)

    GET on /_nodes/stats

    https://opensearch.org/docs/latest/api-reference/nodes-apis/nodes-usage/

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

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

    Returns
    Type Description
    TResponse
    Type Parameters
    Name Description
    TResponse
    | Edit this page View Source

    StatsForAll<TResponse>(string, NodesStatsRequestParameters)

    GET on /_nodes/stats/{metric}

    https://opensearch.org/docs/latest/api-reference/nodes-apis/nodes-usage/

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

    Limit the information returned to the specified metrics.

    NodesStatsRequestParameters requestParameters

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

    Returns
    Type Description
    TResponse
    Type Parameters
    Name Description
    TResponse
    | Edit this page View Source

    StatsForAll<TResponse>(string, string, NodesStatsRequestParameters)

    GET on /_nodes/stats/{metric}/{index_metric}

    https://opensearch.org/docs/latest/api-reference/nodes-apis/nodes-usage/

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

    Limit the information returned to the specified metrics.

    string indexMetric

    Limit the information returned for indexes metric to the specific index metrics. It can be used only if indexes (or all) metric is specified.

    NodesStatsRequestParameters requestParameters

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

    Returns
    Type Description
    TResponse
    Type Parameters
    Name Description
    TResponse
    | Edit this page View Source

    Stats<TResponse>(string, NodesStatsRequestParameters)

    GET on /_nodes/{node_id}/stats

    https://opensearch.org/docs/latest/api-reference/nodes-apis/nodes-usage/

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

    Comma-separated list of node IDs or names used to limit returned information.

    NodesStatsRequestParameters requestParameters

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

    Returns
    Type Description
    TResponse
    Type Parameters
    Name Description
    TResponse
    | Edit this page View Source

    Stats<TResponse>(string, string, NodesStatsRequestParameters)

    GET on /_nodes/{node_id}/stats/{metric}

    https://opensearch.org/docs/latest/api-reference/nodes-apis/nodes-usage/

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

    Comma-separated list of node IDs or names used to limit returned information.

    string metric

    Limit the information returned to the specified metrics.

    NodesStatsRequestParameters requestParameters

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

    Returns
    Type Description
    TResponse
    Type Parameters
    Name Description
    TResponse
    | Edit this page View Source

    Stats<TResponse>(string, string, string, NodesStatsRequestParameters)

    GET on /_nodes/{node_id}/stats/{metric}/{index_metric}

    https://opensearch.org/docs/latest/api-reference/nodes-apis/nodes-usage/

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

    Comma-separated list of node IDs or names used to limit returned information.

    string metric

    Limit the information returned to the specified metrics.

    string indexMetric

    Limit the information returned for indexes metric to the specific index metrics. It can be used only if indexes (or all) metric is specified.

    NodesStatsRequestParameters requestParameters

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

    Returns
    Type Description
    TResponse
    Type Parameters
    Name Description
    TResponse
    | Edit this page View Source

    UsageAsync<TResponse>(string, NodesUsageRequestParameters, CancellationToken)

    GET on /_nodes/{node_id}/usage

    https://opensearch.org/docs/latest

    Declaration
    public Task<TResponse> UsageAsync<TResponse>(string nodeId, NodesUsageRequestParameters 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; use _local to return information from the node you're connecting to, leave empty to get information from all nodes.

    NodesUsageRequestParameters requestParameters

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

    CancellationToken ctx
    Returns
    Type Description
    Task<TResponse>
    Type Parameters
    Name Description
    TResponse
    | Edit this page View Source

    UsageAsync<TResponse>(string, string, NodesUsageRequestParameters, CancellationToken)

    GET on /_nodes/{node_id}/usage/{metric}

    https://opensearch.org/docs/latest

    Declaration
    public Task<TResponse> UsageAsync<TResponse>(string nodeId, string metric, NodesUsageRequestParameters 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; use _local to return information from the node you're connecting to, leave empty to get information from all nodes.

    string metric

    Limits the information returned to the specific metrics. A comma-separated list of the following options: _all, rest_actions.

    NodesUsageRequestParameters requestParameters

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

    CancellationToken ctx
    Returns
    Type Description
    Task<TResponse>
    Type Parameters
    Name Description
    TResponse
    | Edit this page View Source

    UsageForAllAsync<TResponse>(NodesUsageRequestParameters, CancellationToken)

    GET on /_nodes/usage

    https://opensearch.org/docs/latest

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

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

    CancellationToken ctx
    Returns
    Type Description
    Task<TResponse>
    Type Parameters
    Name Description
    TResponse
    | Edit this page View Source

    UsageForAllAsync<TResponse>(string, NodesUsageRequestParameters, CancellationToken)

    GET on /_nodes/usage/{metric}

    https://opensearch.org/docs/latest

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

    Limits the information returned to the specific metrics. A comma-separated list of the following options: _all, rest_actions.

    NodesUsageRequestParameters requestParameters

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

    CancellationToken ctx
    Returns
    Type Description
    Task<TResponse>
    Type Parameters
    Name Description
    TResponse
    | Edit this page View Source

    UsageForAll<TResponse>(NodesUsageRequestParameters)

    GET on /_nodes/usage

    https://opensearch.org/docs/latest

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

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

    Returns
    Type Description
    TResponse
    Type Parameters
    Name Description
    TResponse
    | Edit this page View Source

    UsageForAll<TResponse>(string, NodesUsageRequestParameters)

    GET on /_nodes/usage/{metric}

    https://opensearch.org/docs/latest

    Declaration
    public TResponse UsageForAll<TResponse>(string metric, NodesUsageRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()
    Parameters
    Type Name Description
    string metric

    Limits the information returned to the specific metrics. A comma-separated list of the following options: _all, rest_actions.

    NodesUsageRequestParameters requestParameters

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

    Returns
    Type Description
    TResponse
    Type Parameters
    Name Description
    TResponse
    | Edit this page View Source

    Usage<TResponse>(string, NodesUsageRequestParameters)

    GET on /_nodes/{node_id}/usage

    https://opensearch.org/docs/latest

    Declaration
    public TResponse Usage<TResponse>(string nodeId, NodesUsageRequestParameters 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; use _local to return information from the node you're connecting to, leave empty to get information from all nodes.

    NodesUsageRequestParameters requestParameters

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

    Returns
    Type Description
    TResponse
    Type Parameters
    Name Description
    TResponse
    | Edit this page View Source

    Usage<TResponse>(string, string, NodesUsageRequestParameters)

    GET on /_nodes/{node_id}/usage/{metric}

    https://opensearch.org/docs/latest

    Declaration
    public TResponse Usage<TResponse>(string nodeId, string metric, NodesUsageRequestParameters 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; use _local to return information from the node you're connecting to, leave empty to get information from all nodes.

    string metric

    Limits the information returned to the specific metrics. A comma-separated list of the following options: _all, rest_actions.

    NodesUsageRequestParameters requestParameters

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

    Returns
    Type Description
    TResponse
    Type Parameters
    Name Description
    TResponse

    Extension Methods

    SuffixExtensions.Suffix(object, string)
    • Edit this page
    • View Source
    In this article
    • Methods
      • HotThreadsAsync<TResponse>(string, NodesHotThreadsRequestParameters, CancellationToken)
      • HotThreadsForAllAsync<TResponse>(NodesHotThreadsRequestParameters, CancellationToken)
      • HotThreadsForAll<TResponse>(NodesHotThreadsRequestParameters)
      • HotThreads<TResponse>(string, NodesHotThreadsRequestParameters)
      • InfoAsync<TResponse>(string, NodesInfoRequestParameters, CancellationToken)
      • InfoAsync<TResponse>(string, string, NodesInfoRequestParameters, CancellationToken)
      • InfoForAllAsync<TResponse>(NodesInfoRequestParameters, CancellationToken)
      • InfoForAllAsync<TResponse>(string, NodesInfoRequestParameters, CancellationToken)
      • InfoForAll<TResponse>(NodesInfoRequestParameters)
      • InfoForAll<TResponse>(string, NodesInfoRequestParameters)
      • Info<TResponse>(string, NodesInfoRequestParameters)
      • Info<TResponse>(string, string, NodesInfoRequestParameters)
      • ReloadSecureSettingsAsync<TResponse>(string, PostData, ReloadSecureSettingsRequestParameters, CancellationToken)
      • ReloadSecureSettingsAsync<TResponse>(string, ReloadSecureSettingsRequestParameters, CancellationToken)
      • ReloadSecureSettingsForAllAsync<TResponse>(PostData, ReloadSecureSettingsRequestParameters, CancellationToken)
      • ReloadSecureSettingsForAllAsync<TResponse>(ReloadSecureSettingsRequestParameters, CancellationToken)
      • ReloadSecureSettingsForAll<TResponse>(PostData, ReloadSecureSettingsRequestParameters)
      • ReloadSecureSettingsForAll<TResponse>(ReloadSecureSettingsRequestParameters)
      • ReloadSecureSettings<TResponse>(string, PostData, ReloadSecureSettingsRequestParameters)
      • ReloadSecureSettings<TResponse>(string, ReloadSecureSettingsRequestParameters)
      • StatsAsync<TResponse>(string, NodesStatsRequestParameters, CancellationToken)
      • StatsAsync<TResponse>(string, string, NodesStatsRequestParameters, CancellationToken)
      • StatsAsync<TResponse>(string, string, string, NodesStatsRequestParameters, CancellationToken)
      • StatsForAllAsync<TResponse>(NodesStatsRequestParameters, CancellationToken)
      • StatsForAllAsync<TResponse>(string, NodesStatsRequestParameters, CancellationToken)
      • StatsForAllAsync<TResponse>(string, string, NodesStatsRequestParameters, CancellationToken)
      • StatsForAll<TResponse>(NodesStatsRequestParameters)
      • StatsForAll<TResponse>(string, NodesStatsRequestParameters)
      • StatsForAll<TResponse>(string, string, NodesStatsRequestParameters)
      • Stats<TResponse>(string, NodesStatsRequestParameters)
      • Stats<TResponse>(string, string, NodesStatsRequestParameters)
      • Stats<TResponse>(string, string, string, NodesStatsRequestParameters)
      • UsageAsync<TResponse>(string, NodesUsageRequestParameters, CancellationToken)
      • UsageAsync<TResponse>(string, string, NodesUsageRequestParameters, CancellationToken)
      • UsageForAllAsync<TResponse>(NodesUsageRequestParameters, CancellationToken)
      • UsageForAllAsync<TResponse>(string, NodesUsageRequestParameters, CancellationToken)
      • UsageForAll<TResponse>(NodesUsageRequestParameters)
      • UsageForAll<TResponse>(string, NodesUsageRequestParameters)
      • Usage<TResponse>(string, NodesUsageRequestParameters)
      • Usage<TResponse>(string, string, NodesUsageRequestParameters)
    • Extension Methods
    Back to top Generated by DocFX