org.elasticsearch.search.aggregations.pipeline

Class PipelineAggregatorBuilder<B extends PipelineAggregatorBuilder<B>>

java.lang.Object

org.elasticsearch.search.aggregations.AbstractAggregationBuilder

org.elasticsearch.search.aggregations.pipeline.PipelineAggregatorBuilder<B>

All Implemented Interfaces:

ToXContent

Direct Known Subclasses:

BucketMetricsBuilder, BucketScriptBuilder, BucketSelectorBuilder, CumulativeSumBuilder, DerivativeBuilder, MovAvgBuilder, SerialDiffBuilder

public abstract class PipelineAggregatorBuilder<B extends PipelineAggregatorBuilder<B>>
extends AbstractAggregationBuilder

A base class for all pipeline aggregator builders.

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

Fields inherited from class org.elasticsearch.search.aggregations.AbstractAggregationBuilder

type

Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PipelineAggregatorBuilder(String name, String type) Sole constructor, typically used by sub-classes.

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract XContentBuilder	internalXContent(XContentBuilder builder, ToXContent.Params params)
B	setBucketsPaths(String... bucketsPaths) Sets the paths to the buckets to use for this pipeline aggregator
B	setMetaData(Map<String,Object> metaData) Sets the meta data to be included in the pipeline aggregator's response
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)

Methods inherited from class org.elasticsearch.search.aggregations.AbstractAggregationBuilder

getName

Methods inherited from class java.lang.Object

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

Constructor Detail

PipelineAggregatorBuilder

protected PipelineAggregatorBuilder(String name,
                         String type)

Sole constructor, typically used by sub-classes.

Method Detail

setBucketsPaths

public B setBucketsPaths(String... bucketsPaths)

Sets the paths to the buckets to use for this pipeline aggregator

setMetaData

public B setMetaData(Map<String,Object> metaData)

Sets the meta data to be included in the pipeline aggregator's response

toXContent

public final XContentBuilder toXContent(XContentBuilder builder,
                         ToXContent.Params params)
                                 throws IOException

Throws:

IOException

internalXContent

protected abstract XContentBuilder internalXContent(XContentBuilder builder,
                               ToXContent.Params params)
                                             throws IOException

Throws:

IOException