Package com.google.cloud.firestore

Interface Summary

Interface	Description
BulkWriter.WriteErrorCallback	A callback set by `addWriteErrorListener()` to be run every time an operation fails and determines if an operation should be retried.
BulkWriter.WriteResultCallback	A callback set by `addWriteResultListener()` to be run every time an operation successfully completes.
EventListener<T>	An interface for event listeners.
Firestore	Represents a Firestore Database and is the entry point for all Firestore operations
FirestoreFactory	An interface for Firestore factories.
FirestoreRpcFactory	An interface for Firestore RPC factory.
ListenerRegistration	Represents a listener that can be removed by calling remove().
Transaction.AsyncFunction<T>	User callback that takes a Firestore Async Transaction.
Transaction.Function<T>	User callback that takes a Firestore Transaction.

Class Summary

Class	Description
AggregateQuery	A query that calculates aggregations over an underlying query.
AggregateQuerySnapshot	The results of executing an AggregateQuery.
BasePath<B extends BasePath<B>>	BasePath represents a path sequence in the Firestore database.
Blob	Immutable class representing an array of bytes in Firestore.
BulkWriter	A Firestore BulkWriter that can be used to perform a large number of writes in parallel.
BulkWriterOptions	Options used to configure request throttling in BulkWriter.
BulkWriterOptions.Builder
CollectionGroup	A Collection Group query matches all documents that are contained in a collection or subcollection with a specific collection ID.
CollectionReference	A CollectionReference can be used for adding documents, getting document references, and querying for documents (using the methods inherited from Query).
DocumentChange	A DocumentChange represents a change to the documents matching a query.
DocumentReference	A DocumentReference refers to a document location in a Firestore database and can be used to write, read, or listen to the location.
DocumentSnapshot	A DocumentSnapshot contains data read from a document in a Firestore database.
FieldMask	A FieldMask can be used to limit the number of fields returned by a `getAll()` call.
FieldPath	A FieldPath refers to a field in a document.
FieldValue	Sentinel values that can be used when writing document fields with set() or update().
Filter
FirestoreBundle	Represents a Firestore data bundle with results from the given document and query snapshots.
FirestoreBundle.Builder	Builds a Firestore data bundle with results from the given document and query snapshots.
FirestoreOptions	A Factory class to create new Firestore instances.
FirestoreOptions.Builder
FirestoreOptions.DefaultFirestoreFactory
FirestoreOptions.DefaultFirestoreRpcFactory
FirestoreOptions.EmulatorCredentials
GeoPoint	Immutable class representing a geographic location in Firestore
Internal
Precondition	Preconditions that can be used to restrict update() calls.
Query	A Query which you can read or listen to.
QueryDocumentSnapshot	A QueryDocumentSnapshot contains data read from a document in a Firestore database as part of a query.
QueryPartition	A split point that can be used in a query as a starting and/or end point for the query results.
QuerySnapshot	A QuerySnapshot contains the results of a query.
RecursiveDelete	Class used to store state required for running a recursive delete operation.
SetOptions	An options object that configures the behavior of set() calls.
Transaction	A Transaction is passed to a Function to provide the methods to read and write data within the transaction context.
TransactionOptions	Options specifying the behavior of Firestore Transactions.
TransactionOptions.Builder<B extends TransactionOptions.Builder<B>>
TransactionOptions.ReadOnlyOptionsBuilder	A typesafe builder class representing those options that are applicable when configuring a transaction to be read-only.
TransactionOptions.ReadWriteOptionsBuilder	A typesafe builder class representing those options that are applicable when configuring a transaction to be read-write.
UpdateBuilder<T>	Abstract class that collects and bundles all write operations for Transaction and WriteBatch.
WriteBatch	A Firestore WriteBatch that can be used to atomically commit multiple write operations at once.
WriteResult	A WriteResult exposes the update time set by the server.

Enum Summary

Enum	Description
DocumentChange.Type	An enumeration of snapshot diff types.
Query.Direction	The direction of a sort.
TransactionOptions.TransactionOptionsType

Exception Summary

Exception	Description
BulkWriterException	The error thrown when a BulkWriter operation fails.
FirestoreException	A Firestore Service exception.