NOTE: You are looking at documentation for an older release. For the latest information, see the current release documentation.

« Metric aggregation map context Metric aggregation reduce context »

› ›

Metric aggregation combine context

edit

Metric aggregation combine context

edit

Use a Painless script to combine values for use in a scripted metric aggregation. A combine script is run once per shard following a map script and is optional as part of a full metric aggregation.

Variables

params (Map, read-only): User-defined parameters passed in as part of the query.
state (Map): Map with values available from the prior map script.

Return

List, Map, String, or primitive: A value collected for use in a reduce script. If no reduce script is specified, the value is used as part of the result.

API

The standard Painless API is available.

« Metric aggregation map context Metric aggregation reduce context »