Interface IProcessor

Ingest pipelines are composed of one or more processors

Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public interface IProcessor

Properties

| Edit this page View Source

Description

A description to explain the purpose of the specific processor instance.

Declaration
[DataMember(Name = "description")]
string Description { get; set; }
Property Value
Type Description
string
| Edit this page View Source

If

A painless script predicate that can control whether this processor should be executed or not

Declaration
[DataMember(Name = "if")]
string If { get; set; }
Property Value
Type Description
string
| Edit this page View Source

IgnoreFailure

When a failure happens, ignore it and proceed to the next processor

Declaration
[DataMember(Name = "ignore_failure")]
bool? IgnoreFailure { get; set; }
Property Value
Type Description
bool?
| Edit this page View Source

Name

The name of the processor, will be used as the key when persisting the processor on the pipeline

Declaration
[IgnoreDataMember]
string Name { get; }
Property Value
Type Description
string
| Edit this page View Source

OnFailure

If a processor fails, call these processors instead. Read more about handling failures here:

Declaration
[DataMember(Name = "on_failure")]
IEnumerable<IProcessor> OnFailure { get; set; }
Property Value
Type Description
IEnumerable<IProcessor>
| Edit this page View Source

Tag

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
[DataMember(Name = "tag")]
string Tag { get; set; }
Property Value
Type Description
string

Extension Methods