org.elasticsearch.search.aggregations.metrics

Class ValuesSourceMetricsAggregationBuilder<B extends ValuesSourceMetricsAggregationBuilder<B>>

java.lang.Object

org.elasticsearch.search.aggregations.AbstractAggregationBuilder

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

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

All Implemented Interfaces:

ToXContent

Direct Known Subclasses:

AvgBuilder, CardinalityBuilder, ExtendedStatsBuilder, GeoCentroidBuilder, MaxBuilder, MinBuilder, PercentileRanksBuilder, PercentilesBuilder, StatsBuilder, SumBuilder, ValueCountBuilder

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

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	ValuesSourceMetricsAggregationBuilder(String name, String type)

Method Summary

Methods

Modifier and Type	Method and Description
B	field(String field)
B	format(String format)
protected void	internalXContent(XContentBuilder builder, ToXContent.Params params)
B	missing(Object missingValue) Configure the value to use when documents miss a value.
B	script(Script script) The script to use for this aggregation

Methods inherited from class org.elasticsearch.search.aggregations.metrics.MetricsAggregationBuilder

setMetaData, toXContent

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

ValuesSourceMetricsAggregationBuilder

protected ValuesSourceMetricsAggregationBuilder(String name,
                                     String type)

Method Detail

field

public B field(String field)

script

public B script(Script script)

The script to use for this aggregation

format

public B format(String format)

missing

public B missing(Object missingValue)

Configure the value to use when documents miss a value.

internalXContent

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

Specified by:

internalXContent in class MetricsAggregationBuilder<B extends ValuesSourceMetricsAggregationBuilder<B>>

Throws:

IOException