com.google.cloud.firestore

Class AggregateQuerySnapshot

java.lang.Object

com.google.cloud.firestore.AggregateQuerySnapshot

@InternalExtensionOnly
public class AggregateQuerySnapshot
extends Object

The results of executing an AggregateQuery.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object object) Compares this object with the given object for equality.
long	getCount() Returns the number of documents in the result set of the underlying query.
AggregateQuery	getQuery() Returns the query that was executed to produce this result.
com.google.cloud.Timestamp	getReadTime() Returns the time at which this snapshot was read.
int	hashCode() Calculates and returns the hash code for this object.

Methods inherited from class java.lang.Object

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

Method Detail

getQuery

@Nonnull
public AggregateQuery getQuery()

Returns the query that was executed to produce this result.

getReadTime

@Nonnull
public com.google.cloud.Timestamp getReadTime()

Returns the time at which this snapshot was read.

getCount

public long getCount()

Returns the number of documents in the result set of the underlying query.

equals

public boolean equals(Object object)

Compares this object with the given object for equality.

This object is considered "equal" to the other object if and only if all of the following conditions are satisfied:

1. object is a non-null instance of AggregateQuerySnapshot.
2. The AggregateQuery of object compares equal to that of this object.
3. object has the same results as this object.

Overrides:

equals in class Object

Parameters:

object - The object to compare to this object for equality.

Returns:

true if this object is "equal" to the given object, as defined above, or false otherwise.

hashCode

public int hashCode()

Calculates and returns the hash code for this object.

Overrides:

hashCode in class Object

Returns:

the hash code for this object.