Package org.opensearch.search.aggregations.metrics

Interface Percentiles

All Superinterfaces:
Aggregation, Iterable<Percentile>, NumericMetricsAggregation, NumericMetricsAggregation.MultiValue, org.opensearch.core.xcontent.ToXContent, org.opensearch.core.xcontent.ToXContentFragment
All Known Subinterfaces:
PercentilesBucket
All Known Implementing Classes:
InternalHDRPercentiles, InternalPercentilesBucket, InternalTDigestPercentiles, ParsedHDRPercentiles, ParsedPercentilesBucket, ParsedTDigestPercentiles
public interface Percentiles extends NumericMetricsAggregation.MultiValue, Iterable<Percentile>
An aggregation that computes approximate percentiles.
Opensearch.internal:

  • Nested Class Summary

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

    Aggregation.CommonFields

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

    NumericMetricsAggregation.MultiValue, NumericMetricsAggregation.SingleValue

    Nested classes/interfaces inherited from interface org.opensearch.core.xcontent.ToXContent

    org.opensearch.core.xcontent.ToXContent.DelegatingMapParams, org.opensearch.core.xcontent.ToXContent.MapParams, org.opensearch.core.xcontent.ToXContent.Params

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    TYPE_NAME
     

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

    TYPED_KEYS_DELIMITER

    Fields inherited from interface org.opensearch.core.xcontent.ToXContent

    EMPTY_PARAMS

  • Method Summary

    Modifier and Type
    Method
    Description
    double
    percentile(double percent)
    Return the value associated with the provided percentile.
    String
    percentileAsString(double percent)
    Return the value associated with the provided percentile as a String.

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

    getMetadata, getName, getType

    Methods inherited from interface java.lang.Iterable

    forEach, iterator, spliterator

    Methods inherited from interface org.opensearch.core.xcontent.ToXContent

    toXContent

    Methods inherited from interface org.opensearch.core.xcontent.ToXContentFragment

    isFragment

  • Field Details

  • Method Details

    • percentile

      double percentile(double percent)
      Return the value associated with the provided percentile.

    • percentileAsString

      String percentileAsString(double percent)
      Return the value associated with the provided percentile as a String.