com.arakelian.elastic.model.aggs.metrics

Interface PercentileRanksAggregation

All Superinterfaces:

Aggregation, MetricAggregation, java.io.Serializable, ValuesSourceAggregation

@Value.Immutable(copy=false)
public interface PercentileRanksAggregation
extends MetricAggregation, ValuesSourceAggregation

See Also:

Percentile Rank Aggregation, PercentileRanksAggregationBuilder.java

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	PercentileRanksAggregation.Method

Field Summary

Fields inherited from interface com.arakelian.elastic.model.aggs.Aggregation

ADJACENCY_MATRIX_AGGREGATION, AVG_AGGREGATION, CARDINALITY_AGGREGATION, DATE_HISTOGRAM_AGGREGATION, DATE_RANGE_AGGREGATION, EXTENDED_STATS_AGGREGATION, FILTER_AGGREGATION, FILTERS_AGGREGATION, GEO_BOUNDS_AGGREGATION, GEO_CENTROID_AGGREGATION, GEO_DISTANCE_AGGREGATION, GEOHASH_GRID_AGGREGATION, GLOBAL_AGGREGATION, HISTOGRAM_AGGREGATION, IP_RANGE_AGGREGATION, MAX_AGGREGATION, MIN_AGGREGATION, MISSING_AGGREGATION, NESTED_AGGREGATION, PERCENTILE_RANKS_AGGREGATION, PERCENTILES_AGGREGATION, RANGE_AGGREGATION, REVERSE_NESTED_AGGREGATION, SAMPLER_AGGREGATION, SIGNIFICANT_TERMS_AGGREGATION, SIGNIFICANT_TEXT_AGGREGATION, STATS_AGGREGATION, SUM_AGGREGATION, TERMS_AGGREGATION, VALUE_COUNT_AGGREGATION

Method Summary

Modifier and Type	Method and Description
default void	accept(AggregationVisitor visitor)
default void	checkMethod()
java.lang.Double	getCompression() Returns the compression.
default PercentileRanksAggregation.Method	getMethod()
java.lang.Integer	getNumberOfSignificantValueDigits() Returns the number of significant digits in the values.
java.util.List<java.lang.Double>	getValues()
java.lang.Boolean	isKeyed()

Methods inherited from interface com.arakelian.elastic.model.aggs.Aggregation

countNotEmpty, getName, getSubAggregations, isEmpty

Methods inherited from interface com.arakelian.elastic.model.aggs.ValuesSourceAggregation

getField, getFormat, getMissing, getTimeZone

Method Detail

checkMethod

@Value.Check
default void checkMethod()

getCompression

java.lang.Double getCompression()

Returns the compression. Higher values improve accuracy but also memory usage. Only relevant when using PercentileRanksAggregation.Method.TDIGEST.

Returns:

the compression

See Also:

Compression

getMethod

@Value.Derived
default PercentileRanksAggregation.Method getMethod()

getNumberOfSignificantValueDigits

java.lang.Integer getNumberOfSignificantValueDigits()

Returns the number of significant digits in the values. Only relevant when using PercentileRanksAggregation.Method.HDR.

Returns:

the number of significant digits in the values

getValues

java.util.List<java.lang.Double> getValues()

isKeyed

java.lang.Boolean isKeyed()

accept

default void accept(AggregationVisitor visitor)

Specified by:

accept in interface Aggregation