OpenSearch/docs/painless/painless-contexts/painless-watcher-transform-...

39 lines
1.0 KiB
Plaintext

[[painless-watcher-transform-context]]
=== Watcher transform context
Use a Painless script to {xp_version}/transform-script.html[transform] watch
data into a new payload for use in a response to a condition.
*Variables*
`params` (`Map`, read-only)::
User-defined parameters passed in as part of the query.
`ctx['watch_id']` (`String`, read-only)::
The id of the watch.
`ctx['execution_time']` (`DateTime`, read-only)::
The start time for the watch.
`ctx['trigger']['scheduled_time']` (`DateTime`, read-only)::
The scheduled trigger time for the watch.
`ctx['trigger']['triggered_time']` (`DateTime`, read-only)::
The actual trigger time for the watch.
`ctx['metadata']` (`Map`, read-only)::
Any metadata associated with the watch.
`ctx['payload']` (`Map`, read-only)::
The accessible watch data based upon the
{xp_version}/input.html[watch input].
*Return*
`Object`::
The new payload.
*API*
The standard <<painless-api-reference, Painless API>> is available.