This package is not the recommended entry point to using this client library!
For this library, we recommend using com.google.cloud.firestore for new applications.
Classes
| Class | Description |
|---|---|
| com. |
The result of a single bucket from a Firestore aggregation query.
The keys of aggregate_fields
are the same for all results in an aggregation |
| com. |
The result of a single bucket from a Firestore aggregation query.
The keys of aggregate_fields
are the same for all results in an aggregation |
| com. |
|
| com. |
AUTO-GENERATED DOCUMENTATION AND CLASS |
| com. |
Builder for AnyPathName. |
| com. |
An array value. |
| com. |
An array value. |
| com. |
The request for Firestore.BatchGetDocuments . |
| com. |
The request for Firestore.BatchGetDocuments . |
| com. |
The streamed response for Firestore.BatchGetDocuments . |
| com. |
The streamed response for Firestore.BatchGetDocuments . |
| com. |
The request for Firestore.BatchWrite . |
| com. |
The request for Firestore.BatchWrite . |
| com. |
The response from Firestore.BatchWrite . |
| com. |
The response from Firestore.BatchWrite . |
| com. |
The request for Firestore.BeginTransaction . |
| com. |
The request for Firestore.BeginTransaction . |
| com. |
The response for Firestore.BeginTransaction . |
| com. |
The response for Firestore.BeginTransaction . |
| com. |
A sequence of bits, encoded in a byte array.
Each byte in the bitmap
byte array stores 8 bits of the sequence. The only |
| com. |
A sequence of bits, encoded in a byte array.
Each byte in the bitmap
byte array stores 8 bits of the sequence. The only |
| com. |
A bloom filter ( https://en.wikipedia.org/wiki/Bloom_filter ). The bloom filter hashes the entries with MD5 and treats the resulting 128-bit |
| com. |
A bloom filter ( https://en.wikipedia.org/wiki/Bloom_filter ). The bloom filter hashes the entries with MD5 and treats the resulting 128-bit |
| com. |
|
| com. |
The request for Firestore.Commit . |
| com. |
The request for Firestore.Commit . |
| com. |
The response for Firestore.Commit . |
| com. |
The response for Firestore.Commit . |
| com. |
|
| com. |
The request for Firestore.CreateDocument . |
| com. |
The request for Firestore.CreateDocument . |
| com. |
A position in a query result set. |
| com. |
A position in a query result set. |
| com. |
AUTO-GENERATED DOCUMENTATION AND CLASS |
| com. |
Builder for DatabaseRootName. |
| com. |
The request for Firestore.DeleteDocument . |
| com. |
The request for Firestore.DeleteDocument . |
| com. |
A Firestore document. Must not exceed 1 MiB - 4 bytes. |
| com. |
A Firestore document. Must not exceed 1 MiB - 4 bytes. |
| com. |
A Document has changed. May be the result of multiple writes , including |
| com. |
A Document has changed. May be the result of multiple writes , including |
| com. |
A Document has been deleted. May be the result of multiple writes , including |
| com. |
A Document has been deleted. May be the result of multiple writes , including |
| com. |
A set of field paths on a document. Used to restrict a get or update operation on a document to a subset of its fields. |
| com. |
A set of field paths on a document. Used to restrict a get or update operation on a document to a subset of its fields. |
| com. |
AUTO-GENERATED DOCUMENTATION AND CLASS |
| com. |
Builder for DocumentPathName. |
| com. |
|
| com. |
A Document has been removed from the view of the targets. |
| com. |
A Document has been removed from the view of the targets. |
| com. |
AUTO-GENERATED DOCUMENTATION AND CLASS |
| com. |
Builder for DocumentRootName. |
| com. |
A transformation of a document. |
| com. |
A transformation of a document. |
| com. |
A transformation of a field of the document. |
| com. |
A transformation of a field of the document. |
| com. |
The request for Firestore.ExecutePipeline . |
| com. |
The request for Firestore.ExecutePipeline . |
| com. |
The response for [Firestore.Execute][]. |
| com. |
The response for [Firestore.Execute][]. |
| com. |
Execution statistics for the query. |
| com. |
Execution statistics for the query. |
| com. |
A digest of all the documents that match a given target. |
| com. |
A digest of all the documents that match a given target. |
| com. |
Explain metrics for the query. |
| com. |
Explain metrics for the query. |
| com. |
Explain options for the query. |
| com. |
Explain options for the query. |
| com. |
Pipeline explain stats. Depending on the explain options in the original request, this can contain |
| com. |
Pipeline explain stats. Depending on the explain options in the original request, this can contain |
| com. |
|
| com. |
The Cloud Firestore service. Cloud Firestore is a fast, fully managed, serverless, cloud-native NoSQL document database that simplifies storing, syncing, and querying data for |
| com. |
Base class for the server implementation of the service Firestore. The Cloud Firestore service. |
| com. |
|
| com. |
Represents an unevaluated scalar expression.
For example, the expression like(user_name, "%alice%")
is represented as: |
| com. |
Represents an unevaluated scalar expression.
For example, the expression like(user_name, "%alice%")
is represented as: |
| com. |
The request for Firestore.GetDocument . |
| com. |
The request for Firestore.GetDocument . |
| com. |
The request for Firestore.ListCollectionIds . |
| com. |
The request for Firestore.ListCollectionIds . |
| com. |
The response from Firestore.ListCollectionIds . |
| com. |
The response from Firestore.ListCollectionIds . |
| com. |
The request for Firestore.ListDocuments . |
| com. |
The request for Firestore.ListDocuments . |
| com. |
The response for Firestore.ListDocuments . |
| com. |
The response for Firestore.ListDocuments . |
| com. |
A request for Firestore.Listen |
| com. |
A request for Firestore.Listen |
| com. |
The response for Firestore.Listen . |
| com. |
The response for Firestore.Listen . |
| com. |
A map value. |
| com. |
A map value. |
| com. |
The request for Firestore.PartitionQuery . |
| com. |
The request for Firestore.PartitionQuery . |
| com. |
The response for Firestore.PartitionQuery . |
| com. |
The response for Firestore.PartitionQuery . |
| com. |
A Firestore query represented as an ordered list of operations / stages. |
| com. |
A Firestore query represented as an ordered list of operations / stages. |
| com. |
A single operation within a pipeline. A stage is made up of a unique name, and a list of arguments. The exact |
| com. |
A single operation within a pipeline. A stage is made up of a unique name, and a list of arguments. The exact |
| com. |
|
| com. |
Planning phase information for the query. |
| com. |
Planning phase information for the query. |
| com. |
A precondition on a document, used for conditional operations. |
| com. |
A precondition on a document, used for conditional operations. |
| com. |
|
| com. |
|
| com. |
The request for Firestore.Rollback . |
| com. |
The request for Firestore.Rollback . |
| com. |
The request for Firestore.RunAggregationQuery . |
| com. |
The request for Firestore.RunAggregationQuery . |
| com. |
The response for Firestore.RunAggregationQuery . |
| com. |
The response for Firestore.RunAggregationQuery . |
| com. |
The request for Firestore.RunQuery . |
| com. |
The request for Firestore.RunQuery . |
| com. |
The response for Firestore.RunQuery . |
| com. |
The response for Firestore.RunQuery . |
| com. |
Firestore query for running an aggregation over a StructuredQuery . |
| com. |
Defines an aggregation that produces a single result. |
| com. |
Average of the values of the requested field. * Only numeric values will be aggregated. All non-numeric values |
| com. |
Average of the values of the requested field. * Only numeric values will be aggregated. All non-numeric values |
| com. |
Defines an aggregation that produces a single result. |
| com. |
Count of documents that match the query.
The COUNT( )
aggregation function operates on the entire document |
| com. |
Count of documents that match the query.
The COUNT()
aggregation function operates on the entire document |
| com. |
Sum of the values of the requested field. * Only numeric values will be aggregated. All non-numeric values |
| com. |
Sum of the values of the requested field. * Only numeric values will be aggregated. All non-numeric values |
| com. |
Firestore query for running an aggregation over a StructuredQuery . |
| com. |
A Firestore query represented as an ordered list of operations / stages. This is considered the top-level function which plans and executes a query. |
| com. |
A Firestore query represented as an ordered list of operations / stages. This is considered the top-level function which plans and executes a query. |
| com. |
A Firestore query. The query stages are executed in the following order: |
| com. |
A Firestore query. The query stages are executed in the following order: |
| com. |
A selection of a collection, such as messages as m1
. |
| com. |
A selection of a collection, such as messages as m1
. |
| com. |
A filter that merges multiple other filters using the given operator. |
| com. |
A filter that merges multiple other filters using the given operator. |
| com. |
A filter on a specific field. |
| com. |
A filter on a specific field. |
| com. |
A reference to a field in a document, ex: stats.operations
. |
| com. |
A reference to a field in a document, ex: stats.operations
. |
| com. |
A filter. |
| com. |
A filter. |
| com. |
Nearest Neighbors search config. The ordering provided by FindNearest supersedes the order_by stage. If multiple documents have the same vector distance, the returned document order is not guaranteed to be stable |
| com. |
Nearest Neighbors search config. The ordering provided by FindNearest supersedes the order_by stage. If multiple documents have the same vector distance, the returned document order is not guaranteed to be stable |
| com. |
An order on a field. |
| com. |
An order on a field. |
| com. |
The projection of document's fields to return. |
| com. |
The projection of document's fields to return. |
| com. |
A filter with a single operand. |
| com. |
A filter with a single operand. |
| com. |
A specification of a set of documents to listen to. |
| com. |
A specification of a set of documents to listen to. |
| com. |
A target specified by a set of documents names. |
| com. |
A target specified by a set of documents names. |
| com. |
A target specified by a query. |
| com. |
A target specified by a query. |
| com. |
Targets being watched have changed. |
| com. |
Targets being watched have changed. |
| com. |
Options for creating a new transaction. |
| com. |
Options for creating a new transaction. |
| com. |
Options for a transaction that can only be used to read documents. |
| com. |
Options for a transaction that can only be used to read documents. |
| com. |
Options for a transaction that can be used to read and write documents. Firestore does not allow 3rd party auth requests to create read-write. |
| com. |
Options for a transaction that can be used to read and write documents. Firestore does not allow 3rd party auth requests to create read-write. |
| com. |
The request for Firestore.UpdateDocument . |
| com. |
The request for Firestore.UpdateDocument . |
| com. |
A message that can hold any of the supported value types. |
| com. |
A message that can hold any of the supported value types. |
| com. |
A write on a document. |
| com. |
A write on a document. |
| com. |
|
| com. |
The request for Firestore.Write . The first request creates a stream, or resumes an existing one from a token. |
| com. |
The request for Firestore.Write . The first request creates a stream, or resumes an existing one from a token. |
| com. |
The response for Firestore.Write . |
| com. |
The response for Firestore.Write . |
| com. |
The result of applying a write. |
| com. |
The result of applying a write. |
