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

Interface Terms

All Superinterfaces:
Aggregation, MultiBucketsAggregation, org.elasticsearch.common.xcontent.ToXContent, org.elasticsearch.common.xcontent.ToXContentFragment
All Known Implementing Classes:
DoubleTerms, InternalMappedTerms, InternalTerms, LongTerms, ParsedDoubleTerms, ParsedLongTerms, ParsedStringTerms, ParsedTerms, StringTerms, UnmappedTerms
public interface Terms extends MultiBucketsAggregation
A terms aggregation. Defines multiple bucket, each associated with a unique term for a specific field. All documents in a bucket has the bucket's term in that field.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static interface 
    Terms.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
    Terms.Bucket
    getBucketByKey(String term)
    Get the bucket for the given term, or null if there is no such bucket.
    List<? extends Terms.Bucket>
    getBuckets()
    Return the sorted list of the buckets in this terms aggregation.
    long
    getDocCountError()
    Get an upper bound of the error on document counts in this aggregation.
    long
    getSumOfOtherDocCounts()
    Return the sum of the document counts of all buckets that did not make it to the top buckets.

    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

      List<? extends Terms.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

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

    • getDocCountError

      long getDocCountError()
      Get an upper bound of the error on document counts in this aggregation.

    • getSumOfOtherDocCounts

      long getSumOfOtherDocCounts()
      Return the sum of the document counts of all buckets that did not make it to the top buckets.