Package org.opensearch.search.aggregations.metrics

Class ParsedTDigestPercentileRanks

java.lang.Object

org.opensearch.search.aggregations.ParsedAggregation

org.opensearch.search.aggregations.metrics.ParsedPercentiles

org.opensearch.search.aggregations.metrics.ParsedTDigestPercentileRanks

All Implemented Interfaces:

Iterable<Percentile>, org.opensearch.common.xcontent.ToXContent, org.opensearch.common.xcontent.ToXContentFragment, Aggregation, NumericMetricsAggregation, NumericMetricsAggregation.MultiValue, PercentileRanks

public class ParsedTDigestPercentileRanks
extends ParsedPercentiles

A TDigest percentiles rank agg result parsed between nodes

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.common.xcontent.ToXContent

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

Field Summary

Fields inherited from class org.opensearch.search.aggregations.metrics.ParsedPercentiles

percentiles, percentilesAsString

Fields inherited from class org.opensearch.search.aggregations.ParsedAggregation

metadata

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

TYPED_KEYS_DELIMITER

Fields inherited from interface org.opensearch.search.aggregations.metrics.PercentileRanks

TYPE_NAME

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

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
ParsedTDigestPercentileRanks()

Method Summary

Modifier and Type	Method	Description
static ParsedTDigestPercentileRanks	fromXContent(org.opensearch.common.xcontent.XContentParser parser, String name)
String	getType()
Iterator<Percentile>	iterator()
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 class org.opensearch.search.aggregations.metrics.ParsedPercentiles

declarePercentilesFields, doXContentBody, getPercentile, getPercentileAsString

Methods inherited from class org.opensearch.search.aggregations.ParsedAggregation

declareAggregationFields, getMetadata, getName, parseDouble, setName, toXContent

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

getMetadata, getName

Methods inherited from interface java.lang.Iterable

forEach, spliterator

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

toXContent

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

isFragment

Constructor Details

ParsedTDigestPercentileRanks

public ParsedTDigestPercentileRanks()

Method Details

getType

public String getType()

Returns:

a string representing the type of the aggregation. This type is added to the aggregation name in the response, so that it can later be used by clients to determine type of the aggregation and parse it into the proper object.

iterator

public Iterator<Percentile> iterator()

Specified by:

iterator in interface Iterable<Percentile>

Overrides:

iterator in class ParsedPercentiles

fromXContent

public static ParsedTDigestPercentileRanks fromXContent(org.opensearch.common.xcontent.XContentParser parser,
 String name)
                                                 throws IOException

Throws:

IOException

percent

public double percent(double value)

Description copied from interface: PercentileRanks

Return the percentile for the given value.

Specified by:

percent in interface PercentileRanks

percentAsString

public String percentAsString(double value)

Description copied from interface: PercentileRanks

Return the percentile for the given value as a String.

Specified by:

percentAsString in interface PercentileRanks