org.elasticsearch.search.aggregations.pipeline.bucketmetrics.sum

Class SumBucketPipelineAggregator

java.lang.Object

org.elasticsearch.search.aggregations.pipeline.PipelineAggregator

org.elasticsearch.search.aggregations.pipeline.SiblingPipelineAggregator

org.elasticsearch.search.aggregations.pipeline.bucketmetrics.BucketMetricsPipelineAggregator

org.elasticsearch.search.aggregations.pipeline.bucketmetrics.sum.SumBucketPipelineAggregator

All Implemented Interfaces:

Streamable

public class SumBucketPipelineAggregator
extends BucketMetricsPipelineAggregator

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SumBucketPipelineAggregator.Factory

Nested classes/interfaces inherited from class org.elasticsearch.search.aggregations.pipeline.PipelineAggregator

PipelineAggregator.Parser

Field Summary

Fields

Modifier and Type	Field and Description
static PipelineAggregatorStreams.Stream	STREAM
static InternalAggregation.Type	TYPE

Fields inherited from class org.elasticsearch.search.aggregations.pipeline.bucketmetrics.BucketMetricsPipelineAggregator

formatter, gapPolicy

Fields inherited from class org.elasticsearch.search.aggregations.pipeline.PipelineAggregator

AGGREGATION_TRANFORM_FUNCTION

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SumBucketPipelineAggregator(String name, String[] bucketsPaths, BucketHelpers.GapPolicy gapPolicy, ValueFormatter formatter, Map<String,Object> metaData)

Method Summary

Methods

Modifier and Type	Method and Description
protected InternalAggregation	buildAggregation(List<PipelineAggregator> pipelineAggregators, Map<String,Object> metadata) Called after a collection run is finished to build the aggregation for the collected state.
protected void	collectBucketValue(String bucketKey, Double bucketValue) Called for each bucket with a value so the state can be modified based on the key and metric value for this bucket
protected void	preCollection() Called before initial collection and between successive collection runs.
static void	registerStreams()
InternalAggregation.Type	type()

Methods inherited from class org.elasticsearch.search.aggregations.pipeline.bucketmetrics.BucketMetricsPipelineAggregator

doReadFrom, doReduce, doWriteTo, innerReadFrom, innerWriteTo

Methods inherited from class org.elasticsearch.search.aggregations.pipeline.SiblingPipelineAggregator

reduce

Methods inherited from class org.elasticsearch.search.aggregations.pipeline.PipelineAggregator

bucketsPaths, metaData, name, readFrom, writeTo

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

TYPE

public static final InternalAggregation.Type TYPE

STREAM

public static final PipelineAggregatorStreams.Stream STREAM

Constructor Detail

SumBucketPipelineAggregator

protected SumBucketPipelineAggregator(String name,
                           String[] bucketsPaths,
                           BucketHelpers.GapPolicy gapPolicy,
                           ValueFormatter formatter,
                           Map<String,Object> metaData)

Method Detail

registerStreams

public static void registerStreams()

type

public InternalAggregation.Type type()

Specified by:

type in class PipelineAggregator

preCollection

protected void preCollection()

Description copied from class: BucketMetricsPipelineAggregator

Called before initial collection and between successive collection runs. A chance to initialize or re-initialize state

Overrides:

preCollection in class BucketMetricsPipelineAggregator

collectBucketValue

protected void collectBucketValue(String bucketKey,
                      Double bucketValue)

Description copied from class: BucketMetricsPipelineAggregator

Called for each bucket with a value so the state can be modified based on the key and metric value for this bucket

Specified by:

collectBucketValue in class BucketMetricsPipelineAggregator

Parameters:

bucketKey - the key for this bucket as a String

bucketValue - the value of the metric specified in bucketsPath for this bucket

buildAggregation

protected InternalAggregation buildAggregation(List<PipelineAggregator> pipelineAggregators,
                                   Map<String,Object> metadata)

Description copied from class: BucketMetricsPipelineAggregator

Called after a collection run is finished to build the aggregation for the collected state.

Specified by:

buildAggregation in class BucketMetricsPipelineAggregator

Parameters:

pipelineAggregators - the pipeline aggregators to add to the resulting aggregation

metadata - the metadata to add to the resulting aggregation