Package org.opensearch.search.aggregations.bucket.terms

Class ParsedRareTerms

java.lang.Object

org.opensearch.search.aggregations.ParsedAggregation

org.opensearch.search.aggregations.ParsedMultiBucketAggregation<ParsedRareTerms.ParsedBucket>

org.opensearch.search.aggregations.bucket.terms.ParsedRareTerms

All Implemented Interfaces:

org.opensearch.common.xcontent.ToXContent, org.opensearch.common.xcontent.ToXContentFragment, Aggregation, MultiBucketsAggregation, RareTerms

Direct Known Subclasses:

ParsedLongRareTerms, ParsedStringRareTerms

public abstract class ParsedRareTerms
extends ParsedMultiBucketAggregation<ParsedRareTerms.ParsedBucket>
implements RareTerms

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ParsedRareTerms.ParsedBucket

Nested classes/interfaces inherited from interface org.opensearch.search.aggregations.Aggregation

Aggregation.CommonFields

Nested classes/interfaces inherited from interface org.opensearch.search.aggregations.bucket.MultiBucketsAggregation

MultiBucketsAggregation.Bucket

Nested classes/interfaces inherited from interface org.opensearch.search.aggregations.bucket.terms.RareTerms

RareTerms.Bucket

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

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

Field Summary

Fields inherited from class org.opensearch.search.aggregations.ParsedMultiBucketAggregation

buckets, keyed

Fields inherited from class org.opensearch.search.aggregations.ParsedAggregation

metadata

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

TYPED_KEYS_DELIMITER

Fields inherited from interface org.opensearch.common.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
ParsedRareTerms()

Method Summary

Modifier and Type	Method	Description
protected org.opensearch.common.xcontent.XContentBuilder	doXContentBody(org.opensearch.common.xcontent.XContentBuilder builder, org.opensearch.common.xcontent.ToXContent.Params params)
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 class org.opensearch.search.aggregations.ParsedMultiBucketAggregation

declareMultiBucketAggregationFields

Methods inherited from class org.opensearch.search.aggregations.ParsedAggregation

declareAggregationFields, getMetadata, getName, parseDouble, setName, toXContent

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.opensearch.search.aggregations.Aggregation

getMetadata, getName, getType

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

toXContent

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

isFragment

Constructor Details

ParsedRareTerms

public ParsedRareTerms()

Method Details

getBuckets

public java.util.List<? extends RareTerms.Bucket> getBuckets()

Description copied from interface: RareTerms

Return the sorted list of the buckets in this terms aggregation.

Specified by:

getBuckets in interface MultiBucketsAggregation

Specified by:

getBuckets in interface RareTerms

Returns:

The buckets of this aggregation.

getBucketByKey

public RareTerms.Bucket getBucketByKey(java.lang.String term)

Description copied from interface: RareTerms

Get the bucket for the given term, or null if there is no such bucket.

Specified by:

getBucketByKey in interface RareTerms

doXContentBody

protected org.opensearch.common.xcontent.XContentBuilder doXContentBody(org.opensearch.common.xcontent.XContentBuilder builder, org.opensearch.common.xcontent.ToXContent.Params params) throws java.io.IOException

Overrides:

doXContentBody in class ParsedMultiBucketAggregation<ParsedRareTerms.ParsedBucket>

Throws:

java.io.IOException