Interface SignificantTerms
- All Superinterfaces:
Aggregation,java.lang.Iterable<SignificantTerms.Bucket>,MultiBucketsAggregation,org.elasticsearch.common.xcontent.ToXContent,org.elasticsearch.common.xcontent.ToXContentFragment
- All Known Implementing Classes:
InternalMappedSignificantTerms,InternalSignificantTerms,ParsedSignificantLongTerms,ParsedSignificantStringTerms,ParsedSignificantTerms,SignificantLongTerms,SignificantStringTerms,UnmappedSignificantTerms
public interface SignificantTerms extends MultiBucketsAggregation, java.lang.Iterable<SignificantTerms.Bucket>
An aggregation that collects significant terms in comparison to a background set.
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static interfaceSignificantTerms.BucketNested classes/interfaces inherited from interface org.elasticsearch.search.aggregations.Aggregation
Aggregation.CommonFieldsNested 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_DELIMITERFields inherited from interface org.elasticsearch.common.xcontent.ToXContent
EMPTY_PARAMS -
Method Summary
Modifier and Type Method Description SignificantTerms.BucketgetBucketByKey(java.lang.String term)Get the bucket for the given term, or null if there is no such bucket.java.util.List<? extends SignificantTerms.Bucket>getBuckets()Methods inherited from interface org.elasticsearch.search.aggregations.Aggregation
getMetadata, getName, getTypeMethods inherited from interface java.lang.Iterable
forEach, iterator, spliteratorMethods inherited from interface org.elasticsearch.common.xcontent.ToXContent
toXContentMethods inherited from interface org.elasticsearch.common.xcontent.ToXContentFragment
isFragment
-
Method Details
-
getBuckets
java.util.List<? extends SignificantTerms.Bucket> getBuckets()- Specified by:
getBucketsin interfaceMultiBucketsAggregation- Returns:
- The buckets of this aggregation.
-
getBucketByKey
Get the bucket for the given term, or null if there is no such bucket.
-