Package org.opensearch.search.aggregations.bucket.terms

Interface RareTerms

All Superinterfaces:
Aggregation, MultiBucketsAggregation, org.opensearch.common.xcontent.ToXContent, org.opensearch.common.xcontent.ToXContentFragment
All Known Implementing Classes:
InternalMappedRareTerms, InternalRareTerms, LongRareTerms, ParsedLongRareTerms, ParsedRareTerms, ParsedStringRareTerms, StringRareTerms, UnmappedRareTerms
public interface RareTerms
extends MultiBucketsAggregation

  • Nested Class Summary

    Nested Classes 
    Modifier and Type Interface Description
    static interface  RareTerms.Bucket
    A bucket that is associated with a single term

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

    Aggregation.CommonFields

    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
    RareTerms.Bucket getBucketByKey​(java.lang.String term)
    Get the bucket for the given term, or null if there is no such bucket.
    java.util.List<? extends RareTerms.Bucket> getBuckets()
    Return the sorted list of the buckets in this terms aggregation.

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

    getMetadata, getName, getType

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

    toXContent

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

    isFragment