Class AggregationResults (2.23.0)

Version 2.23.0

• 2.24.1 (latest)
• 2.23.0
• 2.22.0
• 2.21.3
• 2.20.2
• 2.19.2
• 2.18.5
• 2.17.6

public class AggregationResults implements Iterable<AggregationResult>

The result of an AggregationQuery query submission. Contains a List<AggregationResult> and readTime Timestamp in it.

This can be used to iterate over an underlying List<AggregationResult> directly.

Inheritance

Object > AggregationResults

Implements

Iterable<AggregationResult>

Inherited Members

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Constructors

AggregationResults(List<AggregationResult> aggregationResults, Timestamp readTime)

public AggregationResults(List<AggregationResult> aggregationResults, Timestamp readTime)

Parameters
Name	Description
aggregationResults	List<AggregationResult>
readTime	com.google.cloud.Timestamp

AggregationResults(List<AggregationResult> aggregationResults, Timestamp readTime, ExplainMetrics explainMetrics)

public AggregationResults(List<AggregationResult> aggregationResults, Timestamp readTime, ExplainMetrics explainMetrics)

Beta

This feature is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

Parameters
Name	Description
aggregationResults	List<AggregationResult>
readTime	com.google.cloud.Timestamp
explainMetrics	ExplainMetrics

Methods

equals(Object o)

public boolean equals(Object o)

Parameter
Name	Description
o	Object

Returns
Type	Description
boolean

Overrides

Object.equals(Object)

get(int index)

public AggregationResult get(int index)

Internal Only: This feature is not stable for application use.

Parameter
Name	Description
index	int

Returns
Type	Description
AggregationResult

getExplainMetrics()

public Optional<ExplainMetrics> getExplainMetrics()

Beta

This feature is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

Returns ExplainMetrics if ExplainOptions were enabled. Otherwise, returns null.

Returns
Type	Description
Optional<ExplainMetrics>

getReadTime()

public Timestamp getReadTime()

Returns read timestamp this result batch was returned from.

Returns
Type	Description
com.google.cloud.Timestamp

hashCode()

public int hashCode()

Returns
Type	Description
int

Overrides

Object.hashCode()

iterator()

public Iterator<AggregationResult> iterator()

Returns Iterator for underlying List<AggregationResult>.

Returns
Type	Description
Iterator<AggregationResult>

size()

public int size()

Returns
Type	Description
int