Class PutSearchPipelineDescriptor

Descriptor for Put

<p>https://docs.opensearch.org/latest/search-plugins/search-pipelines/creating-search-pipeline/</p>
Inheritance
object
RequestBase<PutRequestParameters>
RequestDescriptorBase<PutSearchPipelineDescriptor, PutRequestParameters, IPutSearchPipelineRequest>
PutSearchPipelineDescriptor
Implements
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class PutSearchPipelineDescriptor : RequestDescriptorBase<PutSearchPipelineDescriptor, PutRequestParameters, IPutSearchPipelineRequest>, IDescriptor, IPutSearchPipelineRequest, IRequest<PutRequestParameters>, IRequest

Constructors

| Edit this page View Source

PutSearchPipelineDescriptor()

Used for serialization purposes, making sure we have a parameterless constructor

Declaration
protected PutSearchPipelineDescriptor()
| Edit this page View Source

PutSearchPipelineDescriptor(Id)

/_search/pipeline/{id}

Declaration
public PutSearchPipelineDescriptor(Id id)
Parameters
Type Name Description
Id id

this parameter is required

Methods

| Edit this page View Source

ClusterManagerTimeout(Time)

operation timeout for connection to cluster-manager node.

Declaration
public PutSearchPipelineDescriptor ClusterManagerTimeout(Time clustermanagertimeout)
Parameters
Type Name Description
Time clustermanagertimeout
Returns
Type Description
PutSearchPipelineDescriptor
Remarks

Supported by OpenSearch servers of version 2.0.0 or greater.

| Edit this page View Source

Description(string)

Declaration
public PutSearchPipelineDescriptor Description(string description)
Parameters
Type Name Description
string description
Returns
Type Description
PutSearchPipelineDescriptor
| Edit this page View Source

PhaseResultsProcessors(IList<IPhaseResultsProcessor>)

Declaration
public PutSearchPipelineDescriptor PhaseResultsProcessors(IList<IPhaseResultsProcessor> phaseResultsProcessors)
Parameters
Type Name Description
IList<IPhaseResultsProcessor> phaseResultsProcessors
Returns
Type Description
PutSearchPipelineDescriptor
| Edit this page View Source

PhaseResultsProcessors(Func<PhaseResultsProcessorsDescriptor, IPromise<IList<IPhaseResultsProcessor>>>)

Declaration
public PutSearchPipelineDescriptor PhaseResultsProcessors(Func<PhaseResultsProcessorsDescriptor, IPromise<IList<IPhaseResultsProcessor>>> selector)
Parameters
Type Name Description
Func<PhaseResultsProcessorsDescriptor, IPromise<IList<IPhaseResultsProcessor>>> selector
Returns
Type Description
PutSearchPipelineDescriptor
| Edit this page View Source

RequestProcessors(IList<IRequestProcessor>)

Declaration
public PutSearchPipelineDescriptor RequestProcessors(IList<IRequestProcessor> requestProcessors)
Parameters
Type Name Description
IList<IRequestProcessor> requestProcessors
Returns
Type Description
PutSearchPipelineDescriptor
| Edit this page View Source

RequestProcessors(Func<RequestProcessorsDescriptor, IPromise<IList<IRequestProcessor>>>)

Declaration
public PutSearchPipelineDescriptor RequestProcessors(Func<RequestProcessorsDescriptor, IPromise<IList<IRequestProcessor>>> selector)
Parameters
Type Name Description
Func<RequestProcessorsDescriptor, IPromise<IList<IRequestProcessor>>> selector
Returns
Type Description
PutSearchPipelineDescriptor
| Edit this page View Source

ResponseProcessors(IList<IResponseProcessor>)

Declaration
public PutSearchPipelineDescriptor ResponseProcessors(IList<IResponseProcessor> responseProcessors)
Parameters
Type Name Description
IList<IResponseProcessor> responseProcessors
Returns
Type Description
PutSearchPipelineDescriptor
| Edit this page View Source

ResponseProcessors(Func<ResponseProcessorsDescriptor, IPromise<IList<IResponseProcessor>>>)

Declaration
public PutSearchPipelineDescriptor ResponseProcessors(Func<ResponseProcessorsDescriptor, IPromise<IList<IResponseProcessor>>> selector)
Parameters
Type Name Description
Func<ResponseProcessorsDescriptor, IPromise<IList<IResponseProcessor>>> selector
Returns
Type Description
PutSearchPipelineDescriptor
| Edit this page View Source

Timeout(Time)

Operation timeout.

Declaration
public PutSearchPipelineDescriptor Timeout(Time timeout)
Parameters
Type Name Description
Time timeout
Returns
Type Description
PutSearchPipelineDescriptor
| Edit this page View Source

Version(int?)

Declaration
public PutSearchPipelineDescriptor Version(int? version)
Parameters
Type Name Description
int? version
Returns
Type Description
PutSearchPipelineDescriptor

Implements

Extension Methods