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:

NamedWriteable, Writeable

public class SumBucketPipelineAggregator
extends BucketMetricsPipelineAggregator

Nested Class Summary

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

PipelineAggregator.Parser

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

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

format, gapPolicy

Constructor Summary

Constructors

Modifier	Constructor and Description
	SumBucketPipelineAggregator(StreamInput in) Read from a stream.
protected	SumBucketPipelineAggregator(java.lang.String name, java.lang.String[] bucketsPaths, BucketHelpers.GapPolicy gapPolicy, DocValueFormat formatter, java.util.Map<java.lang.String,java.lang.Object> metaData)

Method Summary

Modifier and Type	Method and Description
protected InternalAggregation	buildAggregation(java.util.List<PipelineAggregator> pipelineAggregators, java.util.Map<java.lang.String,java.lang.Object> metadata) Called after a collection run is finished to build the aggregation for the collected state.
protected void	collectBucketValue(java.lang.String bucketKey, java.lang.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
java.lang.String	getWriteableName() Returns the name of the writeable object
protected void	preCollection() Called before initial collection and between successive collection runs.

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

doReduce, doWriteTo, 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, writeTo

Methods inherited from class java.lang.Object

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

Constructor Detail

SumBucketPipelineAggregator

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

SumBucketPipelineAggregator

public SumBucketPipelineAggregator(StreamInput in)
                            throws java.io.IOException

Read from a stream.

Throws:

java.io.IOException

Method Detail

getWriteableName

public java.lang.String getWriteableName()

Description copied from interface: NamedWriteable

Returns the name of the writeable object

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(java.lang.String bucketKey,
                                  java.lang.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(java.util.List<PipelineAggregator> pipelineAggregators,
                                               java.util.Map<java.lang.String,java.lang.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