Aggregation
, MultiBucketsAggregation
, ToXContent
, ToXContentFragment
DoubleTerms
, InternalMappedTerms
, InternalTerms
, LongTerms
, ParsedDoubleTerms
, ParsedLongTerms
, ParsedStringTerms
, ParsedTerms
, StringTerms
, UnmappedTerms
public interface Terms extends MultiBucketsAggregation
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.Modifier and Type | Interface | Description |
---|---|---|
static interface |
Terms.Bucket |
A bucket that is associated with a single term
|
Aggregation.CommonFields
ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params
TYPED_KEYS_DELIMITER
EMPTY_PARAMS
Modifier and Type | Method | Description |
---|---|---|
Terms.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 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.
|
getMetaData, getName, getType
toXContent
isFragment
java.util.List<? extends Terms.Bucket> getBuckets()
getBuckets
in interface MultiBucketsAggregation
Terms.Bucket getBucketByKey(java.lang.String term)
long getDocCountError()
long getSumOfOtherDocCounts()