Namespace Google.Apis.Firestore.v1beta1

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.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.Request

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.

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.IndexesResource

The "indexes" collection of methods.

ProjectsResource.DatabasesResource.IndexesResource.CreateRequest

Creates the specified index. A newly created index's initial state is CREATING. On completion of the returned google.longrunning.Operation, the state will be READY. If the index already exists, the call will return an ALREADY_EXISTS status. During creation, the process could result in an error, in which case the index will move to the ERROR state. The process can be recovered by fixing the data that caused the error, removing the index with delete, then re-creating the index with create. Indexes with a single field cannot be created.