firestore.v1 library Null safety

Cloud Firestore API - v1

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

ArrayValue
An array value.
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.
BeginTransactionResponse
The response for Firestore.BeginTransaction.
CollectionSelector
A selection of a collection, such as messages as m1.
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. [...]
DocumentMask
A set of field paths on a document. [...]
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.
Empty
A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. [...]
ExistenceFilter
A digest of all the documents that match a given target.
FieldFilter
A filter on a specific field.
FieldReference
A reference to a field, such as max(messages.time) as max_time.
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.
GoogleFirestoreAdminV1ExportDocumentsMetadata
Metadata for google.longrunning.Operation results from FirestoreAdmin.ExportDocuments.
GoogleFirestoreAdminV1ExportDocumentsRequest
The request for FirestoreAdmin.ExportDocuments.
GoogleFirestoreAdminV1ExportDocumentsResponse
Returned in the google.longrunning.Operation response field.
GoogleFirestoreAdminV1Field
Represents a single field in the database. [...]
GoogleFirestoreAdminV1FieldOperationMetadata
Metadata for google.longrunning.Operation results from FirestoreAdmin.UpdateField.
GoogleFirestoreAdminV1ImportDocumentsMetadata
Metadata for google.longrunning.Operation results from FirestoreAdmin.ImportDocuments.
GoogleFirestoreAdminV1ImportDocumentsRequest
The request for FirestoreAdmin.ImportDocuments.
GoogleFirestoreAdminV1Index
Cloud Firestore indexes enable simple and complex queries against documents in a database.
GoogleFirestoreAdminV1IndexConfig
The index configuration for this field.
GoogleFirestoreAdminV1IndexConfigDelta
Information about an index configuration change.
GoogleFirestoreAdminV1IndexField
A field in an index. [...]
GoogleFirestoreAdminV1IndexOperationMetadata
Metadata for google.longrunning.Operation results from FirestoreAdmin.CreateIndex.
GoogleFirestoreAdminV1ListFieldsResponse
The response for FirestoreAdmin.ListFields.
GoogleFirestoreAdminV1ListIndexesResponse
The response for FirestoreAdmin.ListIndexes.
GoogleFirestoreAdminV1LocationMetadata
The metadata message for google.cloud.location.Location.metadata.
GoogleFirestoreAdminV1Progress
Describes the progress of the operation. [...]
GoogleLongrunningCancelOperationRequest
The request message for Operations.CancelOperation.
GoogleLongrunningListOperationsResponse
The response message for Operations.ListOperations.
GoogleLongrunningOperation
This resource represents a long-running operation that is the result of a network API call.
LatLng
An object that represents a latitude/longitude pair. [...]
ListCollectionIdsRequest
The request for Firestore.ListCollectionIds.
ListCollectionIdsResponse
The response from Firestore.ListCollectionIds.
ListDocumentsResponse
The response for Firestore.ListDocuments.
ListenRequest
A request for Firestore.Listen
ListenResponse
The response for Firestore.Listen.
ListLocationsResponse
The response message for Locations.ListLocations.
Location
A resource that represents Google Cloud Platform location.
MapValue
A map value.
Order
An order on a field.
PartitionQueryRequest
The request for Firestore.PartitionQuery.
PartitionQueryResponse
The response for Firestore.PartitionQuery.
Precondition
A precondition on a document, used for conditional operations.
Projection
The projection of document's fields to return.
ProjectsDatabasesCollectionGroupsFieldsResource
ProjectsDatabasesCollectionGroupsIndexesResource
ProjectsDatabasesCollectionGroupsResource
ProjectsDatabasesDocumentsResource
ProjectsDatabasesOperationsResource
ProjectsDatabasesResource
ProjectsLocationsResource
ProjectsResource
QueryTarget
A target specified by a query.
ReadOnly
Options for a transaction that can only be used to read documents.
ReadWrite
Options for a transaction that can be used to read and write documents.
RollbackRequest
The request for Firestore.Rollback.
RunQueryRequest
The request for Firestore.RunQuery.
RunQueryResponse
The response for Firestore.RunQuery.
Status
The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. [...]
StructuredQuery
A Firestore query.
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.

Exceptions / Errors

ApiRequestError
Represents a general error reported by the API endpoint.
DetailedApiRequestError
Represents a specific error reported by the API endpoint.