Metric aggregation initialization context
edit
IMPORTANT: This documentation is no longer updated. Refer to Elastic's version policy and the latest documentation.
Metric aggregation initialization context
editUse a Painless script to initialize values for use in a scripted metric aggregation. An initialization script is run prior to document collection once per shard and is optional as part of the full metric aggregation.
Variables
-
params(Map, read-only) - User-defined parameters passed in as part of the query.
-
state(Map) -
Empty
Mapused to add values for use in a map script.
Side Effects
-
state(Map) -
Add values to this
Mapto for use in a map. Additional values must be of the typeMap,List,Stringor primitive.
Return
-
void - No expected return value.
API
The standard Painless API is available.