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

Class ParsedSignificantStringTerms.ParsedBucket

java.lang.Object

org.opensearch.search.aggregations.ParsedMultiBucketAggregation.ParsedBucket

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

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

All Implemented Interfaces:

org.opensearch.core.xcontent.ToXContent, MultiBucketsAggregation.Bucket, SignificantTerms.Bucket, HasAggregations

Enclosing class:

ParsedSignificantStringTerms

public static class ParsedSignificantStringTerms.ParsedBucket
extends ParsedSignificantTerms.ParsedBucket

Parsed bucket for significant string values

Opensearch.internal:

Nested Class Summary

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

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

Field Summary

Fields inherited from class org.opensearch.search.aggregations.bucket.terms.ParsedSignificantTerms.ParsedBucket

score, subsetDf, subsetSize, supersetDf, supersetSize

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

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
ParsedBucket()

Method Summary

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

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

getDocCount, getSignificanceScore, getSubsetDf, getSubsetSize, getSupersetDf, getSupersetSize, toXContent

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

getAggregations, 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

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

isFragment

Constructor Details

ParsedBucket

public ParsedBucket()

Method Details

getKey

public Object getKey()

Returns:

The key associated with the bucket

getKeyAsString

public 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 Number getKeyAsNumber()

Returns:

The key, expressed as a number

keyToXContent

protected org.opensearch.core.xcontent.XContentBuilder keyToXContent(org.opensearch.core.xcontent.XContentBuilder builder)
                                                              throws IOException

Specified by:

keyToXContent in class ParsedSignificantTerms.ParsedBucket

Throws:

IOException