Class LowLevelNeuralNamespace
Neural APIs.
Not intended to be instantiated directly. Use the Neural property
on IOpen
Inherited Members
Namespace: OpenSearch .Net.Specification.NeuralApi
Assembly: OpenSearch.Net.dll
Syntax
public class LowLevelNeuralNamespace : NamespacedClientProxy
Methods
| Edit this page View SourceStatsAsync<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. |
Stats |
requestParameters | Request specific configuration such as querystring parameters & request specific connection settings. |
Cancellation |
ctx |
Returns
Type | Description |
---|---|
Task<TResponse> |
Type Parameters
Name | Description |
---|---|
TResponse |
Remarks
Supported by OpenSearch servers of version 3.0.0 or greater.
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. |
Neural |
stat | A comma-separated list of stats to retrieve; use empty string to retrieve all stats. |
Stats |
requestParameters | Request specific configuration such as querystring parameters & request specific connection settings. |
Cancellation |
ctx |
Returns
Type | Description |
---|---|
Task<TResponse> |
Type Parameters
Name | Description |
---|---|
TResponse |
Remarks
Supported by OpenSearch servers of version 3.0.0 or greater.
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 |
---|---|---|
Stats |
requestParameters | Request specific configuration such as querystring parameters & request specific connection settings. |
Cancellation |
ctx |
Returns
Type | Description |
---|---|
Task<TResponse> |
Type Parameters
Name | Description |
---|---|
TResponse |
Remarks
Supported by OpenSearch servers of version 3.0.0 or greater.
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 |
---|---|---|
Neural |
stat | A comma-separated list of stats to retrieve; use empty string to retrieve all stats. |
Stats |
requestParameters | Request specific configuration such as querystring parameters & request specific connection settings. |
Cancellation |
ctx |
Returns
Type | Description |
---|---|
Task<TResponse> |
Type Parameters
Name | Description |
---|---|
TResponse |
Remarks
Supported by OpenSearch servers of version 3.0.0 or greater.
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 |
---|---|---|
Stats |
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.
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 |
---|---|---|
Neural |
stat | A comma-separated list of stats to retrieve; use empty string to retrieve all stats. |
Stats |
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.
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. |
Stats |
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.
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. |
Neural |
stat | A comma-separated list of stats to retrieve; use empty string to retrieve all stats. |
Stats |
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.