Package com.atlan.model.search

Class AggregationResult

java.lang.Object

com.atlan.model.core.AtlanObject

com.atlan.model.search.AggregationResult

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

AggregationBucketResult, AggregationHitsResult, AggregationMetricResult

public abstract class AggregationResult
extends AtlanObject

Base class for all aggregation results in a search.

See Also:

• Serialized Form

Nested Class Summary

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

Constructor Summary

Constructors

Constructor	Description
AggregationResult()

Method Summary

Modifier and Type	Method	Description
Double	getMetric()	Retrieve the numeric value from the provided aggregation result.
String	toString()

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

canEqual, equals, getRawJsonObject, hashCode, setRawJsonObject, toJson

Methods inherited from class java.lang.Object

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

Constructor Details

AggregationResult

public AggregationResult()

Method Details

getMetric

public Double getMetric()
                 throws InvalidRequestException

Retrieve the numeric value from the provided aggregation result.

Returns:

the numeric result for the aggregation

Throws:

InvalidRequestException - if the provided aggregation result is not a metric

toString

public String toString()

Description copied from class: AtlanObject

Overrides:

toString in class AtlanObject