Namespace Google.Apis.Firestore.v1

Classes

FirestoreBaseServiceRequest<TResponse>

A base abstract class for Firestore requests.

FirestoreService.Scope

Available OAuth 2.0 scopes for use with the Cloud Firestore API.

FirestoreService.ScopeConstants

Available OAuth 2.0 scope constants for use with the Cloud Firestore API.

ProjectsResource.DatabasesResource

The "databases" collection of methods.

ProjectsResource.DatabasesResource.BackupSchedulesResource

The "backupSchedules" collection of methods.

ProjectsResource.DatabasesResource.BackupSchedulesResource.CreateRequest

Creates a backup schedule on a database. At most two backup schedules can be configured on a database, one daily backup schedule and one weekly backup schedule.

ProjectsResource.DatabasesResource.BackupSchedulesResource.DeleteRequest

Deletes a backup schedule.

ProjectsResource.DatabasesResource.BackupSchedulesResource.GetRequest

Gets information about a backup schedule.

ProjectsResource.DatabasesResource.BackupSchedulesResource.ListRequest

List backup schedules.

ProjectsResource.DatabasesResource.BackupSchedulesResource.PatchRequest

Updates a backup schedule.

ProjectsResource.DatabasesResource.BulkDeleteDocumentsRequest

Bulk deletes a subset of documents from Google Cloud Firestore. Documents created or updated after the underlying system starts to process the request will not be deleted. The bulk delete occurs in the background and its progress can be monitored and managed via the Operation resource that is created. For more details on bulk delete behavior, refer to: https://cloud.google.com/firestore/docs/manage-data/bulk-delete

ProjectsResource.DatabasesResource.CollectionGroupsResource

The "collectionGroups" collection of methods.

ProjectsResource.DatabasesResource.CollectionGroupsResource.FieldsResource

The "fields" collection of methods.

ProjectsResource.DatabasesResource.CollectionGroupsResource.FieldsResource.GetRequest

Gets the metadata and configuration for a Field.

ProjectsResource.DatabasesResource.CollectionGroupsResource.FieldsResource.ListRequest

Lists the field configuration and metadata for this database. Currently, FirestoreAdmin.ListFields only supports listing fields that have been explicitly overridden. To issue this query, call FirestoreAdmin.ListFields with the filter set to indexConfig.usesAncestorConfig:false or ttlConfig:*.

ProjectsResource.DatabasesResource.CollectionGroupsResource.FieldsResource.PatchRequest

Updates a field configuration. Currently, field updates apply only to single field index configuration. However, calls to FirestoreAdmin.UpdateField should provide a field mask to avoid changing any configuration that the caller isn't aware of. The field mask should be specified as: { paths: "index_config" }. This call returns a google.longrunning.Operation which may be used to track the status of the field update. The metadata for the operation will be the type FieldOperationMetadata. To configure the default field settings for the database, use the special Field with resource name: projects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/*.

ProjectsResource.DatabasesResource.CollectionGroupsResource.IndexesResource

The "indexes" collection of methods.

ProjectsResource.DatabasesResource.CollectionGroupsResource.IndexesResource.CreateRequest

Creates a composite index. This returns a google.longrunning.Operation which may be used to track the status of the creation. The metadata for the operation will be the type IndexOperationMetadata.

ProjectsResource.DatabasesResource.CollectionGroupsResource.IndexesResource.DeleteRequest

Deletes a composite index.

ProjectsResource.DatabasesResource.CollectionGroupsResource.IndexesResource.GetRequest

Gets a composite index.

ProjectsResource.DatabasesResource.CollectionGroupsResource.IndexesResource.ListRequest

Lists composite indexes.

ProjectsResource.DatabasesResource.CreateRequest

Create a database.

ProjectsResource.DatabasesResource.DeleteRequest

Deletes a database.

ProjectsResource.DatabasesResource.DocumentsResource

The "documents" collection of methods.

ProjectsResource.DatabasesResource.DocumentsResource.BatchGetRequest

Gets multiple documents. Documents returned by this method are not guaranteed to be returned in the same order that they were requested.

ProjectsResource.DatabasesResource.DocumentsResource.BatchWriteRequest

Applies a batch of write operations. The BatchWrite method does not apply the write operations atomically and can apply them out of order. Method does not allow more than one write per document. Each write succeeds or fails independently. See the BatchWriteResponse for the success status of each write. If you require an atomically applied set of writes, use Commit instead.

