Package org.opensearch.search.aggregations.pipeline

Class AbstractPipelineAggregationBuilder<PAB extends AbstractPipelineAggregationBuilder<PAB>>

java.lang.Object

org.opensearch.search.aggregations.PipelineAggregationBuilder

org.opensearch.search.aggregations.pipeline.AbstractPipelineAggregationBuilder<PAB>

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:

BucketMetricsPipelineAggregationBuilder, BucketScriptPipelineAggregationBuilder, BucketSelectorPipelineAggregationBuilder, BucketSortPipelineAggregationBuilder, CumulativeSumPipelineAggregationBuilder, DerivativePipelineAggregationBuilder, MovAvgPipelineAggregationBuilder, MovFnPipelineAggregationBuilder, SerialDiffPipelineAggregationBuilder

public abstract class AbstractPipelineAggregationBuilder<PAB extends AbstractPipelineAggregationBuilder<PAB>>
extends PipelineAggregationBuilder

Base implementation of a PipelineAggregationBuilder.

Opensearch.internal:

Nested Class Summary

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

PipelineAggregationBuilder.ValidationContext

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
static final org.opensearch.core.ParseField	BUCKETS_PATH_FIELD	Field shared by many parsers.
protected Map<String,Object>	metadata
protected final String	type

Fields inherited from class org.opensearch.search.aggregations.PipelineAggregationBuilder

bucketsPaths, 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	AbstractPipelineAggregationBuilder(String name, String type, String[] bucketsPaths)
protected	AbstractPipelineAggregationBuilder(org.opensearch.core.common.io.stream.StreamInput in, String type)	Read from a stream.

Method Summary

Modifier and Type	Method	Description
final PipelineAggregator	create()	Creates the pipeline aggregator
protected abstract PipelineAggregator	createInternal(Map<String,Object> metadata)
protected abstract void	doWriteTo(org.opensearch.core.common.io.stream.StreamOutput out)
boolean	equals(Object obj)
String	getType()	The name of the type of aggregation built by this builder.
int	hashCode()
protected abstract org.opensearch.core.xcontent.XContentBuilder	internalXContent(org.opensearch.core.xcontent.XContentBuilder builder, org.opensearch.core.xcontent.ToXContent.Params params)
protected boolean	overrideBucketsPath()
PAB	setMetadata(Map<String,Object> metadata)	Associate metadata with this PipelineAggregationBuilder.
final org.opensearch.core.xcontent.XContentBuilder	toXContent(org.opensearch.core.xcontent.XContentBuilder builder, org.opensearch.core.xcontent.ToXContent.Params params)
String	type()
void	writeTo(org.opensearch.core.common.io.stream.StreamOutput out)

Methods inherited from class org.opensearch.search.aggregations.PipelineAggregationBuilder

getBucketsPaths, getName, rewrite, subAggregations, toString, validate

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

getWriteableName

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

isFragment

Field Details

BUCKETS_PATH_FIELD

public static final org.opensearch.core.ParseField BUCKETS_PATH_FIELD

Field shared by many parsers.

type

protected final String type

metadata

protected Map<String,Object> metadata

Constructor Details

AbstractPipelineAggregationBuilder

protected AbstractPipelineAggregationBuilder(String name,
 String type,
 String[] bucketsPaths)

AbstractPipelineAggregationBuilder

protected AbstractPipelineAggregationBuilder(org.opensearch.core.common.io.stream.StreamInput in,
 String type)
                                      throws IOException

Read from a stream.

Throws:

IOException

Method Details

writeTo

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

Throws:

IOException

doWriteTo

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

Throws:

IOException

type

public String type()

createInternal

protected abstract PipelineAggregator createInternal(Map<String,Object> metadata)

create

public final PipelineAggregator create()

Creates the pipeline aggregator

Specified by:

create in class PipelineAggregationBuilder

Returns:

The created aggregator

setMetadata

public PAB setMetadata(Map<String,Object> metadata)

Description copied from class: PipelineAggregationBuilder

Associate metadata with this PipelineAggregationBuilder.

Specified by:

setMetadata in interface BaseAggregationBuilder

Specified by:

setMetadata in class PipelineAggregationBuilder

toXContent

public final org.opensearch.core.xcontent.XContentBuilder toXContent(org.opensearch.core.xcontent.XContentBuilder builder,
 org.opensearch.core.xcontent.ToXContent.Params params)
                                                              throws IOException

Throws:

IOException

overrideBucketsPath

protected boolean overrideBucketsPath()

Returns:

true if the AbstractPipelineAggregationBuilder overrides the XContent rendering of the bucketPath option.

internalXContent

protected abstract org.opensearch.core.xcontent.XContentBuilder internalXContent(org.opensearch.core.xcontent.XContentBuilder builder,
 org.opensearch.core.xcontent.ToXContent.Params params)
                                                                          throws IOException

Throws:

IOException

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getType

public String getType()

Description copied from interface: BaseAggregationBuilder

The name of the type of aggregation built by this builder.