Class SimulatePipelineDescriptor

Descriptor for SimulatePipeline

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

Inheritance
object
RequestBase<SimulatePipelineRequestParameters>
RequestDescriptorBase<SimulatePipelineDescriptor, SimulatePipelineRequestParameters, ISimulatePipelineRequest>
SimulatePipelineDescriptor
Implements
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class SimulatePipelineDescriptor : RequestDescriptorBase<SimulatePipelineDescriptor, SimulatePipelineRequestParameters, ISimulatePipelineRequest>, IDescriptor, ISimulatePipelineRequest, IRequest<SimulatePipelineRequestParameters>, IRequest

Constructors

| Edit this page View Source

SimulatePipelineDescriptor()

/_ingest/pipeline/_simulate

Declaration
public SimulatePipelineDescriptor()
| Edit this page View Source

SimulatePipelineDescriptor(Id)

/_ingest/pipeline/{id}/_simulate

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

Optional, accepts null

Methods

| Edit this page View Source

Documents(IEnumerable<ISimulatePipelineDocument>)

Declaration
public SimulatePipelineDescriptor Documents(IEnumerable<ISimulatePipelineDocument> documents)
Parameters
Type Name Description
IEnumerable<ISimulatePipelineDocument> documents
Returns
Type Description
SimulatePipelineDescriptor
| Edit this page View Source

Documents(Func<SimulatePipelineDocumentsDescriptor, IPromise<IList<ISimulatePipelineDocument>>>)

Declaration
public SimulatePipelineDescriptor Documents(Func<SimulatePipelineDocumentsDescriptor, IPromise<IList<ISimulatePipelineDocument>>> selector)
Parameters
Type Name Description
Func<SimulatePipelineDocumentsDescriptor, IPromise<IList<ISimulatePipelineDocument>>> selector
Returns
Type Description
SimulatePipelineDescriptor
| Edit this page View Source

Id(Id)

The pipeline to test. If you don't specify a pipeline in the request body, this parameter is required.

Declaration
public SimulatePipelineDescriptor Id(Id id)
Parameters
Type Name Description
Id id
Returns
Type Description
SimulatePipelineDescriptor
| Edit this page View Source

Pipeline(Func<PipelineDescriptor, IPipeline>)

Declaration
public SimulatePipelineDescriptor Pipeline(Func<PipelineDescriptor, IPipeline> pipeline)
Parameters
Type Name Description
Func<PipelineDescriptor, IPipeline> pipeline
Returns
Type Description
SimulatePipelineDescriptor
| Edit this page View Source

Verbose(bool?)

When true, the response includes output data for each processor in the pipeline.

Declaration
public SimulatePipelineDescriptor Verbose(bool? verbose = true)
Parameters
Type Name Description
bool? verbose
Returns
Type Description
SimulatePipelineDescriptor

Implements

Extension Methods