ProjectsResource.DatabasesResource.DocumentsResource.BeginTransactionRequest

Starts a new transaction.

ProjectsResource.DatabasesResource.DocumentsResource.CommitRequest

Commits a transaction, while optionally updating documents.

ProjectsResource.DatabasesResource.DocumentsResource.CreateDocumentRequest

Creates a new document.

ProjectsResource.DatabasesResource.DocumentsResource.DeleteRequest

Deletes a document.

ProjectsResource.DatabasesResource.DocumentsResource.GetRequest

Gets a single document.

ProjectsResource.DatabasesResource.DocumentsResource.ListCollectionIdsRequest

Lists all the collection IDs underneath a document.

ProjectsResource.DatabasesResource.DocumentsResource.ListDocumentsRequest

Lists documents.

ProjectsResource.DatabasesResource.DocumentsResource.ListRequest

Lists documents.

ProjectsResource.DatabasesResource.DocumentsResource.ListenRequest

Listens to changes. This method is only available via gRPC or WebChannel (not REST).

ProjectsResource.DatabasesResource.DocumentsResource.PartitionQueryRequest

Partitions a query by returning partition cursors that can be used to run the query in parallel. The returned partition cursors are split points that can be used by RunQuery as starting/end points for the query results.

ProjectsResource.DatabasesResource.DocumentsResource.PatchRequest

Updates or inserts a document.

ProjectsResource.DatabasesResource.DocumentsResource.RollbackRequest

Rolls back a transaction.

ProjectsResource.DatabasesResource.DocumentsResource.RunAggregationQueryRequest

Runs an aggregation query. Rather than producing Document results like Firestore.RunQuery, this API allows running an aggregation to produce a series of AggregationResult server-side. High-Level Example:

-- Return the number of documents in table given a filter. SELECT COUNT(*) FROM (
SELECT * FROM k where a = true );

ProjectsResource.DatabasesResource.DocumentsResource.RunQueryRequest

Runs a query.

ProjectsResource.DatabasesResource.DocumentsResource.WriteRequest

Streams batches of document updates and deletes, in order. This method is only available via gRPC or WebChannel (not REST).

ProjectsResource.DatabasesResource.ExportDocumentsRequest

Exports a copy of all or a subset of documents from Google Cloud Firestore to another storage system, such as Google Cloud Storage. Recent updates to documents may not be reflected in the export. The export occurs in the background and its progress can be monitored and managed via the Operation resource that is created. The output of an export may only be used once the associated operation is done. If an export operation is cancelled before completion it may leave partial data behind in Google Cloud Storage. For more details on export behavior and output format, refer to: https://cloud.google.com/firestore/docs/manage-data/export-import

ProjectsResource.DatabasesResource.GetRequest

Gets information about a database.

ProjectsResource.DatabasesResource.ImportDocumentsRequest

Imports documents into Google Cloud Firestore. Existing documents with the same name are overwritten. The import occurs in the background and its progress can be monitored and managed via the Operation resource that is created. If an ImportDocuments operation is cancelled, it is possible that a subset of the data has already been imported to Cloud Firestore.

ProjectsResource.DatabasesResource.ListRequest

List all the databases in the project.

ProjectsResource.DatabasesResource.OperationsResource

The "operations" collection of methods.

ProjectsResource.DatabasesResource.OperationsResource.CancelRequest

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

ProjectsResource.DatabasesResource.OperationsResource.DeleteRequest

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

ProjectsResource.DatabasesResource.OperationsResource.GetRequest

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

ProjectsResource.DatabasesResource.OperationsResource.ListRequest

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

ProjectsResource.DatabasesResource.PatchRequest

Updates a database.

ProjectsResource.DatabasesResource.RestoreRequest

Creates a new database by restoring from an existing backup. The new database must be in the same cloud region or multi-region location as the existing backup. This behaves similar to FirestoreAdmin.CreateDatabase except instead of creating a new empty database, a new database is created with the database type, index configuration, and documents from an existing backup. The long-running operation can be used to track the progress of the restore, with the Operation's metadata field type being the RestoreDatabaseMetadata. The response type is the Database if the restore was successful. The new database is not readable or writeable until the LRO has completed.

Namespace Google.Apis.Firestore.v1

Classes

Enums