Search Results for

    Show / Hide Table of Contents

    Class ProcessorBase

    Ingest pipelines are composed of one or more processors

    Inheritance
    object
    ProcessorBase
    AppendProcessor
    AttachmentProcessor
    BytesProcessor
    ConvertProcessor
    CsvProcessor
    DateIndexNameProcessor
    DateProcessor
    DissectProcessor
    DotExpanderProcessor
    DropProcessor
    FailProcessor
    FingerprintProcessor
    ForeachProcessor
    GeoIpProcessor
    GrokProcessor
    GsubProcessor
    InferenceProcessorBase
    JoinProcessor
    JsonProcessor
    KeyValueProcessor
    LowercaseProcessor
    NetworkCommunityIdProcessor
    NetworkDirectionProcessor
    PipelineProcessor
    RemoveProcessor
    RenameProcessor
    ScriptProcessor
    SetProcessor
    SortProcessor
    SplitProcessor
    TrimProcessor
    UppercaseProcessor
    UriPartsProcessor
    UrlDecodeProcessor
    UserAgentProcessor
    Implements
    IProcessor
    Inherited Members
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: OpenSearch.Client
    Assembly: OpenSearch.Client.dll
    Syntax
    public abstract class ProcessorBase : IProcessor

    Properties

    | Edit this page View Source

    Description

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

    Declaration
    public 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
    public 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
    public bool? IgnoreFailure { get; set; }
    Property Value
    Type Description
    bool?
    | Edit this page View Source

    Name

    Declaration
    protected abstract 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
    public 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
    public string Tag { get; set; }
    Property Value
    Type Description
    string

    Implements

    IProcessor

    Extension Methods

    SuffixExtensions.Suffix(object, string)
    • Edit this page
    • View Source
    In this article
    • Properties
      • Description
      • If
      • IgnoreFailure
      • Name
      • OnFailure
      • Tag
    • Implements
    • Extension Methods
    Back to top Generated by DocFX