org.elasticsearch.search.aggregations.metrics

Class MetricsAggregationBuilder<B extends MetricsAggregationBuilder<B>>

java.lang.Object

org.elasticsearch.search.aggregations.AbstractAggregationBuilder

org.elasticsearch.search.aggregations.metrics.MetricsAggregationBuilder<B>

All Implemented Interfaces:

ToXContent

Direct Known Subclasses:

ScriptedMetricBuilder, ValuesSourceMetricsAggregationBuilder

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

Base builder for metrics aggregations.

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

Constructor and Description
MetricsAggregationBuilder(String name, String type)

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract void	internalXContent(XContentBuilder builder, ToXContent.Params params)
B	setMetaData(Map<String,Object> metaData) Sets the meta data to be included in the metric 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

MetricsAggregationBuilder

public MetricsAggregationBuilder(String name,
                         String type)

Method Detail

setMetaData

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

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

toXContent

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

Throws:

IOException

internalXContent

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

Throws:

IOException