All Classes and Interfaces

Class
Description
Represents an aggregation that can be performed by Firestore.
Represents an "average" aggregation that can be performed by Firestore.
Represents a "count" aggregation that can be performed by Firestore.
Represents a "sum" aggregation that can be performed by Firestore.
A query that calculates aggregations over an underlying query.
The results of executing an AggregateQuery.
This is an array backed implementation of ImmutableSortedMap.
BasePath<B extends BasePath<B>>
BasePath represents a path sequence in the Firestore database.
Immutable class representing an array of bytes in Firestore.
A Firestore BulkWriter that can be used to perform a large number of writes in parallel.
A callback set by `addWriteErrorListener()` to be run every time an operation fails and determines if an operation should be retried.
A callback set by `addWriteResultListener()` to be run every time an operation successfully completes.
The error thrown when a BulkWriter operation fails.
Options used to configure request throttling in BulkWriter.
 
A Collection Group query matches all documents that are contained in a collection or subcollection with a specific collection ID.
A CollectionReference can be used for adding documents, getting document references, and querying for documents (using the methods inherited from Query).
A DocumentChange represents a change to the documents matching a query.
An enumeration of snapshot diff types.
Annotation used to mark a POJO property to be automatically populated with the document's ID when the POJO is created from a Cloud Firestore document (for example, via DocumentSnapshot.toObject(java.lang.Class<T>)).
A DocumentReference refers to a document location in a Firestore database and can be used to write, read, or listen to the location.
A DocumentSnapshot contains data read from a document in a Firestore database.
An interface for event listeners.
Marks a field as excluded from the Database.
A FieldMask can be used to limit the number of fields returned by a `getAll()` call.
A FieldPath refers to a field in a document.
Sentinel values that can be used when writing document fields with set() or update().
 
Represents a Firestore Database and is the entry point for all Firestore operations
Represents a Firestore data bundle with results from the given document and query snapshots.
Builds a Firestore data bundle with results from the given document and query snapshots.
Service Description: The Cloud Firestore service.
 
 
 
 
 
 
 
 
 
A Firestore Service exception.
An interface for Firestore factories.
A Factory class to create new Firestore instances.
 
 
 
 
Contains the RPC stubs used by the manual Cloud Firestore client.
An interface for Firestore RPC factory.
Settings class to configure an instance of FirestoreClient.
Builder for FirestoreSettings.
Base stub class for the Firestore service API.
Settings class to configure an instance of FirestoreStub.
Builder for FirestoreStubSettings.
Immutable class representing a geographic location in Firestore
gRPC callable factory implementation for the Firestore service API.
GRPC client implementation of the Firestore RPC methods.
gRPC stub implementation for the Firestore service API.
REST callable factory implementation for the Firestore service API.
REST stub implementation for the Firestore service API.
Properties that don't map to class fields are ignored when serializing to a class annotated with this annotation.
 
 
 
 
 
 
Represents a listener that can be removed by calling remove().
 
 
 
 
 
 
 
 
Preconditions that can be used to restrict update() calls.
Marks a field to be renamed when serialized.
A Query which you can read or listen to.
The direction of a sort.
A QueryDocumentSnapshot contains data read from a document in a Firestore database as part of a query.
A split point that can be used in a query as a starting and/or end point for the query results.
A QuerySnapshot contains the results of a query.
This is a red-black tree backed implementation of ImmutableSortedMap.
Class used to store state required for running a recursive delete operation.
Annotation used to mark a timestamp field as being populated via Server Timestamps.
An options object that configures the behavior of set() calls.
Properties that don't map to class fields when serializing to a class annotated with this annotation cause an exception to be thrown.
A Transaction is passed to a Function to provide the methods to read and write data within the transaction context.
User callback that takes a Firestore Async Transaction.
User callback that takes a Firestore Transaction.
Options specifying the behavior of Firestore Transactions.
 
A typesafe builder class representing those options that are applicable when configuring a transaction to be read-only.
A typesafe builder class representing those options that are applicable when configuring a transaction to be read-write.
 
Abstract class that collects and bundles all write operations for Transaction and WriteBatch.
A Firestore WriteBatch that can be used to atomically commit multiple write operations at once.
A WriteResult exposes the update time set by the server.