firestore/v1beta1 library
Cloud Firestore API - v1beta1
Accesses the NoSQL document database built for automatic scaling, high performance, and ease of application development.
For more information, see cloud.google.com/firestore
Create an instance of FirestoreApi to access these resources:
Classes
- Aggregation
- Defines an aggregation that produces a single result.
- AggregationResult
- The result of a single bucket from a Firestore aggregation query.
- ArrayValue
- An array value.
- Avg
- Average of the values of the requested field.
- BatchGetDocumentsRequest
- The request for Firestore.BatchGetDocuments.
- BatchGetDocumentsResponse
- The streamed response for Firestore.BatchGetDocuments.
- BatchWriteRequest
- The request for Firestore.BatchWrite.
- BatchWriteResponse
- The response from Firestore.BatchWrite.
- BeginTransactionRequest
- The request for Firestore.BeginTransaction.
- BitSequence
- A sequence of bits, encoded in a byte array.
- BloomFilter
- A bloom filter (https://en.wikipedia.org/wiki/Bloom_filter).
- CommitRequest
- The request for Firestore.Commit.
- CommitResponse
- The response for Firestore.Commit.
- CompositeFilter
- A filter that merges multiple other filters using the given operator.
- Cursor
- A position in a query result set.
- Document
- A Firestore document.
- DocumentChange
- A Document has changed.
- DocumentDelete
- A Document has been deleted.
- DocumentRemove
- A Document has been removed from the view of the targets.
- DocumentsTarget
- A target specified by a set of documents names.
- DocumentTransform
- A transformation of a document.
- ExistenceFilter
- A digest of all the documents that match a given target.
- FieldFilter
- A filter on a specific field.
- FieldTransform
- A transformation of a field of the document.
- Filter
- A filter.
- FirestoreApi
- Accesses the NoSQL document database built for automatic scaling, high performance, and ease of application development.
- GoogleFirestoreAdminV1beta1ImportDocumentsRequest
- The request for FirestoreAdmin.ImportDocuments.
- GoogleFirestoreAdminV1beta1Index
- An index definition.
- GoogleFirestoreAdminV1beta1IndexField
- A field of an index.
- GoogleFirestoreAdminV1beta1ListIndexesResponse
- The response for FirestoreAdmin.ListIndexes.
- GoogleLongrunningOperation
- This resource represents a long-running operation that is the result of a network API call.
- ListDocumentsResponse
- The response for Firestore.ListDocuments.
- ListenRequest
- A request for Firestore.Listen
- ListenResponse
- The response for Firestore.Listen.
- MapValue
- A map value.
- Order
- An order on a field.
- PartitionQueryRequest
- The request for Firestore.PartitionQuery.
- PartitionQueryResponse
- The response for Firestore.PartitionQuery.
- Projection
- The projection of document's fields to return.
- ProjectsDatabasesDocumentsResource
- ProjectsDatabasesIndexesResource
- ProjectsDatabasesResource
- ProjectsResource
- QueryTarget
- A target specified by a query.
- RunAggregationQueryRequest
- The request for Firestore.RunAggregationQuery.
- RunAggregationQueryResponse
- The response for Firestore.RunAggregationQuery.
- RunQueryRequest
- The request for Firestore.RunQuery.
- RunQueryResponse
- The response for Firestore.RunQuery.
- StructuredAggregationQuery
- Firestore query for running an aggregation over a StructuredQuery.
- StructuredQuery
- A Firestore query.
- Sum
- Sum of the values of the requested field.
- Target
- A specification of a set of documents to listen to.
- TargetChange
- Targets being watched have changed.
- TransactionOptions
- Options for creating a new transaction.
- UnaryFilter
- A filter with a single operand.
- Value
- A message that can hold any of the supported value types.
- Write
- A write on a document.
- WriteRequest
- The request for Firestore.Write.
- WriteResponse
- The response for Firestore.Write.
- WriteResult
- The result of applying a write.
Typedefs
- BeginTransactionResponse = $BeginTransactionResponse
- The response for Firestore.BeginTransaction.
- CollectionSelector = $CollectionSelector
-
A selection of a collection, such as
messages as m1. - Count = $Count
- Count of documents that match the query.
- DocumentMask = $DocumentMask
- A set of field paths on a document.
- Empty = $Empty
- A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs.
- FieldReference = $FieldReference
-
A reference to a field in a document, ex:
stats.operations. - GoogleFirestoreAdminV1beta1ExportDocumentsRequest = $ExportDocumentsRequest
- The request for FirestoreAdmin.ExportDocuments.
- LatLng = $LatLng
- An object that represents a latitude/longitude pair.
- ListCollectionIdsRequest = $ListCollectionIdsRequest
- The request for Firestore.ListCollectionIds.
- ListCollectionIdsResponse = $ListCollectionIdsResponse
- The response from Firestore.ListCollectionIds.
- Precondition = $Precondition
- A precondition on a document, used for conditional operations.
- ReadOnly = $ReadOnly
- Options for a transaction that can only be used to read documents.
- ReadWrite = $ReadWrite
- Options for a transaction that can be used to read and write documents.
- RollbackRequest = $RollbackRequest
- The request for Firestore.Rollback.
- Status = $Status
-
The
Statustype defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs.
Exceptions / Errors
- ApiRequestError
- Represents a general error reported by the API endpoint.
- DetailedApiRequestError
- Represents a specific error reported by the API endpoint.