Class LowLevelAsynchronousSearchNamespace

Asynchronous Search APIs.

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

Inheritance

object

NamespacedClientProxy

LowLevelAsynchronousSearchNamespace

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

Assembly: OpenSearch.Net.dll

Syntax

public class LowLevelAsynchronousSearchNamespace : NamespacedClientProxy

Methods

DeleteAsync<TResponse>(string, DeleteRequestParameters, CancellationToken)

DELETE on /_plugins/_asynchronous_search/{id}

https://opensearch.org/docs/latest/search-plugins/async/index/#delete-searches-and-results

Declaration

public Task<TResponse> DeleteAsync<TResponse>(string id, DeleteRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	id
DeleteRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

Delete<TResponse>(string, DeleteRequestParameters)

DELETE on /_plugins/_asynchronous_search/{id}

https://opensearch.org/docs/latest/search-plugins/async/index/#delete-searches-and-results

Declaration

public TResponse Delete<TResponse>(string id, DeleteRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	id
DeleteRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

GetAsync<TResponse>(string, GetRequestParameters, CancellationToken)

GET on /_plugins/_asynchronous_search/{id}

https://opensearch.org/docs/latest/search-plugins/async/index/#get-partial-results

Declaration

public Task<TResponse> GetAsync<TResponse>(string id, GetRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	id
GetRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

Get<TResponse>(string, GetRequestParameters)

GET on /_plugins/_asynchronous_search/{id}

https://opensearch.org/docs/latest/search-plugins/async/index/#get-partial-results

Declaration

public TResponse Get<TResponse>(string id, GetRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	id
GetRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

SearchAsync<TResponse>(PostData, SearchRequestParameters, CancellationToken)

POST on /_plugins/_asynchronous_search

https://opensearch.org/docs/latest/search-plugins/async/index/#rest-api

Declaration

public Task<TResponse> SearchAsync<TResponse>(PostData body, SearchRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
PostData	body	The search definition using the Query DSL.
SearchRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

Search<TResponse>(PostData, SearchRequestParameters)

POST on /_plugins/_asynchronous_search

https://opensearch.org/docs/latest/search-plugins/async/index/#rest-api

Declaration

public TResponse Search<TResponse>(PostData body, SearchRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
PostData	body	The search definition using the Query DSL.
SearchRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

StatsAsync<TResponse>(StatsRequestParameters, CancellationToken)

GET on /_plugins/_asynchronous_search/stats

https://opensearch.org/docs/latest/search-plugins/async/index/#monitor-stats

Declaration

public Task<TResponse> StatsAsync<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

Stats<TResponse>(StatsRequestParameters)

GET on /_plugins/_asynchronous_search/stats

https://opensearch.org/docs/latest/search-plugins/async/index/#monitor-stats

Declaration

public TResponse Stats<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

Extension Methods

SuffixExtensions.Suffix(object, string)