|
Class |
Description |
| com.google.cloud.firestore.AggregateField |
Represents an aggregation that can be performed by Firestore. |
| com.google.cloud.firestore.AggregateField.AverageAggregateField |
Represents an "average" aggregation that can be performed by Firestore. |
| com.google.cloud.firestore.AggregateField.CountAggregateField |
Represents a "count" aggregation that can be performed by Firestore. |
| com.google.cloud.firestore.AggregateField.SumAggregateField |
Represents a "sum" aggregation that can be performed by Firestore. |
| com.google.cloud.firestore.AggregateQuery |
A query that calculates aggregations over an underlying query. |
| com.google.cloud.firestore.AggregateQuerySnapshot |
The results of executing an AggregateQuery. |
| com.google.cloud.firestore.BasePath |
BasePath represents a path sequence in the Firestore database. It is composed of an ordered
sequence of string segments. |
| com.google.cloud.firestore.Blob |
Immutable class representing an array of bytes in Firestore. |
| com.google.cloud.firestore.BulkWriter |
A Firestore BulkWriter that can be used to perform a large number of writes in parallel. |
| com.google.cloud.firestore.BulkWriterOptions |
Options used to configure request throttling in BulkWriter. |
| com.google.cloud.firestore.BulkWriterOptions.Builder |
|
| com.google.cloud.firestore.CollectionGroup |
A Collection Group query matches all documents that are contained in a collection or
subcollection with a specific collection ID. |
| com.google.cloud.firestore.CollectionReference |
A CollectionReference can be used for adding documents, getting document references, and querying
for documents (using the methods inherited from Query).
Subclassing Note: Firestore classes are not meant to be subclassed except for use in |
| com.google.cloud.firestore.DocumentChange |
A DocumentChange represents a change to the documents matching a query. It contains the document
affected and a the type of change that occurred (added, modifed, or removed). |
| com.google.cloud.firestore.DocumentReference |
A DocumentReference refers to a document location in a Firestore database and can be used to
write, read, or listen to the location. There may or may not exist a document at the referenced
location. A DocumentReference can also be used to create a CollectionReference to a
subcollection. |
| com.google.cloud.firestore.DocumentSnapshot |
A DocumentSnapshot contains data read from a document in a Firestore database. The data can be
extracted with the #getData() or #get(String) methods.
If the DocumentSnapshot points to a non-existing document, getData() and its corresponding |
| com.google.cloud.firestore.ExecutionStats |
A ExecutionStats contains information about the execution of a query. |
| com.google.cloud.firestore.ExplainMetrics |
ExplainMetrics contains information about planning and execution of a query. |
| com.google.cloud.firestore.ExplainOptions |
Options used to configure explain queries. |
| com.google.cloud.firestore.ExplainOptions.Builder |
|
| com.google.cloud.firestore.ExplainResults |
ExplainResults contains information about planning, execution, and results of a query. |
| com.google.cloud.firestore.FieldMask |
A FieldMask can be used to limit the number of fields returned by a getAll() call. |
| com.google.cloud.firestore.FieldPath |
A FieldPath refers to a field in a document. The path may consist of a single field name
(referring to a top level field in the document), or a list of field names (referring to a nested
field in the document). |
| com.google.cloud.firestore.FieldValue |
Sentinel values that can be used when writing document fields with set() or update(). |
| com.google.cloud.firestore.Filter |
|
| com.google.cloud.firestore.FirestoreBundle |
Represents a Firestore data bundle with results from the given document and query snapshots. |
| com.google.cloud.firestore.FirestoreBundle.Builder |
Builds a Firestore data bundle with results from the given document and query snapshots. |
| com.google.cloud.firestore.FirestoreOpenTelemetryOptions |
Represents the options that are used to configure the use of OpenTelemetry for telemetry
collection in the Firestore SDK. |
| com.google.cloud.firestore.FirestoreOpenTelemetryOptions.Builder |
|
| com.google.cloud.firestore.FirestoreOptions |
A Factory class to create new Firestore instances. |
| com.google.cloud.firestore.FirestoreOptions.Builder |
|
| com.google.cloud.firestore.FirestoreOptions.DefaultFirestoreFactory |
|
| com.google.cloud.firestore.FirestoreOptions.DefaultFirestoreRpcFactory |
|
| com.google.cloud.firestore.FirestoreOptions.EmulatorCredentials |
|
| com.google.cloud.firestore.GenericQuerySnapshot |
Abstract. A GenericQuerySnapshot represents the results of a query that returns documents. It can
contain zero or more DocumentSnapshot objects. |
| com.google.cloud.firestore.GeoPoint |
Immutable class representing a geographic location in Firestore |
| com.google.cloud.firestore.Internal |
|
| com.google.cloud.firestore.PlanSummary |
A Plan contains information about the planning stage of a query. |
| com.google.cloud.firestore.Precondition |
Preconditions that can be used to restrict update() calls. |
| com.google.cloud.firestore.Query |
A Query which you can read or listen to. You can also construct refined Query objects by adding
filters and ordering. |
| com.google.cloud.firestore.QueryDocumentSnapshot |
A QueryDocumentSnapshot contains data read from a document in a Firestore database as part of a
query. The document is guaranteed to exist and its data can be extracted using the #getData() or #get(String) methods.
QueryDocumentSnapshot offers the same API surface as DocumentSnapshot. Since query |
| com.google.cloud.firestore.QueryPartition |
A split point that can be used in a query as a starting and/or end point for the query results.
The cursors returned by #getStartAt() and #getEndBefore() can only be used in a
query that matches the constraint of query that produced this partition. |
| com.google.cloud.firestore.QuerySnapshot |
A QuerySnapshot contains the results of a query. It can contain zero or more DocumentSnapshot
objects. |
| com.google.cloud.firestore.RecursiveDelete |
Class used to store state required for running a recursive delete operation. Each recursive
delete call should use a new instance of the class. |
| com.google.cloud.firestore.SetOptions |
An options object that configures the behavior of set() calls. By providing one of the SetOptions
objects returned by #merge, #mergeFields and #mergeFieldPaths, the set()
calls in DocumentReference, WriteBatch and Transaction can be configured
to perform granular merges instead of overwriting the target documents in their entirety. |
| com.google.cloud.firestore.StreamableQuery |
Represents a query whose results can be streamed. If the stream fails with a retryable error,
implementations of StreamableQuery can optionally support retries with a cursor, as indicated by
isRetryableWithCursor. Retrying with a cursor means that the StreamableQuery can be resumed
where it failed by first calling startAfter(lastDocumentReceived). |
| com.google.cloud.firestore.Transaction |
A Transaction is passed to a Function to provide the methods to read and write data within the
transaction context.
See Also: Firestore#runTransaction(Function)
|
| com.google.cloud.firestore.TransactionOptions |
Options specifying the behavior of Firestore Transactions.
A transaction in Firestore can be either read-write or read-only.
|
| com.google.cloud.firestore.TransactionOptions.Builder |
|
| com.google.cloud.firestore.TransactionOptions.ReadOnlyOptionsBuilder |
A typesafe builder class representing those options that are applicable when configuring a
transaction to be read-only. All methods function as "set" rather than returning a new copy
with a value set on it. |
| com.google.cloud.firestore.TransactionOptions.ReadWriteOptionsBuilder |
A typesafe builder class representing those options that are applicable when configuring a
transaction to be read-write. All methods function as "set" rather than returning a new copy
with a value set on it. By default, a read-write transaction will be attempted a max of 5
times. |
| com.google.cloud.firestore.UpdateBuilder |
Abstract class that collects and bundles all write operations for Transaction and WriteBatch. |
| com.google.cloud.firestore.VectorQuery |
A query that finds the documents whose vector fields are closest to a certain query vector.
Create an instance of VectorQuery with Query#findNearest. |
| com.google.cloud.firestore.VectorQueryOptions |
Specifies the behavior of the VectorQuery generated by a call to Query#findNearest. |
| com.google.cloud.firestore.VectorQueryOptions.Builder |
|
| com.google.cloud.firestore.VectorQuerySnapshot |
A VectorQuerySnapshot contains the results of a VectorQuery. It can contain zero or more
DocumentSnapshot objects. |
| com.google.cloud.firestore.VectorValue |
Represents a vector in Firestore documents. Create an instance with FieldValue#vector. |
| com.google.cloud.firestore.WriteBatch |
A Firestore WriteBatch that can be used to atomically commit multiple write operations at once.
See Also: Firestore#batch()
|
| com.google.cloud.firestore.WriteResult |
A WriteResult exposes the update time set by the server. |
