Package org.opensearch.search.aggregations.metrics

Interface Cardinality

All Superinterfaces:
Aggregation, NumericMetricsAggregation, NumericMetricsAggregation.SingleValue, org.opensearch.common.xcontent.ToXContent, org.opensearch.common.xcontent.ToXContentFragment
All Known Implementing Classes:
InternalCardinality, ParsedCardinality
public interface Cardinality extends NumericMetricsAggregation.SingleValue
An aggregation that computes approximate numbers of unique terms.
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 interface org.opensearch.search.aggregations.Aggregation

    TYPED_KEYS_DELIMITER

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

    EMPTY_PARAMS

  • Method Summary

    Modifier and Type
    Method
    Description
    long
    getValue()
    The number of unique terms.

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

    getMetadata, getName, getType

    Methods inherited from interface org.opensearch.search.aggregations.metrics.NumericMetricsAggregation.SingleValue

    getValueAsString, value

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

    toXContent

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

    isFragment

  • Method Details

    • getValue

      long getValue()
      The number of unique terms.