Cloud Firestore API
bookmark_border Stay organized with collections Save and categorize content based on your preferences.

Accesses the NoSQL document database built for automatic scaling, high performance, and ease of application development.

Service: firestore.googleapis.com

The Service name firestore.googleapis.com is needed to create RPC client stubs.

Methods
`GetLocation`	Gets information about a location.
`ListLocations`	Lists information about the supported locations for this service.

Methods
`BulkDeleteDocuments`	Bulk deletes a subset of documents from Google Cloud Firestore.
`CreateBackupSchedule`	Creates a backup schedule on a database.
`CreateDatabase`	Create a database.
`CreateIndex`	Creates a composite index.
`DeleteBackup`	Deletes a backup.
`DeleteBackupSchedule`	Deletes a backup schedule.
`DeleteDatabase`	Deletes a database.
`DeleteIndex`	Deletes a composite index.
`ExportDocuments`	Exports a copy of all or a subset of documents from Google Cloud Firestore to another storage system, such as Google Cloud Storage.
`GetBackup`	Gets information about a backup.
`GetBackupSchedule`	Gets information about a backup schedule.
`GetDatabase`	Gets information about a database.
`GetField`	Gets the metadata and configuration for a Field.
`GetIndex`	Gets a composite index.
`ImportDocuments`	Imports documents into Google Cloud Firestore.
`ListBackupSchedules`	List backup schedules.
`ListBackups`	Lists all the backups.
`ListDatabases`	List all the databases in the project.
`ListFields`	Lists the field configuration and metadata for this database.
`ListIndexes`	Lists composite indexes.
`RestoreDatabase`	Creates a new database by restoring from an existing backup.
`UpdateBackupSchedule`	Updates a backup schedule.
`UpdateDatabase`	Updates a database.
`UpdateField`	Updates a field configuration.

Methods
`CreateIndex`	Creates the specified index.
`DeleteIndex`	Deletes an index.
`ExportDocuments`	Exports a copy of all or a subset of documents from Google Cloud Firestore to another storage system, such as Google Cloud Storage.
`GetIndex`	Gets an index.
`ImportDocuments`	Imports documents into Google Cloud Firestore.
`ListIndexes`	Lists the indexes that match the specified filters.

Methods
`CreateIndex`	Creates a composite index.
`DeleteIndex`	Deletes a composite index.
`ExportDocuments`	Exports a copy of all or a subset of documents from Google Cloud Firestore to another storage system, such as Google Cloud Storage.
`GetField`	Gets the metadata and configuration for a Field.
`GetIndex`	Gets a composite index.
`ImportDocuments`	Imports documents into Google Cloud Firestore.
`ListFields`	Lists the field configuration and metadata for this database.
`ListIndexes`	Lists composite indexes.
`UpdateField`	Updates a field configuration.

Methods
`BatchGetDocuments`	Gets multiple documents.
`BatchWrite`	Applies a batch of write operations.
`BeginTransaction`	Starts a new transaction.
`Commit`	Commits a transaction, while optionally updating documents.
`CreateDocument`	Creates a new document.
`DeleteDocument`	Deletes a document.
`GetDocument`	Gets a single document.
`ListCollectionIds`	Lists all the collection IDs underneath a document.
`ListDocuments`	Lists documents.
`Listen`	Listens to changes.
`PartitionQuery`	Partitions a query by returning partition cursors that can be used to run the query in parallel.
`Rollback`	Rolls back a transaction.
`RunAggregationQuery`	Runs an aggregation query.
`RunQuery`	Runs a query.
`UpdateDocument`	Updates or inserts a document.
`Write`	Streams batches of document updates and deletes, in order.

Methods
`BatchGetDocuments`	Gets multiple documents.
`BatchWrite`	Applies a batch of write operations.
`BeginTransaction`	Starts a new transaction.
`Commit`	Commits a transaction, while optionally updating documents.
`CreateDocument`	Creates a new document.
`DeleteDocument`	Deletes a document.
`GetDocument`	Gets a single document.
`ListCollectionIds`	Lists all the collection IDs underneath a document.
`ListDocuments`	Lists documents.
`Listen`	Listens to changes.
`PartitionQuery`	Partitions a query by returning partition cursors that can be used to run the query in parallel.
`Rollback`	Rolls back a transaction.
`RunAggregationQuery`	Runs an aggregation query.
`RunQuery`	Runs a query.
`UpdateDocument`	Updates or inserts a document.
`Write`	Streams batches of document updates and deletes, in order.

Methods
`CancelOperation`	Starts asynchronous cancellation on a long-running operation.
`DeleteOperation`	Deletes a long-running operation.
`GetOperation`	Gets the latest state of a long-running operation.
`ListOperations`	Lists operations that match the specified filter in the request.
`WaitOperation`	Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state.