org.elasticsearch.search.aggregations.metrics.percentiles

Class PercentileRanksBuilder

java.lang.Object

org.elasticsearch.search.aggregations.AbstractAggregationBuilder

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

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

org.elasticsearch.search.aggregations.metrics.percentiles.PercentileRanksBuilder

All Implemented Interfaces:

ToXContent

public class PercentileRanksBuilder
extends ValuesSourceMetricsAggregationBuilder<PB>

Builder for the PercentileRanks 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
PercentileRanksBuilder(String name) Sole constructor.

Method Summary

Methods

Modifier and Type	Method and Description
PB	compression(double compression) Expert: set the compression.
protected void	doInternalXContent(XContentBuilder builder, ToXContent.Params params)
protected void	internalXContent(XContentBuilder builder, ToXContent.Params params)
PB	method(PercentilesMethod method) Expert: Set the method to use to compute the percentiles.
PB	numberOfSignificantValueDigits(int numberOfSignificantValueDigits) Expert: set the number of significant digits in the values.
PercentileRanksBuilder	percentiles(double... values) Set the values to compute percentiles from.

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

field, format, missing, script

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

PercentileRanksBuilder

public PercentileRanksBuilder(String name)

Sole constructor.

Method Detail

percentiles

public PercentileRanksBuilder percentiles(double... values)

Set the values to compute percentiles from.

doInternalXContent

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

Throws:

IOException

method

public PB method(PercentilesMethod method)

Expert: Set the method to use to compute the percentiles.

compression

public PB compression(double compression)

Expert: set the compression. Higher values improve accuracy but also memory usage. Only relevant when using PercentilesMethod.TDIGEST.

numberOfSignificantValueDigits

public PB numberOfSignificantValueDigits(int numberOfSignificantValueDigits)

Expert: set the number of significant digits in the values. Only relevant when using PercentilesMethod.HDR.

internalXContent

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

Overrides:

internalXContent in class ValuesSourceMetricsAggregationBuilder<PB extends org.elasticsearch.search.aggregations.metrics.percentiles.AbstractPercentilesBuilder<PB>>

Throws:

IOException