Search Results for

    Show / Hide Table of Contents

    Class ScriptProcessorDescriptor

    Allows inline, stored, and file scripts to be executed within ingest pipelines.

    Inheritance
    object
    DescriptorBase<ScriptProcessorDescriptor, IScriptProcessor>
    ProcessorDescriptorBase<ScriptProcessorDescriptor, IScriptProcessor>
    ScriptProcessorDescriptor
    Implements
    IDescriptor
    IScriptProcessor
    IProcessor
    Inherited Members
    ProcessorDescriptorBase<ScriptProcessorDescriptor, IScriptProcessor>.Name
    ProcessorDescriptorBase<ScriptProcessorDescriptor, IScriptProcessor>.Description(string)
    ProcessorDescriptorBase<ScriptProcessorDescriptor, IScriptProcessor>.OnFailure(IEnumerable<IProcessor>)
    ProcessorDescriptorBase<ScriptProcessorDescriptor, IScriptProcessor>.OnFailure(Func<ProcessorsDescriptor, IPromise<IList<IProcessor>>>)
    ProcessorDescriptorBase<ScriptProcessorDescriptor, IScriptProcessor>.If(string)
    ProcessorDescriptorBase<ScriptProcessorDescriptor, IScriptProcessor>.Tag(string)
    ProcessorDescriptorBase<ScriptProcessorDescriptor, IScriptProcessor>.IgnoreFailure(bool?)
    DescriptorBase<ScriptProcessorDescriptor, IScriptProcessor>.Self
    DescriptorBase<ScriptProcessorDescriptor, IScriptProcessor>.Assign<TValue>(TValue, Action<IScriptProcessor, 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 class ScriptProcessorDescriptor : ProcessorDescriptorBase<ScriptProcessorDescriptor, IScriptProcessor>, IDescriptor, IScriptProcessor, IProcessor

    Properties

    | Edit this page View Source

    Name

    Declaration
    protected override string Name { get; }
    Property Value
    Type Description
    string
    Overrides
    ProcessorDescriptorBase<ScriptProcessorDescriptor, IScriptProcessor>.Name

    Methods

    | Edit this page View Source

    Id(string)

    The stored script id to refer to

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

    Lang(string)

    The scripting language. Defaults to painless

    Declaration
    public ScriptProcessorDescriptor Lang(string lang)
    Parameters
    Type Name Description
    string lang
    Returns
    Type Description
    ScriptProcessorDescriptor
    | Edit this page View Source

    Params(Dictionary<string, object>)

    Parameters for the script

    Declaration
    public ScriptProcessorDescriptor Params(Dictionary<string, object> scriptParams)
    Parameters
    Type Name Description
    Dictionary<string, object> scriptParams
    Returns
    Type Description
    ScriptProcessorDescriptor
    | Edit this page View Source

    Params(Func<FluentDictionary<string, object>, FluentDictionary<string, object>>)

    Parameters for the script

    Declaration
    public ScriptProcessorDescriptor Params(Func<FluentDictionary<string, object>, FluentDictionary<string, object>> paramsSelector)
    Parameters
    Type Name Description
    Func<FluentDictionary<string, object>, FluentDictionary<string, object>> paramsSelector
    Returns
    Type Description
    ScriptProcessorDescriptor
    | Edit this page View Source

    Source(string)

    An inline script to be executed

    Declaration
    public ScriptProcessorDescriptor Source(string source)
    Parameters
    Type Name Description
    string source
    Returns
    Type Description
    ScriptProcessorDescriptor

    Implements

    IDescriptor
    IScriptProcessor
    IProcessor

    Extension Methods

    SuffixExtensions.Suffix(object, string)
    • Edit this page
    • View Source
    In this article
    • Properties
      • Name
    • Methods
      • Id(string)
      • Lang(string)
      • Params(Dictionary<string, object>)
      • Params(Func<FluentDictionary<string, object>, FluentDictionary<string, object>>)
      • Source(string)
    • Implements
    • Extension Methods
    Back to top Generated by DocFX