Package org.elasticsearch.search.aggregations.metrics

Interface PercentileRanks

All Superinterfaces:

Aggregation, java.lang.Iterable<Percentile>, NumericMetricsAggregation, NumericMetricsAggregation.MultiValue, ToXContent, ToXContentFragment

All Known Implementing Classes:

InternalHDRPercentileRanks, InternalTDigestPercentileRanks, ParsedHDRPercentileRanks, ParsedTDigestPercentileRanks

public interface PercentileRanks
extends NumericMetricsAggregation.MultiValue, java.lang.Iterable<Percentile>

An aggregation that computes approximate percentiles given values.

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.search.aggregations.Aggregation

Aggregation.CommonFields

Nested classes/interfaces inherited from interface org.elasticsearch.search.aggregations.metrics.NumericMetricsAggregation

NumericMetricsAggregation.MultiValue, NumericMetricsAggregation.SingleValue

Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	TYPE_NAME

Fields inherited from interface org.elasticsearch.search.aggregations.Aggregation

TYPED_KEYS_DELIMITER

Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent

EMPTY_PARAMS

Method Summary

Modifier and Type	Method	Description
double	percent(double value)	Return the percentile for the given value.
java.lang.String	percentAsString(double value)	Return the percentile for the given value as a String.

Methods inherited from interface org.elasticsearch.search.aggregations.Aggregation

getMetaData, getName, getType

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Methods inherited from interface org.elasticsearch.common.xcontent.ToXContent

toXContent

Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentFragment

isFragment

Field Details

TYPE_NAME

static final java.lang.String TYPE_NAME

See Also:

Constant Field Values

Method Details

percent

double percent(double value)

Return the percentile for the given value.

percentAsString

java.lang.String percentAsString(double value)

Return the percentile for the given value as a String.