Package org.opensearch.search.aggregations.pipeline

Class SiblingPipelineAggregator

java.lang.Object

org.opensearch.search.aggregations.pipeline.PipelineAggregator

org.opensearch.search.aggregations.pipeline.SiblingPipelineAggregator

All Implemented Interfaces:

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

Direct Known Subclasses:

BucketMetricsPipelineAggregator

@PublicApi(since="1.0.0")
public abstract class SiblingPipelineAggregator
extends PipelineAggregator

Aggregate all docs into a sibling bucket

Opensearch.api:

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>

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	SiblingPipelineAggregator(String name, String[] bucketsPaths, Map<String,Object> metadata)

Method Summary

Modifier and Type	Method	Description
abstract InternalAggregation	doReduce(Aggregations aggregations, InternalAggregation.ReduceContext context)
InternalAggregation	reduce(InternalAggregation aggregation, InternalAggregation.ReduceContext reduceContext)

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

bucketsPaths, doWriteTo, getWriteableName, metadata, name, writeTo

Methods inherited from class java.lang.Object

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

Constructor Details

SiblingPipelineAggregator

protected SiblingPipelineAggregator(String name,
 String[] bucketsPaths,
 Map<String,Object> metadata)

Method Details

reduce

public InternalAggregation reduce(InternalAggregation aggregation,
 InternalAggregation.ReduceContext reduceContext)

Specified by:

reduce in class PipelineAggregator

doReduce

public abstract InternalAggregation doReduce(Aggregations aggregations,
 InternalAggregation.ReduceContext context)