Package com.atlan.model.search

Class AggregationBucketResult

java.lang.Object

com.atlan.model.core.AtlanObject

com.atlan.model.search.AggregationResult

com.atlan.model.search.AggregationBucketResult

All Implemented Interfaces:

Serializable

public class AggregationBucketResult
extends AggregationResult

Captures the results from a bucket aggregation.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AggregationBucketResult.AggregationBucketResultBuilder

Nested classes/interfaces inherited from class com.atlan.model.core.AtlanObject

AtlanObject.AtlanObjectBuilder<C extends AtlanObject,B extends AtlanObject.AtlanObjectBuilder<C,B>>

Field Summary

Fields inherited from class com.atlan.model.core.AtlanObject

rawJsonObject

Method Summary

Modifier and Type	Method	Description
static AggregationBucketResult.AggregationBucketResultBuilder	builder()
protected boolean	canEqual(Object other)
boolean	equals(Object o)
List<AggregationBucketDetails>	getBuckets()	List of the top buckets that resulted from the aggregation.
Long	getDocCountErrorUpperBound()	Maximum number of missing documents when a bucket's count is very large and may exceed the shard size of Elasticsearch.
Long	getSumOtherDocCount()	When there are many unique terms, only the top terms are returned.
int	hashCode()
String	toString()

Methods inherited from class com.atlan.model.search.AggregationResult

getMetric

Methods inherited from class com.atlan.model.core.AtlanObject

getRawJsonObject, setRawJsonObject, toJson

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Details

builder

public static AggregationBucketResult.AggregationBucketResultBuilder builder()

getDocCountErrorUpperBound

public Long getDocCountErrorUpperBound()

Maximum number of missing documents when a bucket's count is very large and may exceed the shard size of Elasticsearch. The larger this number, the more approximate the values of the counts in the buckets.

getSumOtherDocCount

public Long getSumOtherDocCount()

When there are many unique terms, only the top terms are returned. This gives the sum of all document counts across all buckets that are NOT part of the response.

getBuckets

public List<AggregationBucketDetails> getBuckets()

List of the top buckets that resulted from the aggregation.

equals

public boolean equals(Object o)

Overrides:

equals in class AtlanObject

canEqual

protected boolean canEqual(Object other)

Overrides:

canEqual in class AtlanObject

hashCode

public int hashCode()

Overrides:

hashCode in class AtlanObject

toString

public String toString()

Description copied from class: AtlanObject

Overrides:

toString in class AggregationResult