A base abstract class for Firestore requests.
FirestoreServiceThe Firestore Service.
FirestoreService.ScopeAvailable OAuth 2.0 scopes for use with the Cloud Firestore API.
FirestoreService.ScopeConstantsAvailable OAuth 2.0 scope constants for use with the Cloud Firestore API.
ProjectsResourceThe "projects" collection of methods.
ProjectsResource.DatabasesResourceThe "databases" collection of methods.
ProjectsResource.DatabasesResource.BackupSchedulesResourceThe "backupSchedules" collection of methods.
ProjectsResource.DatabasesResource.BackupSchedulesResource.CreateRequestCreates 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.DeleteRequestDeletes a backup schedule.
ProjectsResource.DatabasesResource.BackupSchedulesResource.GetRequestGets information about a backup schedule.
ProjectsResource.DatabasesResource.BackupSchedulesResource.ListRequestList backup schedules.
ProjectsResource.DatabasesResource.BackupSchedulesResource.PatchRequestUpdates a backup schedule.
ProjectsResource.DatabasesResource.BulkDeleteDocumentsRequestBulk 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.CollectionGroupsResourceThe "collectionGroups" collection of methods.
ProjectsResource.DatabasesResource.CollectionGroupsResource.FieldsResourceThe "fields" collection of methods.
ProjectsResource.DatabasesResource.CollectionGroupsResource.FieldsResource.GetRequestGets the metadata and configuration for a Field.
ProjectsResource.DatabasesResource.CollectionGroupsResource.FieldsResource.ListRequestLists 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:*
.
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/*
.
The "indexes" collection of methods.
ProjectsResource.DatabasesResource.CollectionGroupsResource.IndexesResource.CreateRequestCreates 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.DeleteRequestDeletes a composite index.
ProjectsResource.DatabasesResource.CollectionGroupsResource.IndexesResource.GetRequestGets a composite index.
ProjectsResource.DatabasesResource.CollectionGroupsResource.IndexesResource.ListRequestLists composite indexes.
ProjectsResource.DatabasesResource.CreateRequestCreate a database.
ProjectsResource.DatabasesResource.DeleteRequestDeletes a database.
ProjectsResource.DatabasesResource.DocumentsResourceThe "documents" collection of methods.
ProjectsResource.DatabasesResource.DocumentsResource.BatchGetRequestGets multiple documents. Documents returned by this method are not guaranteed to be returned in the same order that they were requested.
ProjectsResource.DatabasesResource.DocumentsResource.BatchWriteRequestApplies 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.BeginTransactionRequestStarts a new transaction.
ProjectsResource.DatabasesResource.DocumentsResource.CommitRequestCommits a transaction, while optionally updating documents.
ProjectsResource.DatabasesResource.DocumentsResource.CreateDocumentRequestCreates a new document.
ProjectsResource.DatabasesResource.DocumentsResource.DeleteRequestDeletes a document.
ProjectsResource.DatabasesResource.DocumentsResource.GetRequestGets a single document.
ProjectsResource.DatabasesResource.DocumentsResource.ListCollectionIdsRequestLists all the collection IDs underneath a document.
ProjectsResource.DatabasesResource.DocumentsResource.ListDocumentsRequestLists documents.
ProjectsResource.DatabasesResource.DocumentsResource.ListRequestLists documents.
ProjectsResource.DatabasesResource.DocumentsResource.ListenRequestListens to changes. This method is only available via gRPC or WebChannel (not REST).
ProjectsResource.DatabasesResource.DocumentsResource.PartitionQueryRequestPartitions 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.PatchRequestUpdates or inserts a document.
ProjectsResource.DatabasesResource.DocumentsResource.RollbackRequestRolls back a transaction.
ProjectsResource.DatabasesResource.DocumentsResource.RunAggregationQueryRequestRuns 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.WriteRequestStreams batches of document updates and deletes, in order. This method is only available via gRPC or WebChannel (not REST).
ProjectsResource.DatabasesResource.ExportDocumentsRequestExports 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.GetRequestGets information about a database.
ProjectsResource.DatabasesResource.ImportDocumentsRequestImports 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.ListRequestList all the databases in the project.
ProjectsResource.DatabasesResource.OperationsResourceThe "operations" collection of methods.
ProjectsResource.DatabasesResource.OperationsResource.CancelRequestStarts 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
.
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
.
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.ListRequestLists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED
.
Updates a database.
ProjectsResource.DatabasesResource.RestoreRequestCreates 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.
ProjectsResource.DatabasesResource.UserCredsResourceThe "userCreds" collection of methods.
ProjectsResource.DatabasesResource.UserCredsResource.CreateRequestCreate a user creds.
ProjectsResource.DatabasesResource.UserCredsResource.DeleteRequestDeletes a user creds.
ProjectsResource.DatabasesResource.UserCredsResource.DisableRequestDisables a user creds. No-op if the user creds are already disabled.
ProjectsResource.DatabasesResource.UserCredsResource.EnableRequestEnables a user creds. No-op if the user creds are already enabled.
ProjectsResource.DatabasesResource.UserCredsResource.GetRequestGets a user creds resource. Note that the returned resource does not contain the secret value itself.
ProjectsResource.DatabasesResource.UserCredsResource.ListRequestList all user creds in the database. Note that the returned resource does not contain the secret value itself.
ProjectsResource.DatabasesResource.UserCredsResource.ResetPasswordRequestResets the password of a user creds.
ProjectsResource.LocationsResourceThe "locations" collection of methods.
ProjectsResource.LocationsResource.BackupsResourceThe "backups" collection of methods.
ProjectsResource.LocationsResource.BackupsResource.DeleteRequestDeletes a backup.
ProjectsResource.LocationsResource.BackupsResource.GetRequestGets information about a backup.
ProjectsResource.LocationsResource.BackupsResource.ListRequestLists all the backups.
ProjectsResource.LocationsResource.GetRequestGets information about a location.
ProjectsResource.LocationsResource.ListRequestLists information about the supported locations for this service.
Enums FirestoreBaseServiceRequest<TResponse>.AltEnumData format for response.
FirestoreBaseServiceRequest<TResponse>.XgafvEnumV1 error format.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4