Package org.elasticsearch.search.aggregations.metrics

Interface PercentileRanks

All Superinterfaces:

Aggregation, Iterable<Percentile>, NumericMetricsAggregation, NumericMetricsAggregation.MultiValue, org.elasticsearch.xcontent.ToXContent, org.elasticsearch.xcontent.ToXContentFragment

All Known Implementing Classes:

InternalHDRPercentileRanks, InternalTDigestPercentileRanks, ParsedHDRPercentileRanks, ParsedTDigestPercentileRanks

public interface PercentileRanks
extends NumericMetricsAggregation.MultiValue, 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.xcontent.ToXContent

org.elasticsearch.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.xcontent.ToXContent.MapParams, org.elasticsearch.xcontent.ToXContent.Params

Field Summary

Fields

Modifier and Type	Field	Description
static final String	TYPE_NAME

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

TYPED_KEYS_DELIMITER

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY_PARAMS

Method Summary

Modifier and Type	Method	Description
double	percent(double value)	Return the percentile for the given value.
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.search.aggregations.metrics.NumericMetricsAggregation.MultiValue

value, valueNames

Methods inherited from interface org.elasticsearch.xcontent.ToXContent

toXContent

Methods inherited from interface org.elasticsearch.xcontent.ToXContentFragment

isFragment

Field Details

TYPE_NAME

static final String TYPE_NAME

See Also:

• Constant Field Values

Method Details

percent

double percent(double value)

Return the percentile for the given value.

percentAsString

String percentAsString(double value)

Return the percentile for the given value as a String.