Package org.elasticsearch.search.aggregations.bucket.terms

Interface RareTerms

All Superinterfaces:
Aggregation, MultiBucketsAggregation, org.elasticsearch.common.xcontent.ToXContent, org.elasticsearch.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.elasticsearch.search.aggregations.Aggregation

    Aggregation.CommonFields

    Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent

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

  • Field Summary

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

    TYPED_KEYS_DELIMITER

    Fields inherited from interface org.elasticsearch.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.elasticsearch.search.aggregations.Aggregation

    getMetadata, getName, getType

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

    toXContent

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

    isFragment

  • Method Details

    • getBuckets

      java.util.List<? extends RareTerms.Bucket> getBuckets()
      Return the sorted list of the buckets in this terms aggregation.
      Specified by:
      getBuckets in interface MultiBucketsAggregation
      Returns:
      The buckets of this aggregation.

    • getBucketByKey

      RareTerms.Bucket getBucketByKey​(java.lang.String term)
      Get the bucket for the given term, or null if there is no such bucket.