honeymoose
/
OpenSearch
mirror of https://github.com/honeymoose/OpenSearch.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
OpenSearch/docs/painless/painless-contexts/painless-watcher-condition-...

38 lines
1.1 KiB
Plaintext
Raw Normal View History

Painless: Add Context Docs (#31190) Adds documentation for each the variables and API available with each script context usable with a Painless script.
2018-07-02 17:44:36 -04:00
[[painless-watcher-condition-context]]
=== Watcher condition context
Painless: Fix documentation links to use existing refs (#32335) Uses ref and xpack-ref instead of custom ones in the Painless docs for long-term maintainability.
2018-07-25 13:59:25 -04:00
Use a Painless script as a {xpack-ref}/condition-script.html[watcher condition]
Painless: Add Context Docs (#31190) Adds documentation for each the variables and API available with each script context usable with a Painless script.
2018-07-02 17:44:36 -04:00
to test if a response is necessary.
*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.
Scripting: Switch watcher to use joda bwc time objects (#35966) This commit converts the watcher execution context to use the joda compat java time objects. It also again removes the joda methods from the painless whitelist.
2018-12-10 20:29:25 -05:00
`ctx['execution_time']` (`ZonedDateTime`, read-only)::
Painless: Add Context Docs (#31190) Adds documentation for each the variables and API available with each script context usable with a Painless script.
2018-07-02 17:44:36 -04:00
The start time for the watch.
Scripting: Switch watcher to use joda bwc time objects (#35966) This commit converts the watcher execution context to use the joda compat java time objects. It also again removes the joda methods from the painless whitelist.
2018-12-10 20:29:25 -05:00
`ctx['trigger']['scheduled_time']` (`ZonedDateTime`, read-only)::
Painless: Add Context Docs (#31190) Adds documentation for each the variables and API available with each script context usable with a Painless script.
2018-07-02 17:44:36 -04:00
The scheduled trigger time for the watch.
Scripting: Switch watcher to use joda bwc time objects (#35966) This commit converts the watcher execution context to use the joda compat java time objects. It also again removes the joda methods from the painless whitelist.
2018-12-10 20:29:25 -05:00
`ctx['trigger']['triggered_time']` (`ZonedDateTime`, read-only)::
Painless: Add Context Docs (#31190) Adds documentation for each the variables and API available with each script context usable with a Painless script.
2018-07-02 17:44:36 -04:00
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
Painless: Fix documentation links to use existing refs (#32335) Uses ref and xpack-ref instead of custom ones in the Painless docs for long-term maintainability.
2018-07-25 13:59:25 -04:00
{xpack-ref}/input.html[watch input].
Painless: Add Context Docs (#31190) Adds documentation for each the variables and API available with each script context usable with a Painless script.
2018-07-02 17:44:36 -04:00
*Return*
`boolean`::
Expects `true` if the condition is met, and `false` otherwise.
*API*
The standard <<painless-api-reference, Painless API>> is available.