Search Results for

    Show / Hide Table of Contents

    Class ProcessorDescriptorBase<TProcessorDescriptor, TProcessorInterface>

    Ingest pipelines are composed of one or more processors

    Inheritance
    object
    DescriptorBase<TProcessorDescriptor, TProcessorInterface>
    ProcessorDescriptorBase<TProcessorDescriptor, TProcessorInterface>
    AppendProcessorDescriptor<T>
    AttachmentProcessorDescriptor<T>
    BytesProcessorDescriptor<T>
    ConvertProcessorDescriptor<T>
    CsvProcessorDescriptor<T>
    DateIndexNameProcessorDescriptor<T>
    DateProcessorDescriptor<T>
    DissectProcessorDescriptor<T>
    DotExpanderProcessorDescriptor<T>
    DropProcessorDescriptor
    FailProcessorDescriptor
    FingerprintProcessorDescriptor<T>
    ForeachProcessorDescriptor<T>
    GeoIpProcessorDescriptor<T>
    GrokProcessorDescriptor<T>
    GsubProcessorDescriptor<T>
    InferenceProcessorDescriptorBase<T, TInferenceProcessorDescriptor, TInferenceProcessorInterface>
    JoinProcessorDescriptor<T>
    JsonProcessorDescriptor<T>
    KeyValueProcessorDescriptor<T>
    LowercaseProcessorDescriptor<T>
    NetworkCommunityIdProcessorDescriptor<T>
    NetworkDirectionProcessorDescriptor<T>
    PipelineProcessorDescriptor
    RemoveProcessorDescriptor<T>
    RenameProcessorDescriptor<T>
    ScriptProcessorDescriptor
    SetProcessorDescriptor<T>
    SortProcessorDescriptor<T>
    SplitProcessorDescriptor<T>
    TrimProcessorDescriptor<T>
    UppercaseProcessorDescriptor<T>
    UriPartsProcessorDescriptor<T>
    UrlDecodeProcessorDescriptor<T>
    UserAgentProcessorDescriptor<T>
    Implements
    IDescriptor
    IProcessor
    Inherited Members
    DescriptorBase<TProcessorDescriptor, TProcessorInterface>.Self
    DescriptorBase<TProcessorDescriptor, TProcessorInterface>.Assign<TValue>(TValue, Action<TProcessorInterface, TValue>)
    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 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
    Type Description
    string

    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
    | Edit this page View Source

    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
    | Edit this page View Source

    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
    | Edit this page View Source

    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
    Type Name Description
    IEnumerable<IProcessor> processors
    Returns
    Type Description
    TProcessorDescriptor
    | Edit this page View Source

    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
    Type Name Description
    Func<ProcessorsDescriptor, IPromise<IList<IProcessor>>> selector
    Returns
    Type Description
    TProcessorDescriptor
    | Edit this page View Source

    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

    IDescriptor
    IProcessor

    Extension Methods

    SuffixExtensions.Suffix(object, string)
    • Edit this page
    • View Source
    In this article
    • Properties
      • Name
    • Methods
      • Description(string)
      • If(string)
      • IgnoreFailure(bool?)
      • OnFailure(IEnumerable<IProcessor>)
      • OnFailure(Func<ProcessorsDescriptor, IPromise<IList<IProcessor>>>)
      • Tag(string)
    • Implements
    • Extension Methods
    Back to top Generated by DocFX