google_api_firestore v0.0.1 API Reference

Modules

API calls for all endpoints tagged Projects

Handle Tesla connections for GoogleApi.Firestore.V1beta1

Helper functions for deserializing responses into models

The request for Firestore.BatchGetDocuments

The streamed response for Firestore.BatchGetDocuments

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

An object representing a latitude/longitude pair. This is expressed as a pair of doubles representing degrees latitude and degrees longitude. Unless specified otherwise, this must conform to the <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84 standard</a>. Values must be within normalized ranges

The request for Firestore.ListCollectionIds

The response from Firestore.ListCollectionIds

The response for Firestore.ListDocuments

The response for FirestoreAdmin.ListIndexes

A request for Firestore.Listen

The response for Firestore.Listen

This resource represents a long-running operation that is the result of a network API call

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. The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers understand and resolve the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` that can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons

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

Helper functions for building Tesla requests