Module org.elasticsearch.server

Package org.elasticsearch.search.aggregations.pipeline

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.BucketMetricsPipelineAggregationBuilder<AF>

All Implemented Interfaces:

NamedWriteable, VersionedNamedWriteable, Writeable, Rewriteable<PipelineAggregationBuilder>, BaseAggregationBuilder, ToXContent, ToXContentFragment

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 class org.elasticsearch.search.aggregations.PipelineAggregationBuilder

PipelineAggregationBuilder.ValidationContext

Nested classes/interfaces inherited from interface org.elasticsearch.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.index.query.Rewriteable

MAX_REWRITE_ROUNDS

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BucketMetricsPipelineAggregationBuilder(String name, String type, String[] bucketsPaths)
protected	BucketMetricsPipelineAggregationBuilder(String name, String type, String[] bucketsPaths, String format, BucketHelpers.GapPolicy gapPolicy)
protected	BucketMetricsPipelineAggregationBuilder(StreamInput in, String type)	Read from a stream.

Method Summary

Modifier and Type	Method	Description
protected abstract PipelineAggregator	createInternal(Map<String,Object> metadata)
protected final void	doWriteTo(StreamOutput out)
protected abstract XContentBuilder	doXContentBody(XContentBuilder builder, ToXContent.Params params)
boolean	equals(Object obj)
String	format()	Gets the format to use on the output of this aggregation.
AF	format(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.
int	hashCode()
protected abstract void	innerWriteTo(StreamOutput out)
protected final XContentBuilder	internalXContent(XContentBuilder builder, ToXContent.Params params)
protected void	validate(PipelineAggregationBuilder.ValidationContext context)	Makes sure this builder is properly configured.

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

create, getType, overrideBucketsPath, setMetadata, toXContent, type, writeTo

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

getBucketsPaths, getName, rewrite, subAggregations, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.xcontent.ToXContentFragment

isFragment

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

getMinimalSupportedVersion, getWriteableName

Constructor Details

BucketMetricsPipelineAggregationBuilder

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

BucketMetricsPipelineAggregationBuilder

protected BucketMetricsPipelineAggregationBuilder(String name,
 String type,
 String[] bucketsPaths,
 String format,
 BucketHelpers.GapPolicy gapPolicy)

BucketMetricsPipelineAggregationBuilder

protected BucketMetricsPipelineAggregationBuilder(StreamInput in,
 String type)
                                           throws IOException

Read from a stream.

Throws:

IOException

Method Details

doWriteTo

protected final void doWriteTo(StreamOutput out)
                        throws IOException

Specified by:

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

Throws:

IOException

innerWriteTo

protected abstract void innerWriteTo(StreamOutput out)
                              throws IOException

Throws:

IOException

format

public AF format(String format)

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

format

public 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(Map<String,Object> metadata)

Specified by:

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

validate

protected void validate(PipelineAggregationBuilder.ValidationContext context)

Description copied from class: PipelineAggregationBuilder

Makes sure this builder is properly configured.

Specified by:

validate in class PipelineAggregationBuilder

internalXContent

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

Specified by:

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

Throws:

IOException

doXContentBody

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

Throws:

IOException

hashCode

public int hashCode()

Overrides:

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

equals

public boolean equals(Object obj)

Overrides:

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