Class LowLevelSearchPipelineNamespace

Search Pipeline APIs.

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

Inheritance

object

NamespacedClientProxy

LowLevelSearchPipelineNamespace

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

Assembly: OpenSearch.Net.dll

Syntax

public class LowLevelSearchPipelineNamespace : NamespacedClientProxy

Methods

DeleteAsync<TResponse>(string, DeleteRequestParameters, CancellationToken)

DELETE on /_search/pipeline/{id}

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	Pipeline 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

Remarks

Supported by OpenSearch servers of version 2.9.0 or greater.

Delete<TResponse>(string, DeleteRequestParameters)

DELETE on /_search/pipeline/{id}

Declaration

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

Parameters

Type	Name	Description
string	id	Pipeline ID.
DeleteRequestParameters	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 2.9.0 or greater.

GetAsync<TResponse>(GetRequestParameters, CancellationToken)

GET on /_search/pipeline

Declaration

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

Parameters

Type	Name	Description
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

Remarks

Supported by OpenSearch servers of version 2.9.0 or greater.

GetAsync<TResponse>(string, GetRequestParameters, CancellationToken)

GET on /_search/pipeline/{id}

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	Comma-separated list of search pipeline ids. Wildcards supported.
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

Remarks

Supported by OpenSearch servers of version 2.9.0 or greater.

Get<TResponse>(GetRequestParameters)

GET on /_search/pipeline

Declaration

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

Parameters

Type	Name	Description
GetRequestParameters	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 2.9.0 or greater.

Get<TResponse>(string, GetRequestParameters)

GET on /_search/pipeline/{id}

Declaration

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

Parameters

Type	Name	Description
string	id	Comma-separated list of search pipeline ids. Wildcards supported.
GetRequestParameters	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 2.9.0 or greater.

PutAsync<TResponse>(string, PostData, PutRequestParameters, CancellationToken)

PUT on /_search/pipeline/{id}

https://opensearch.org/docs/latest/search-plugins/search-pipelines/creating-search-pipeline/

Declaration

public Task<TResponse> PutAsync<TResponse>(string id, PostData body, PutRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	id	Pipeline ID.
PostData	body
PutRequestParameters	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 2.9.0 or greater.

Put<TResponse>(string, PostData, PutRequestParameters)

PUT on /_search/pipeline/{id}

https://opensearch.org/docs/latest/search-plugins/search-pipelines/creating-search-pipeline/

Declaration

public TResponse Put<TResponse>(string id, PostData body, PutRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	id	Pipeline ID.
PostData	body
PutRequestParameters	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 2.9.0 or greater.

Extension Methods

SuffixExtensions.Suffix(object, string)