Package org.opensearch.search.aggregations

Class PipelineAggregationBuilder

java.lang.Object

org.opensearch.search.aggregations.PipelineAggregationBuilder

All Implemented Interfaces:

org.opensearch.core.common.io.stream.NamedWriteable, org.opensearch.core.common.io.stream.Writeable, org.opensearch.core.xcontent.ToXContent, org.opensearch.core.xcontent.ToXContentFragment, Rewriteable<PipelineAggregationBuilder>, BaseAggregationBuilder

Direct Known Subclasses:

AbstractPipelineAggregationBuilder

@PublicApi(since="1.0.0")
public abstract class PipelineAggregationBuilder
extends Object
implements org.opensearch.core.common.io.stream.NamedWriteable, BaseAggregationBuilder, org.opensearch.core.xcontent.ToXContentFragment, Rewriteable<PipelineAggregationBuilder>

A factory that knows how to create an PipelineAggregator of a specific type.

Opensearch.api:

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PipelineAggregationBuilder.ValidationContext	The context used for validation

Nested classes/interfaces inherited from interface org.opensearch.core.xcontent.ToXContent

org.opensearch.core.xcontent.ToXContent.DelegatingMapParams, org.opensearch.core.xcontent.ToXContent.MapParams, org.opensearch.core.xcontent.ToXContent.Params

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

Modifier and Type	Field	Description
protected final String[]	bucketsPaths
protected final String	name

Fields inherited from interface org.opensearch.index.query.Rewriteable

MAX_REWRITE_ROUNDS

Fields inherited from interface org.opensearch.core.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	PipelineAggregationBuilder(String name, String[] bucketsPaths)	Constructs a new pipeline aggregator factory.

Method Summary

Modifier and Type	Method	Description
protected abstract PipelineAggregator	create()	Creates the pipeline aggregator
final String[]	getBucketsPaths()	Return the consumed buckets paths.
String	getName()	Return this aggregation's name.
PipelineAggregationBuilder	rewrite(QueryRewriteContext context)	Rewrites this instance based on the provided context.
abstract PipelineAggregationBuilder	setMetadata(Map<String,Object> metadata)	Associate metadata with this PipelineAggregationBuilder.
PipelineAggregationBuilder	subAggregations(AggregatorFactories.Builder subFactories)	Set the sub aggregations if this aggregation supports sub aggregations.
String	toString()
protected abstract void	validate(PipelineAggregationBuilder.ValidationContext context)	Makes sure this builder is properly configured.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.search.aggregations.BaseAggregationBuilder

getType

Methods inherited from interface org.opensearch.core.common.io.stream.NamedWriteable

getWriteableName

Methods inherited from interface org.opensearch.core.xcontent.ToXContent

toXContent

Methods inherited from interface org.opensearch.core.xcontent.ToXContentFragment

isFragment

Methods inherited from interface org.opensearch.core.common.io.stream.Writeable

writeTo

Field Details

name

protected final String name

bucketsPaths

protected final String[] bucketsPaths

Constructor Details

PipelineAggregationBuilder

protected PipelineAggregationBuilder(String name,
 String[] bucketsPaths)

Constructs a new pipeline aggregator factory.

Parameters:

name - The aggregation name

Method Details

getName

public String getName()

Return this aggregation's name.

getBucketsPaths

public final String[] getBucketsPaths()

Return the consumed buckets paths.

validate

protected abstract void validate(PipelineAggregationBuilder.ValidationContext context)

Makes sure this builder is properly configured.

create

protected abstract PipelineAggregator create()

Creates the pipeline aggregator

Returns:

The created aggregator

setMetadata

public abstract PipelineAggregationBuilder setMetadata(Map<String,Object> metadata)

Associate metadata with this PipelineAggregationBuilder.

Specified by:

setMetadata in interface BaseAggregationBuilder

subAggregations

public PipelineAggregationBuilder subAggregations(AggregatorFactories.Builder subFactories)

Description copied from interface: BaseAggregationBuilder

Set the sub aggregations if this aggregation supports sub aggregations. Returns this for chaining.

Specified by:

subAggregations in interface BaseAggregationBuilder

toString

public String toString()

Overrides:

toString in class Object

rewrite

public PipelineAggregationBuilder rewrite(QueryRewriteContext context)
                                   throws IOException

Rewrites this instance based on the provided context. The returned objects will be the same instance as this if no changes during the rewrite were applied.

The default implementation return the same instance. It should be overridden by aggregations that must load data before they can be run, particularly if that load must by asynchronous.

Specified by:

rewrite in interface Rewriteable<PipelineAggregationBuilder>

Throws:

IOException