Module google_firestore1_beta1::api
source · [−]Structs
An array value.
The request for Firestore.BatchGetDocuments.
The streamed response for Firestore.BatchGetDocuments.
The request for Firestore.BatchWrite.
The response from Firestore.BatchWrite.
The request for Firestore.BeginTransaction.
The response for Firestore.BeginTransaction.
A selection of a collection, such as messages as m1.
The request for Firestore.Commit.
The response for Firestore.Commit.
A filter that merges multiple other filters using the given operator.
A position in a query result set.
A Firestore document. Must not exceed 1 MiB - 4 bytes.
A Document has changed. May be the result of multiple writes, including deletes, that ultimately resulted in a new value for the Document. Multiple DocumentChange messages may be returned for the same logical change, if multiple targets are affected.
A Document has been deleted. May be the result of multiple writes, including updates, the last of which deleted the Document. Multiple DocumentDelete messages may be returned for the same logical delete, if multiple targets are affected.
A set of field paths on a document. Used to restrict a get or update operation on a document to a subset of its fields. This is different from standard field masks, as this is always scoped to a Document, and takes in account the dynamic nature of Value.
A Document has been removed from the view of the targets. Sent if the document is no longer relevant to a target and is out of view. Can be sent instead of a DocumentDelete or a DocumentChange if the server can not send the new value of the document. Multiple DocumentRemove messages may be returned for the same logical write or delete, if multiple targets are affected.
A transformation of a document.
A target specified by a set of documents names.
A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for Empty is empty JSON object {}.
A digest of all the documents that match a given target.
A filter on a specific field.
A reference to a field, such as max(messages.time) as max_time.
A transformation of a field of the document.
A filter.
Central instance to access all Firestore related resource activities
The request for FirestoreAdmin.ExportDocuments.
The request for FirestoreAdmin.ImportDocuments.
An index definition.
A field of an index.
The response for FirestoreAdmin.ListIndexes.
This resource represents a long-running operation that is the result of a network API call.
An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges.
The request for Firestore.ListCollectionIds.
The response from Firestore.ListCollectionIds.
The response for Firestore.ListDocuments.
A request for Firestore.Listen
The response for Firestore.Listen.
A map value.
An order on a field.
The request for Firestore.PartitionQuery.
The response for Firestore.PartitionQuery.
A precondition on a document, used for conditional operations.
Gets multiple documents. Documents returned by this method are not guaranteed to be returned in the same order that they were requested.
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.
Starts a new transaction.
Commits a transaction, while optionally updating documents.
Creates a new document.
Deletes a document.
Gets a single document.
Lists documents.
Lists all the collection IDs underneath a document.
Listens to changes.
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.
Updates or inserts a document.
Rolls back a transaction.
Runs a query.
Streams batches of document updates and deletes, in order.
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.
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.
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.
Deletes an index.
Gets an index.
Lists the indexes that match the specified filters.
A builder providing access to all methods supported on project resources.
It is not used directly, but through the Firestore hub.
The projection of document’s fields to return.
A target specified by a query.
Options for a transaction that can only be used to read documents.
Options for a transaction that can be used to read and write documents.
The request for Firestore.Rollback.
The request for Firestore.RunQuery.
The response for Firestore.RunQuery.
The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.
A Firestore query.
A specification of a set of documents to listen to.
Targets being watched have changed.
Options for creating a new transaction.
A filter with a single operand.
A message that can hold any of the supported value types.
A write on a document.
The request for Firestore.Write. The first request creates a stream, or resumes an existing one from a token. When creating a new stream, the server replies with a response containing only an ID and a token, to use in the next request. When resuming a stream, the server first streams any responses later than the given token, then a response containing only an up-to-date token, to use in the next request.
The response for Firestore.Write.
The result of applying a write.
Enums
Identifies the an OAuth2 authorization scope. A scope is needed when requesting an authorization token.