Script payload transform
editScript payload transform
editA payload transform that executes a script on the current payload in the watch execution context and replaces it with a newly generated one. The following snippet shows how a simple script payload transform can be defined on the watch level:
A simple |
The executed script may either return a valid model that is the equivalent
of a Java™ Map or a JSON object (you will need to consult the
documentation of the specific scripting language to find out what this
construct is). Any other value that is returned will be assigned and
accessible to/via the _value
variable.
The script
attribute may hold a string value in which case it will be treated
as an inline script and the default elasticsearch script languages will be assumed
(as described in Scripting). You can
use the other scripting languages supported by Elasticsearch. For this, you need
to set the script
field to an object describing the script and its language.
The following table lists the possible settings that can be configured:
Table 97. Script payload transform settings
Name | Required | Default | Description |
---|---|---|---|
|
yes |
- |
When using an inline script, this field holds the script itself. |
|
yes |
- |
When referring to a stored script, this field holds the id of the script. |
|
no |
|
The script language |
|
no |
- |
Additional parameters/variables that are accessible by the script |
When using the object notation of the script, one (and only one) of inline
,
or id
fields must be defined.
In addition to the provided params
, the scripts also have access to the
standard watch execution context parameters.