Class SearchPipelineNamespace

Search Pipeline implementation.

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

Inheritance

object

NamespacedClientProxy

SearchPipelineNamespace

Implements

ISearchPipelineNamespace

Inherited Members

NamespacedClientProxy.DoCat<TRequest, TParams, TCatRecord>(TRequest)

NamespacedClientProxy.DoCatAsync<TRequest, TParams, TCatRecord>(TRequest, CancellationToken)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: OpenSearch.Client.Specification.SearchPipelineApi

Assembly: OpenSearch.Client.dll

Syntax

public class SearchPipelineNamespace : NamespacedClientProxy, ISearchPipelineNamespace

Methods

| Edit this page View Source

Delete(IDeleteSearchPipelineRequest)

DELETE request to the search_pipeline.delete API, read more about this API online:

Declaration

public DeleteSearchPipelineResponse Delete(IDeleteSearchPipelineRequest request)

Parameters

Type	Name	Description
IDeleteSearchPipelineRequest	request

Returns

Type	Description
DeleteSearchPipelineResponse

Remarks

Supported by OpenSearch servers of version 2.9.0 or greater.

| Edit this page View Source

Delete(Id, Func<DeleteSearchPipelineDescriptor, IDeleteSearchPipelineRequest>)

DELETE request to the search_pipeline.delete API, read more about this API online:

Declaration

public DeleteSearchPipelineResponse Delete(Id id, Func<DeleteSearchPipelineDescriptor, IDeleteSearchPipelineRequest> selector = null)

Parameters

Type	Name	Description
Id	id
Func<DeleteSearchPipelineDescriptor, IDeleteSearchPipelineRequest>	selector

Returns

Type	Description
DeleteSearchPipelineResponse

Remarks

Supported by OpenSearch servers of version 2.9.0 or greater.

| Edit this page View Source

DeleteAsync(IDeleteSearchPipelineRequest, CancellationToken)

DELETE request to the search_pipeline.delete API, read more about this API online:

Declaration

public Task<DeleteSearchPipelineResponse> DeleteAsync(IDeleteSearchPipelineRequest request, CancellationToken ct = default)

Parameters

Type	Name	Description
IDeleteSearchPipelineRequest	request
CancellationToken	ct

Returns

Type	Description
Task<DeleteSearchPipelineResponse>

Remarks

Supported by OpenSearch servers of version 2.9.0 or greater.

| Edit this page View Source

DeleteAsync(Id, Func<DeleteSearchPipelineDescriptor, IDeleteSearchPipelineRequest>, CancellationToken)

DELETE request to the search_pipeline.delete API, read more about this API online:

Declaration

public Task<DeleteSearchPipelineResponse> DeleteAsync(Id id, Func<DeleteSearchPipelineDescriptor, IDeleteSearchPipelineRequest> selector = null, CancellationToken ct = default)

Parameters

Type	Name	Description
Id	id
Func<DeleteSearchPipelineDescriptor, IDeleteSearchPipelineRequest>	selector
CancellationToken	ct

Returns

Type	Description
Task<DeleteSearchPipelineResponse>

Remarks

Supported by OpenSearch servers of version 2.9.0 or greater.

| Edit this page View Source

Get(IGetSearchPipelineRequest)

GET request to the search_pipeline.get API, read more about this API online:

Declaration

public GetSearchPipelineResponse Get(IGetSearchPipelineRequest request)

Parameters

Type	Name	Description
IGetSearchPipelineRequest	request

Returns

Type	Description
GetSearchPipelineResponse

Remarks

Supported by OpenSearch servers of version 2.9.0 or greater.

| Edit this page View Source

Get(Func<GetSearchPipelineDescriptor, IGetSearchPipelineRequest>)

GET request to the search_pipeline.get API, read more about this API online:

Declaration

public GetSearchPipelineResponse Get(Func<GetSearchPipelineDescriptor, IGetSearchPipelineRequest> selector = null)

