Terms

org.elasticsearch.search.aggregations.bucket.terms

Interface Terms

All Superinterfaces:

Aggregation, MultiBucketsAggregation

All Known Implementing Classes:

DoubleTerms, InternalTerms, LongTerms, 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 and Description
`static class`	`Terms.Bucket` A bucket that is associated with a single term
`static class`	`Terms.Order` Determines the order by which the term buckets will be sorted
`static class`	`Terms.ValueType`

Method Summary

All Methods

Instance Methods

Abstract Methods
Modifier and Type	Method and Description
`Terms.Bucket`	`getBucketByKey(String term)` Get the bucket for the given term, or null if there is no such bucket.
`List<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
getName

- Method Detail
  - getBuckets
```
List<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.
    
    Specified by:
    
    getBucketByKey in interface MultiBucketsAggregation
    
    Parameters:
    
    term - The key of the requested bucket.
    
    Returns:
    
    The 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.