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

Class ParsedStringRareTerms.ParsedBucket

java.lang.Object

org.opensearch.search.aggregations.ParsedMultiBucketAggregation.ParsedBucket

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

org.opensearch.search.aggregations.bucket.terms.ParsedStringRareTerms.ParsedBucket

All Implemented Interfaces:

org.opensearch.common.xcontent.ToXContent, MultiBucketsAggregation.Bucket, RareTerms.Bucket, HasAggregations

Enclosing class:

ParsedStringRareTerms

public static class ParsedStringRareTerms.ParsedBucket
extends ParsedRareTerms.ParsedBucket

Nested Class Summary

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 interface org.opensearch.common.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
ParsedBucket()

Method Summary

Modifier and Type	Method	Description
java.lang.Object	getKey()
java.lang.Number	getKeyAsNumber()
java.lang.String	getKeyAsString()
protected org.opensearch.common.xcontent.XContentBuilder	keyToXContent(org.opensearch.common.xcontent.XContentBuilder builder)

Methods inherited from class org.opensearch.search.aggregations.bucket.terms.ParsedRareTerms.ParsedBucket

toXContent

Methods inherited from class org.opensearch.search.aggregations.ParsedMultiBucketAggregation.ParsedBucket

getAggregations, getDocCount, isKeyed, parseXContent, setAggregations, setDocCount, setKeyAsString, setKeyed

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.bucket.MultiBucketsAggregation.Bucket

getAggregations, getDocCount

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

isFragment

Constructor Details

ParsedBucket

public ParsedBucket()

Method Details

getKey

public java.lang.Object getKey()

Returns:

The key associated with the bucket

getKeyAsString

public java.lang.String getKeyAsString()

Specified by:

getKeyAsString in interface MultiBucketsAggregation.Bucket

Overrides:

getKeyAsString in class ParsedMultiBucketAggregation.ParsedBucket

Returns:

The key associated with the bucket as a string

getKeyAsNumber

public java.lang.Number getKeyAsNumber()

keyToXContent

protected org.opensearch.common.xcontent.XContentBuilder keyToXContent(org.opensearch.common.xcontent.XContentBuilder builder) throws java.io.IOException

Overrides:

keyToXContent in class ParsedMultiBucketAggregation.ParsedBucket

Throws:

java.io.IOException