API Reference google_api_firestore v0.21.3

Modules

API client metadata for GoogleApi.Firestore.V1.

API calls for all endpoints tagged Projects.

Handle Tesla connections for GoogleApi.Firestore.V1.

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.

Metadata for google.longrunning.Operation results from FirestoreAdmin.ExportDocuments.

The request for FirestoreAdmin.ExportDocuments.

Returned in the google.longrunning.Operation response field.

Represents a single field in the database. Fields are grouped by their "Collection Group", which represent all collections in the database with the same id.

Metadata for google.longrunning.Operation results from FirestoreAdmin.UpdateField.

Metadata for google.longrunning.Operation results from FirestoreAdmin.ImportDocuments.

The request for FirestoreAdmin.ImportDocuments.

Cloud Firestore indexes enable simple and complex queries against documents in a database.

The index configuration for this field.

Information about an index configuration change.

A field in an index. The field_path describes which field is indexed, the value_mode describes how the field value is indexed.

Metadata for google.longrunning.Operation results from FirestoreAdmin.CreateIndex.

The response for FirestoreAdmin.ListFields.

The response for FirestoreAdmin.ListIndexes.

The metadata message for google.cloud.location.Location.metadata.

Describes the progress of the operation. Unit of work is generic and must be interpreted based on where Progress is used.

The request message for Operations.CancelOperation.

The response message for Operations.ListOperations.

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.

The response message for Locations.ListLocations.

A request for Firestore.Listen

The response for Firestore.Listen.

A resource that represents Google Cloud Platform location.

An order on a field.

The request for Firestore.PartitionQuery.

The response for Firestore.PartitionQuery.

A precondition on a document, used for conditional operations.

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

API client metadata for GoogleApi.Firestore.V1beta1.

API calls for all endpoints tagged Projects.

Handle Tesla connections for GoogleApi.Firestore.V1beta1.

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.

Returned in the google.longrunning.Operation response field.

Metadata for index operations. This metadata populates the metadata field of google.longrunning.Operation.

The metadata message for google.cloud.location.Location.metadata.

Measures the progress of a particular metric.

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.

The request for Firestore.PartitionQuery.

The response for Firestore.PartitionQuery.

A precondition on a document, used for conditional operations.

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

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.