Package org.elasticsearch.search.aggregations.pipeline.bucketmetrics

Class BucketMetricsPipelineAggregationBuilder<AF extends BucketMetricsPipelineAggregationBuilder<AF>>

java.lang.Object

org.elasticsearch.search.aggregations.PipelineAggregationBuilder

org.elasticsearch.search.aggregations.pipeline.AbstractPipelineAggregationBuilder<AF>

org.elasticsearch.search.aggregations.pipeline.bucketmetrics.BucketMetricsPipelineAggregationBuilder<AF>

All Implemented Interfaces:

NamedWriteable, Writeable, ToXContent, ToXContentFragment, BaseAggregationBuilder

Direct Known Subclasses:

AvgBucketPipelineAggregationBuilder, ExtendedStatsBucketPipelineAggregationBuilder, MaxBucketPipelineAggregationBuilder, MinBucketPipelineAggregationBuilder, PercentilesBucketPipelineAggregationBuilder, StatsBucketPipelineAggregationBuilder, SumBucketPipelineAggregationBuilder

public abstract class BucketMetricsPipelineAggregationBuilder<AF extends BucketMetricsPipelineAggregationBuilder<AF>>
extends AbstractPipelineAggregationBuilder<AF>

Nested Class Summary

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields inherited from class org.elasticsearch.search.aggregations.pipeline.AbstractPipelineAggregationBuilder

BUCKETS_PATH_FIELD, metaData, type

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

bucketsPaths, name

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

EMPTY_PARAMS

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BucketMetricsPipelineAggregationBuilder(java.lang.String name, java.lang.String type, java.lang.String[] bucketsPaths)
protected	BucketMetricsPipelineAggregationBuilder(StreamInput in, java.lang.String type)	Read from a stream.

Method Summary

Modifier and Type	Method	Description
protected abstract PipelineAggregator	createInternal(java.util.Map<java.lang.String,java.lang.Object> metaData)
protected boolean	doEquals(java.lang.Object obj)
protected int	doHashCode()
void	doValidate(AggregatorFactory<?> parent, java.util.List<AggregationBuilder> aggBuilders, java.util.List<PipelineAggregationBuilder> pipelineAggregatorFactories)
protected void	doWriteTo(StreamOutput out)
protected abstract XContentBuilder	doXContentBody(XContentBuilder builder, ToXContent.Params params)
java.lang.String	format()	Gets the format to use on the output of this aggregation.
AF	format(java.lang.String format)	Sets the format to use on the output of this aggregation.
protected DocValueFormat	formatter()
BucketHelpers.GapPolicy	gapPolicy()	Gets the gap policy to use for this aggregation.
AF	gapPolicy(BucketHelpers.GapPolicy gapPolicy)	Sets the gap policy to use for this aggregation.
protected abstract boolean	innerEquals(BucketMetricsPipelineAggregationBuilder<AF> other)
protected abstract int	innerHashCode()
protected abstract void	innerWriteTo(StreamOutput out)
protected XContentBuilder	internalXContent(XContentBuilder builder, ToXContent.Params params)

Methods inherited from class org.elasticsearch.search.aggregations.pipeline.AbstractPipelineAggregationBuilder

create, equals, getType, hashCode, overrideBucketsPath, setMetaData, toXContent, type, validate, writeTo

Methods inherited from interface org.elasticsearch.common.io.stream.NamedWriteable

getWriteableName

Methods inherited from class java.lang.Object

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

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

getBucketsPaths, getName, subAggregations, toString

Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentFragment

isFragment

Constructor Detail

BucketMetricsPipelineAggregationBuilder

protected BucketMetricsPipelineAggregationBuilder(java.lang.String name,
                                                  java.lang.String type,
                                                  java.lang.String[] bucketsPaths)

BucketMetricsPipelineAggregationBuilder

protected BucketMetricsPipelineAggregationBuilder(StreamInput in,
                                                  java.lang.String type)
                                           throws java.io.IOException

Read from a stream.

Throws:

java.io.IOException

Method Detail

doWriteTo

protected final void doWriteTo(StreamOutput out)
                        throws java.io.IOException

Specified by:

doWriteTo in class AbstractPipelineAggregationBuilder<AF extends BucketMetricsPipelineAggregationBuilder<AF>>

Throws:

java.io.IOException

innerWriteTo

protected abstract void innerWriteTo(StreamOutput out)
                              throws java.io.IOException

Throws:

java.io.IOException

format

public AF format(java.lang.String format)

Sets the format to use on the output of this aggregation.

format

public java.lang.String format()

Gets the format to use on the output of this aggregation.

formatter

protected DocValueFormat formatter()

gapPolicy

public AF gapPolicy(BucketHelpers.GapPolicy gapPolicy)

Sets the gap policy to use for this aggregation.

gapPolicy

public BucketHelpers.GapPolicy gapPolicy()

Gets the gap policy to use for this aggregation.

createInternal

protected abstract PipelineAggregator createInternal(java.util.Map<java.lang.String,java.lang.Object> metaData)
                                              throws java.io.IOException

Specified by:

createInternal in class AbstractPipelineAggregationBuilder<AF extends BucketMetricsPipelineAggregationBuilder<AF>>

Throws:

java.io.IOException

doValidate

public void doValidate(AggregatorFactory<?> parent,
                       java.util.List<AggregationBuilder> aggBuilders,
                       java.util.List<PipelineAggregationBuilder> pipelineAggregatorFactories)

Overrides:

doValidate in class AbstractPipelineAggregationBuilder<AF extends BucketMetricsPipelineAggregationBuilder<AF>>

internalXContent

protected final XContentBuilder internalXContent(XContentBuilder builder,
                                                 ToXContent.Params params)
                                          throws java.io.IOException

Specified by:

internalXContent in class AbstractPipelineAggregationBuilder<AF extends BucketMetricsPipelineAggregationBuilder<AF>>

Throws:

java.io.IOException

doXContentBody

protected abstract XContentBuilder doXContentBody(XContentBuilder builder,
                                                  ToXContent.Params params)
                                           throws java.io.IOException

Throws:

java.io.IOException

doHashCode

protected final int doHashCode()

Specified by:

doHashCode in class AbstractPipelineAggregationBuilder<AF extends BucketMetricsPipelineAggregationBuilder<AF>>

innerHashCode

protected abstract int innerHashCode()

doEquals

protected final boolean doEquals(java.lang.Object obj)

Specified by:

doEquals in class AbstractPipelineAggregationBuilder<AF extends BucketMetricsPipelineAggregationBuilder<AF>>

innerEquals

protected abstract boolean innerEquals(BucketMetricsPipelineAggregationBuilder<AF> other)