Class ProcessorDescriptorBase<TProcessorDescriptor, TProcessorInterface>
Ingest pipelines are composed of one or more processors
Inheritance
ProcessorDescriptorBase<TProcessorDescriptor, TProcessorInterface>
Assembly: OpenSearch.Client.dll
Syntax
public abstract class ProcessorDescriptorBase<TProcessorDescriptor, TProcessorInterface> : DescriptorBase<TProcessorDescriptor, TProcessorInterface>, IDescriptor, IProcessor where TProcessorDescriptor : ProcessorDescriptorBase<TProcessorDescriptor, TProcessorInterface>, TProcessorInterface where TProcessorInterface : class, IProcessor
Type Parameters
| Name |
Description |
| TProcessorDescriptor |
|
| TProcessorInterface |
|
Properties
|
Edit this page
View Source
Name
Declaration
protected abstract string Name { get; }
Property Value
Methods
|
Edit this page
View Source
Description(string)
A description to explain the purpose of the specific processor instance.
Declaration
public TProcessorDescriptor Description(string description)
Parameters
| Type |
Name |
Description |
| string |
description |
|
Returns
| Type |
Description |
| TProcessorDescriptor |
|
If(string)
A painless script predicate that can control whether this processor should be executed or not
Declaration
public TProcessorDescriptor If(string painlessPredicate)
Parameters
| Type |
Name |
Description |
| string |
painlessPredicate |
|
Returns
| Type |
Description |
| TProcessorDescriptor |
|
IgnoreFailure(bool?)
When a failure happens, ignore it and proceed to the next processor
Declaration
public TProcessorDescriptor IgnoreFailure(bool? ignoreFailure = true)
Parameters
| Type |
Name |
Description |
| bool? |
ignoreFailure |
|
Returns
| Type |
Description |
| TProcessorDescriptor |
|
OnFailure(IEnumerable<IProcessor>)
If a processor fails, call these processors instead. Read more about handling failures here:
Declaration
public TProcessorDescriptor OnFailure(IEnumerable<IProcessor> processors)
Parameters
Returns
| Type |
Description |
| TProcessorDescriptor |
|
OnFailure(Func<ProcessorsDescriptor, IPromise<IList<IProcessor>>>)
If a processor fails, call these processors instead. Read more about handling failures here:
Declaration
public TProcessorDescriptor OnFailure(Func<ProcessorsDescriptor, IPromise<IList<IProcessor>>> selector)
Parameters
Returns
| Type |
Description |
| TProcessorDescriptor |
|
Tag(string)
A tag is simply a string identifier of the specific instantiation of a certain processor
in a pipeline. The tag field does not affect the processor’s behavior, but is very useful
for bookkeeping and tracing errors to specific processors.
Declaration
public TProcessorDescriptor Tag(string tag)
Parameters
| Type |
Name |
Description |
| string |
tag |
|
Returns
| Type |
Description |
| TProcessorDescriptor |
|
Implements
Extension Methods