import * as mod from "https://googleapis.deno.dev/v1/firestore:v1.ts";
Firestore | Accesses the NoSQL document database built for automatic scaling, high performance, and ease of application development. |
GoogleAuth |
Aggregation | Defines an aggregation that produces a single result. |
AggregationResult | The result of a single bucket from a Firestore aggregation query. The keys
of |
ArrayValue | An array value. |
Avg | Average of the values of the requested field. * Only numeric values will be
aggregated. All non-numeric values including |
BatchGetDocumentsRequest | The request for Firestore.BatchGetDocuments. |
BatchGetDocumentsResponse | The streamed response for Firestore.BatchGetDocuments. |
BatchWriteRequest | The request for Firestore.BatchWrite. |
BatchWriteResponse | The response from Firestore.BatchWrite. |
BeginTransactionRequest | The request for Firestore.BeginTransaction. |
BeginTransactionResponse | The response for Firestore.BeginTransaction. |
BitSequence | A sequence of bits, encoded in a byte array. Each byte in the |
BloomFilter | A bloom filter (https://en.wikipedia.org/wiki/Bloom_filter). The bloom
filter hashes the entries with MD5 and treats the resulting 128-bit hash as 2
distinct 64-bit hash values, interpreted as unsigned integers using 2's
complement encoding. These two hash values, named |
CollectionSelector | A selection of a collection, such as |
CommitRequest | The request for Firestore.Commit. |
CommitResponse | The response for Firestore.Commit. |
CompositeFilter | A filter that merges multiple other filters using the given operator. |
Count | Count of documents that match the query. The |
CredentialsClient | Defines the root interface for all clients that generate credentials for calling Google APIs. All clients should implement this interface. |
Cursor | A position in a query result set. |
Document | A Firestore document. Must not exceed 1 MiB - 4 bytes. |
DocumentChange | 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. |
DocumentDelete | 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. |
DocumentMask | 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. |
DocumentRemove | 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. |
DocumentsTarget | A target specified by a set of documents names. |
DocumentTransform | A transformation of a document. |
Empty | 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); } |
ExecutionStats | Execution statistics for the query. |
ExistenceFilter | A digest of all the documents that match a given target. |
ExplainMetrics | Explain metrics for the query. |
ExplainOptions | Explain options for the query. |
FieldFilter | A filter on a specific field. |
FieldReference | A reference to a field in a document, ex: |
FieldTransform | A transformation of a field of the document. |
Filter | A filter. |
FindNearest | Nearest Neighbors search config. |
GoogleFirestoreAdminV1Backup | A Backup of a Cloud Firestore Database. The backup contains all documents and index configurations for the given database at a specific point in time. |
GoogleFirestoreAdminV1BackupSchedule | A backup schedule for a Cloud Firestore Database. This resource is owned by the database it is backing up, and is deleted along with the database. The actual backups are not though. |
GoogleFirestoreAdminV1CmekConfig | The CMEK (Customer Managed Encryption Key) configuration for a Firestore database. If not present, the database is secured by the default Google encryption key. |
GoogleFirestoreAdminV1CreateDatabaseMetadata | Metadata related to the create database operation. |
GoogleFirestoreAdminV1DailyRecurrence | Represents a recurring schedule that runs at a specific time every day. The time zone is UTC. |
GoogleFirestoreAdminV1Database | A Cloud Firestore Database. |
GoogleFirestoreAdminV1DatabaseSnapshot | A consistent snapshot of a database at a specific point in time. |
GoogleFirestoreAdminV1DeleteDatabaseMetadata | Metadata related to the delete database operation. |
GoogleFirestoreAdminV1ExportDocumentsMetadata | Metadata for google.longrunning.Operation results from FirestoreAdmin.ExportDocuments. |
GoogleFirestoreAdminV1ExportDocumentsRequest | The request for FirestoreAdmin.ExportDocuments. |
GoogleFirestoreAdminV1ExportDocumentsResponse | Returned in the google.longrunning.Operation response field. |
GoogleFirestoreAdminV1Field | 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. |
GoogleFirestoreAdminV1FieldOperationMetadata | Metadata for google.longrunning.Operation results from FirestoreAdmin.UpdateField. |
GoogleFirestoreAdminV1FlatIndex | An index that stores vectors in a flat data structure, and supports exhaustive search. |
GoogleFirestoreAdminV1ImportDocumentsMetadata | Metadata for google.longrunning.Operation results from FirestoreAdmin.ImportDocuments. |
GoogleFirestoreAdminV1ImportDocumentsRequest | The request for FirestoreAdmin.ImportDocuments. |
GoogleFirestoreAdminV1Index | Cloud Firestore indexes enable simple and complex queries against documents in a database. |
GoogleFirestoreAdminV1IndexConfig | The index configuration for this field. |
GoogleFirestoreAdminV1IndexConfigDelta | Information about an index configuration change. |
GoogleFirestoreAdminV1IndexField | A field in an index. The field_path describes which field is indexed, the value_mode describes how the field value is indexed. |
GoogleFirestoreAdminV1IndexOperationMetadata | Metadata for google.longrunning.Operation results from FirestoreAdmin.CreateIndex. |
GoogleFirestoreAdminV1ListBackupSchedulesResponse | The response for FirestoreAdmin.ListBackupSchedules. |
GoogleFirestoreAdminV1ListBackupsResponse | The response for FirestoreAdmin.ListBackups. |
GoogleFirestoreAdminV1ListDatabasesResponse | The list of databases for a project. |
GoogleFirestoreAdminV1ListFieldsResponse | The response for FirestoreAdmin.ListFields. |
GoogleFirestoreAdminV1ListIndexesResponse | The response for FirestoreAdmin.ListIndexes. |
GoogleFirestoreAdminV1LocationMetadata | The metadata message for google.cloud.location.Location.metadata. |
GoogleFirestoreAdminV1Progress | Describes the progress of the operation. Unit of work is generic and must be interpreted based on where Progress is used. |
GoogleFirestoreAdminV1RestoreDatabaseMetadata | Metadata for the long-running operation from the RestoreDatabase request. |
GoogleFirestoreAdminV1RestoreDatabaseRequest | The request message for FirestoreAdmin.RestoreDatabase. |
GoogleFirestoreAdminV1Stats | Backup specific statistics. |
GoogleFirestoreAdminV1TtlConfig | The TTL (time-to-live) configuration for documents that have this |
GoogleFirestoreAdminV1TtlConfigDelta | Information about a TTL configuration change. |
GoogleFirestoreAdminV1UpdateDatabaseMetadata | Metadata related to the update database operation. |
GoogleFirestoreAdminV1VectorConfig | The index configuration to support vector search operations |
GoogleFirestoreAdminV1WeeklyRecurrence | Represents a recurring schedule that runs on a specified day of the week. The time zone is UTC. |
GoogleLongrunningCancelOperationRequest | The request message for Operations.CancelOperation. |
GoogleLongrunningListOperationsResponse | The response message for Operations.ListOperations. |
GoogleLongrunningOperation | This resource represents a long-running operation that is the result of a network API call. |
LatLng | 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. |
ListCollectionIdsRequest | The request for Firestore.ListCollectionIds. |
ListCollectionIdsResponse | The response from Firestore.ListCollectionIds. |
ListDocumentsResponse | The response for Firestore.ListDocuments. |
ListenRequest | A request for Firestore.Listen |
ListenResponse | The response for Firestore.Listen. |
ListLocationsResponse | The response message for Locations.ListLocations. |
Location | A resource that represents a Google Cloud location. |
MapValue | A map value. |
Order | An order on a field. |
PartitionQueryRequest | The request for Firestore.PartitionQuery. |
PartitionQueryResponse | The response for Firestore.PartitionQuery. |
PlanSummary | Planning phase information for the query. |
Precondition | A precondition on a document, used for conditional operations. |
Projection | The projection of document's fields to return. |
ProjectsDatabasesBackupSchedulesPatchOptions | Additional options for Firestore#projectsDatabasesBackupSchedulesPatch. |
ProjectsDatabasesCollectionGroupsFieldsListOptions | Additional options for Firestore#projectsDatabasesCollectionGroupsFieldsList. |
ProjectsDatabasesCollectionGroupsFieldsPatchOptions | Additional options for Firestore#projectsDatabasesCollectionGroupsFieldsPatch. |
ProjectsDatabasesCollectionGroupsIndexesListOptions | Additional options for Firestore#projectsDatabasesCollectionGroupsIndexesList. |
ProjectsDatabasesCreateOptions | Additional options for Firestore#projectsDatabasesCreate. |
ProjectsDatabasesDeleteOptions | Additional options for Firestore#projectsDatabasesDelete. |
ProjectsDatabasesDocumentsCreateDocumentOptions | Additional options for Firestore#projectsDatabasesDocumentsCreateDocument. |
ProjectsDatabasesDocumentsDeleteOptions | Additional options for Firestore#projectsDatabasesDocumentsDelete. |
ProjectsDatabasesDocumentsGetOptions | Additional options for Firestore#projectsDatabasesDocumentsGet. |
ProjectsDatabasesDocumentsListDocumentsOptions | Additional options for Firestore#projectsDatabasesDocumentsListDocuments. |
ProjectsDatabasesDocumentsListOptions | Additional options for Firestore#projectsDatabasesDocumentsList. |
ProjectsDatabasesDocumentsPatchOptions | Additional options for Firestore#projectsDatabasesDocumentsPatch. |
ProjectsDatabasesOperationsListOptions | Additional options for Firestore#projectsDatabasesOperationsList. |
ProjectsDatabasesPatchOptions | Additional options for Firestore#projectsDatabasesPatch. |
ProjectsLocationsListOptions | Additional options for Firestore#projectsLocationsList. |
QueryTarget | A target specified by a query. |
ReadOnly | Options for a transaction that can only be used to read documents. |
ReadWrite | Options for a transaction that can be used to read and write documents. Firestore does not allow 3rd party auth requests to create read-write. transactions. |
RollbackRequest | The request for Firestore.Rollback. |
RunAggregationQueryRequest | The request for Firestore.RunAggregationQuery. |
RunAggregationQueryResponse | The response for Firestore.RunAggregationQuery. |
RunQueryRequest | The request for Firestore.RunQuery. |
RunQueryResponse | The response for Firestore.RunQuery. |
Status | The |
StructuredAggregationQuery | Firestore query for running an aggregation over a StructuredQuery. |
StructuredQuery | A Firestore query. The query stages are executed in the following order: 1. from 2. where 3. select 4. order_by + start_at + end_at 5. offset 6. limit |
Sum | Sum of the values of the requested field. * Only numeric values will be
aggregated. All non-numeric values including |
Target | A specification of a set of documents to listen to. |
TargetChange | Targets being watched have changed. |
TransactionOptions | Options for creating a new transaction. |
UnaryFilter | A filter with a single operand. |
Value | A message that can hold any of the supported value types. |
Write | A write on a document. |
WriteRequest | 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. |
WriteResponse | The response for Firestore.Write. |
WriteResult | The result of applying a write. |