Parameters

Type	Name	Description
Func<GetSearchPipelineDescriptor, IGetSearchPipelineRequest>	selector

Returns

Type	Description
GetSearchPipelineResponse

Remarks

Supported by OpenSearch servers of version 2.9.0 or greater.

| Edit this page View Source

GetAsync(IGetSearchPipelineRequest, CancellationToken)

GET request to the search_pipeline.get API, read more about this API online:

Declaration

public Task<GetSearchPipelineResponse> GetAsync(IGetSearchPipelineRequest request, CancellationToken ct = default)

Parameters

Type	Name	Description
IGetSearchPipelineRequest	request
CancellationToken	ct

Returns

Type	Description
Task<GetSearchPipelineResponse>

Remarks

Supported by OpenSearch servers of version 2.9.0 or greater.

| Edit this page View Source

GetAsync(Func<GetSearchPipelineDescriptor, IGetSearchPipelineRequest>, CancellationToken)

GET request to the search_pipeline.get API, read more about this API online:

Declaration

public Task<GetSearchPipelineResponse> GetAsync(Func<GetSearchPipelineDescriptor, IGetSearchPipelineRequest> selector = null, CancellationToken ct = default)

Parameters

Type	Name	Description
Func<GetSearchPipelineDescriptor, IGetSearchPipelineRequest>	selector
CancellationToken	ct

Returns

Type	Description
Task<GetSearchPipelineResponse>

Remarks

Supported by OpenSearch servers of version 2.9.0 or greater.

| Edit this page View Source

Put(IPutSearchPipelineRequest)

PUT request to the search_pipeline.put API, read more about this API online:

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

Declaration

public PutSearchPipelineResponse Put(IPutSearchPipelineRequest request)

Parameters

Type	Name	Description
IPutSearchPipelineRequest	request

Returns

Type	Description
PutSearchPipelineResponse

Remarks

Supported by OpenSearch servers of version 2.9.0 or greater.

| Edit this page View Source

Put(Id, Func<PutSearchPipelineDescriptor, IPutSearchPipelineRequest>)

PUT request to the search_pipeline.put API, read more about this API online:

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

Declaration

public PutSearchPipelineResponse Put(Id id, Func<PutSearchPipelineDescriptor, IPutSearchPipelineRequest> selector)

Parameters

Type	Name	Description
Id	id
Func<PutSearchPipelineDescriptor, IPutSearchPipelineRequest>	selector

Returns

Type	Description
PutSearchPipelineResponse

Remarks

Supported by OpenSearch servers of version 2.9.0 or greater.

| Edit this page View Source

PutAsync(IPutSearchPipelineRequest, CancellationToken)

PUT request to the search_pipeline.put API, read more about this API online:

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

Declaration

public Task<PutSearchPipelineResponse> PutAsync(IPutSearchPipelineRequest request, CancellationToken ct = default)

Parameters

Type	Name	Description
IPutSearchPipelineRequest	request
CancellationToken	ct

Returns

Type	Description
Task<PutSearchPipelineResponse>

Remarks

Supported by OpenSearch servers of version 2.9.0 or greater.

| Edit this page View Source

PutAsync(Id, Func<PutSearchPipelineDescriptor, IPutSearchPipelineRequest>, CancellationToken)

PUT request to the search_pipeline.put API, read more about this API online:

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

Declaration

public Task<PutSearchPipelineResponse> PutAsync(Id id, Func<PutSearchPipelineDescriptor, IPutSearchPipelineRequest> selector, CancellationToken ct = default)

Parameters

Type	Name	Description
Id	id
Func<PutSearchPipelineDescriptor, IPutSearchPipelineRequest>	selector
CancellationToken	ct

Returns

Type	Description
Task<PutSearchPipelineResponse>

Remarks

Supported by OpenSearch servers of version 2.9.0 or greater.

Implements

ISearchPipelineNamespace

Extension Methods

SuffixExtensions.Suffix(object, string)