Class ScriptProcessorDescriptor

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

Inheritance
object
DescriptorBase<ScriptProcessorDescriptor, IScriptProcessor>
ProcessorDescriptorBase<ScriptProcessorDescriptor, IScriptProcessor>
ScriptProcessorDescriptor
Implements
Inherited Members
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

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

Extension Methods