Class LowLevelLtrNamespace

Ltr APIs.

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

Inheritance

object

NamespacedClientProxy

LowLevelLtrNamespace

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.LtrApi

Assembly: OpenSearch.Net.dll

Syntax

public class LowLevelLtrNamespace : NamespacedClientProxy

Methods

StatsAsync<TResponse>(string, StatsRequestParameters, CancellationToken)

GET on /_plugins/_ltr/{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	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.
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

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

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

Declaration

public Task<TResponse> StatsAsync<TResponse>(string nodeId, string stat, StatsRequestParameters 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.
string	stat	Comma-separated list of stats to retrieve; use the special string _all or Indices.All 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

StatsForAllAsync<TResponse>(StatsRequestParameters, CancellationToken)

GET on /_plugins/_ltr/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

StatsForAllAsync<TResponse>(string, StatsRequestParameters, CancellationToken)

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

Declaration

public Task<TResponse> StatsForAllAsync<TResponse>(string stat, StatsRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	stat	Comma-separated list of stats to retrieve; use the special string _all or Indices.All 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

StatsForAll<TResponse>(StatsRequestParameters)

GET on /_plugins/_ltr/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

StatsForAll<TResponse>(string, StatsRequestParameters)

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

Declaration

public TResponse StatsForAll<TResponse>(string stat, StatsRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	stat	Comma-separated list of stats to retrieve; use the special string _all or Indices.All 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

Stats<TResponse>(string, StatsRequestParameters)

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

Declaration

public TResponse Stats<TResponse>(string nodeId, StatsRequestParameters 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.
StatsRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Stats<TResponse>(string, string, StatsRequestParameters)

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

Declaration

public TResponse Stats<TResponse>(string nodeId, string stat, StatsRequestParameters 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.
string	stat	Comma-separated list of stats to retrieve; use the special string _all or Indices.All 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

Extension Methods

SuffixExtensions.Suffix(object, string)