Class PutPipelineDescriptor

Descriptor for PutPipeline

https://opensearch.org/docs/latest/api-reference/ingest-apis/create-update-ingest/

Inheritance
object
RequestBase<PutPipelineRequestParameters>
RequestDescriptorBase<PutPipelineDescriptor, PutPipelineRequestParameters, IPutPipelineRequest>
PutPipelineDescriptor
Implements
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class PutPipelineDescriptor : RequestDescriptorBase<PutPipelineDescriptor, PutPipelineRequestParameters, IPutPipelineRequest>, IDescriptor, IPutPipelineRequest, IPipeline, IRequest<PutPipelineRequestParameters>, IRequest

Constructors

| Edit this page View Source

PutPipelineDescriptor()

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

Declaration
protected PutPipelineDescriptor()
| Edit this page View Source

PutPipelineDescriptor(Id)

/_ingest/pipeline/{id}

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

this parameter is required

Methods

| Edit this page View Source

ClusterManagerTimeout(Time)

The amount of time allowed to establish a connection to the cluster manager node.

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

Supported by OpenSearch servers of version 2.0.0 or greater.

| Edit this page View Source

Description(string)

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

MasterTimeout(Time)

Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error.

Declaration
[Obsolete("Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead.")]
public PutPipelineDescriptor MasterTimeout(Time mastertimeout)
Parameters
Type Name Description
Time mastertimeout
Returns
Type Description
PutPipelineDescriptor
| Edit this page View Source

OnFailure(IEnumerable<IProcessor>)

Declaration
public PutPipelineDescriptor OnFailure(IEnumerable<IProcessor> processors)
Parameters
Type Name Description
IEnumerable<IProcessor> processors
Returns
Type Description
PutPipelineDescriptor
| Edit this page View Source

OnFailure(Func<ProcessorsDescriptor, IPromise<IList<IProcessor>>>)

Declaration
public PutPipelineDescriptor OnFailure(Func<ProcessorsDescriptor, IPromise<IList<IProcessor>>> selector)
Parameters
Type Name Description
Func<ProcessorsDescriptor, IPromise<IList<IProcessor>>> selector
Returns
Type Description
PutPipelineDescriptor
| Edit this page View Source

Processors(IEnumerable<IProcessor>)

Declaration
public PutPipelineDescriptor Processors(IEnumerable<IProcessor> processors)
Parameters
Type Name Description
IEnumerable<IProcessor> processors
Returns
Type Description
PutPipelineDescriptor
| Edit this page View Source

Processors(Func<ProcessorsDescriptor, IPromise<IList<IProcessor>>>)

Declaration
public PutPipelineDescriptor Processors(Func<ProcessorsDescriptor, IPromise<IList<IProcessor>>> selector)
Parameters
Type Name Description
Func<ProcessorsDescriptor, IPromise<IList<IProcessor>>> selector
Returns
Type Description
PutPipelineDescriptor
| Edit this page View Source

Timeout(Time)

The amount of time to wait for a response.

Declaration
public PutPipelineDescriptor Timeout(Time timeout)
Parameters
Type Name Description
Time timeout
Returns
Type Description
PutPipelineDescriptor

Implements

Extension Methods