Package org.opensearch.search.aggregations.pipeline

Class PipelineAggregator

java.lang.Object

org.opensearch.search.aggregations.pipeline.PipelineAggregator

All Implemented Interfaces:

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

Direct Known Subclasses:

BucketScriptPipelineAggregator, BucketSelectorPipelineAggregator, BucketSortPipelineAggregator, CumulativeSumPipelineAggregator, DerivativePipelineAggregator, MovAvgPipelineAggregator, MovFnPipelineAggregator, SerialDiffPipelineAggregator, SiblingPipelineAggregator

@PublicApi(since="1.0.0")
public abstract class PipelineAggregator
extends Object
implements org.opensearch.core.common.io.stream.NamedWriteable

Base aggregator for pipline aggs

Opensearch.api:

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	PipelineAggregator.Parser	Parse the PipelineAggregationBuilder from a XContentParser.
static class	PipelineAggregator.PipelineTree	Tree of PipelineAggregators to modify a tree of aggregations after their final reduction.

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	PipelineAggregator(String name, String[] bucketsPaths, Map<String,Object> metadata)
protected	PipelineAggregator(org.opensearch.core.common.io.stream.StreamInput in)	Deprecated. pipeline aggregations added after 7.8.0 shouldn't call this

Method Summary

Modifier and Type	Method	Description
String[]	bucketsPaths()
protected void	doWriteTo(org.opensearch.core.common.io.stream.StreamOutput out)	Deprecated. pipeline aggregations added after 7.8.0 don't need to implement this
String	getWriteableName()	Deprecated. pipeline aggregations added after 7.8.0 don't need to implement this
Map<String,Object>	metadata()
String	name()
abstract InternalAggregation	reduce(InternalAggregation aggregation, InternalAggregation.ReduceContext reduceContext)
final void	writeTo(org.opensearch.core.common.io.stream.StreamOutput out)	Deprecated. pipeline aggregations added after 7.8.0 shouldn't call this

Methods inherited from class java.lang.Object

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

Constructor Details

PipelineAggregator

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

PipelineAggregator

@Deprecated
protected PipelineAggregator(org.opensearch.core.common.io.stream.StreamInput in)
                      throws IOException

Deprecated.

pipeline aggregations added after 7.8.0 shouldn't call this

Read from a stream.

Throws:

IOException

Method Details

writeTo

@Deprecated
public final void writeTo(org.opensearch.core.common.io.stream.StreamOutput out)
                   throws IOException

Deprecated.

pipeline aggregations added after 7.8.0 shouldn't call this

Specified by:

writeTo in interface org.opensearch.core.common.io.stream.Writeable

Throws:

IOException

doWriteTo

@Deprecated
protected void doWriteTo(org.opensearch.core.common.io.stream.StreamOutput out)
                  throws IOException

Deprecated.

pipeline aggregations added after 7.8.0 don't need to implement this

Write the body of the aggregation to the wire.

Throws:

IOException

getWriteableName

@Deprecated
public String getWriteableName()

Deprecated.

pipeline aggregations added after 7.8.0 don't need to implement this

The name of the writeable object.

Specified by:

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

name

public String name()

bucketsPaths

public String[] bucketsPaths()

metadata

public Map<String,Object> metadata()

reduce

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