Package org.opensearch.search.aggregations.pipeline

Class MinBucketPipelineAggregator

java.lang.Object

org.opensearch.search.aggregations.pipeline.PipelineAggregator

org.opensearch.search.aggregations.pipeline.SiblingPipelineAggregator

org.opensearch.search.aggregations.pipeline.BucketMetricsPipelineAggregator

org.opensearch.search.aggregations.pipeline.MinBucketPipelineAggregator

All Implemented Interfaces:

org.opensearch.core.common.io.stream.NamedWriteable, org.opensearch.core.common.io.stream.Writeable

public class MinBucketPipelineAggregator
extends BucketMetricsPipelineAggregator

Aggregate all docs into a min bucket

Opensearch.internal:

Nested Class Summary

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

PipelineAggregator.Parser, PipelineAggregator.PipelineTree

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

org.opensearch.core.common.io.stream.Writeable.Reader<V>, org.opensearch.core.common.io.stream.Writeable.WriteableRegistry, org.opensearch.core.common.io.stream.Writeable.Writer<V>

Field Summary

Fields inherited from class org.opensearch.search.aggregations.pipeline.BucketMetricsPipelineAggregator

format, gapPolicy

Constructor Summary

Constructors

Constructor	Description
MinBucketPipelineAggregator(org.opensearch.core.common.io.stream.StreamInput in)	Read from a stream.

Method Summary

Modifier and Type	Method	Description
protected InternalAggregation	buildAggregation(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
String	getWriteableName()	The name of the writeable object.
protected void	preCollection()	Called before initial collection and between successive collection runs.

Methods inherited from class org.opensearch.search.aggregations.pipeline.BucketMetricsPipelineAggregator

doReduce, doWriteTo, innerWriteTo

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

reduce

Methods inherited from class org.opensearch.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 Details

MinBucketPipelineAggregator

public MinBucketPipelineAggregator(org.opensearch.core.common.io.stream.StreamInput in)
                            throws IOException

Read from a stream.

Throws:

IOException

Method Details

getWriteableName

public String getWriteableName()

Description copied from class: PipelineAggregator

The name of the writeable object.

Specified by:

getWriteableName in interface org.opensearch.core.common.io.stream.NamedWriteable

Overrides:

getWriteableName 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(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:

metadata - the metadata to add to the resulting aggregation