org.elasticsearch.search.aggregations.metrics.percentiles

Class PercentilesBuilder

java.lang.Object

org.elasticsearch.search.aggregations.AbstractAggregationBuilder

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

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

org.elasticsearch.search.aggregations.metrics.percentiles.PercentilesBuilder

All Implemented Interfaces:

ToXContent

public class PercentilesBuilder
extends ValuesSourceMetricsAggregationBuilder<PercentilesBuilder>

Builder for the Percentiles aggregation.

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
PercentilesBuilder(String name) Sole constructor.

Method Summary

Modifier and Type	Method and Description
PercentilesBuilder	compression(double compression) Expert: set the compression.
protected void	internalXContent(XContentBuilder builder, ToXContent.Params params)
PercentilesBuilder	percentiles(double... percentiles) Set the percentiles to compute.

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

field, format, lang, param, params, script

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

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

PercentilesBuilder

public PercentilesBuilder(String name)

Sole constructor.

Method Detail

percentiles

public PercentilesBuilder percentiles(double... percentiles)

Set the percentiles to compute.

compression

public PercentilesBuilder compression(double compression)

Expert: set the compression. Higher values improve accuracy but also memory usage.

internalXContent

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

Overrides:

internalXContent in class ValuesSourceMetricsAggregationBuilder<PercentilesBuilder>

Throws:

IOException