firestore/v1 library

Cloud Firestore API - v1

Accesses the NoSQL document database built for automatic scaling, high performance, and ease of application development.

For more information, see cloud.google.com/firestore

Create an instance of FirestoreApi to access these resources:

Classes

Aggregation
Defines an aggregation that produces a single result.
AggregationResult
The result of a single bucket from a Firestore aggregation query.
ArrayValue
An array value.
Avg
Average of the values of the requested field.
BatchGetDocumentsRequest
The request for Firestore.BatchGetDocuments.
BatchGetDocumentsResponseElement
BatchWriteRequest
The request for Firestore.BatchWrite.
BatchWriteResponse
The response from Firestore.BatchWrite.
BeginTransactionRequest
The request for Firestore.BeginTransaction.
BeginTransactionResponse
The response for Firestore.BeginTransaction.
CollectionSelector
A selection of a collection, such as messages as m1.
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.
Cursor
A position in a query result set.
Document
A Firestore document.
DocumentMask
A set of field paths on a document.
DocumentTransform
A transformation of a document.
ExplainMetrics
Explain metrics for the query.
FieldFilter
A filter on a specific field.
FieldReference
A reference to a field in a document, ex: stats.operations.
FieldTransform
A transformation of a field of the document.
Filter
A filter.
FindNearest
Nearest Neighbors search config.
FirestoreApi
Accesses the NoSQL document database built for automatic scaling, high performance, and ease of application development.
GoogleFirestoreAdminV1Backup
A Backup of a Cloud Firestore Database.
GoogleFirestoreAdminV1BackupSchedule
A backup schedule for a Cloud Firestore Database.
GoogleFirestoreAdminV1CmekConfig
The CMEK (Customer Managed Encryption Key) configuration for a Firestore database.
GoogleFirestoreAdminV1DailyRecurrence
Represents a recurring schedule that runs every day.
GoogleFirestoreAdminV1Database
A Cloud Firestore Database.
GoogleFirestoreAdminV1DatabaseSnapshot
A consistent snapshot of a database at a specific point in time.
GoogleFirestoreAdminV1ExportDocumentsRequest
The request for FirestoreAdmin.ExportDocuments.
GoogleFirestoreAdminV1Field
Represents a single field in the database.
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.
GoogleFirestoreAdminV1IndexField
A field in an index.
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.
GoogleFirestoreAdminV1RestoreDatabaseRequest
The request message for FirestoreAdmin.RestoreDatabase.
GoogleFirestoreAdminV1Stats
Backup specific statistics.
GoogleFirestoreAdminV1TtlConfig
The TTL (time-to-live) configuration for documents that have this Field set.
GoogleFirestoreAdminV1VectorConfig
The index configuration to support vector search operations
GoogleFirestoreAdminV1WeeklyRecurrence
Represents a recurring schedule that runs on a specified day of the week.
GoogleLongrunningListOperationsResponse
The response message for Operations.ListOperations.
GoogleLongrunningOperation
This resource represents a long-running operation that is the result of a network API call.
ListCollectionIdsRequest
The request for Firestore.ListCollectionIds.
ListCollectionIdsResponse
The response from Firestore.ListCollectionIds.
ListDocumentsResponse
The response for Firestore.ListDocuments.
ListLocationsResponse
The response message for Locations.ListLocations.
MapValue
A map value.
Order
An order on a field.
PartitionQueryRequest
The request for Firestore.PartitionQuery.
PartitionQueryResponse
The response for Firestore.PartitionQuery.
Precondition
A precondition on a document, used for conditional operations.
Projection
The projection of document's fields to return.
ProjectsDatabasesBackupSchedulesResource
ProjectsDatabasesCollectionGroupsFieldsResource
ProjectsDatabasesCollectionGroupsIndexesResource
ProjectsDatabasesCollectionGroupsResource
ProjectsDatabasesDocumentsResource
ProjectsDatabasesOperationsResource
ProjectsDatabasesResource
ProjectsLocationsBackupsResource
ProjectsLocationsResource
ProjectsResource
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.
RollbackRequest
The request for Firestore.Rollback.
RunAggregationQueryRequest
The request for Firestore.RunAggregationQuery.
RunAggregationQueryResponseElement
RunQueryRequest
The request for Firestore.RunQuery.
RunQueryResponseElement
StructuredAggregationQuery
Firestore query for running an aggregation over a StructuredQuery.
StructuredQuery
A Firestore query.
Sum
Sum of the values of the requested field.
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.
WriteResponse
The response for Firestore.Write.
WriteResult
The result of applying a write.

Typedefs

BatchGetDocumentsResponse = List<BatchGetDocumentsResponseElement>
The streamed response for Firestore.BatchGetDocuments.
Empty = $Empty
A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs.
ExecutionStats = $ExecutionStats
Execution statistics for the query.
ExplainOptions = $ExplainOptions
Explain options for the query.
GoogleFirestoreAdminV1FlatIndex = $Empty
An index that stores vectors in a flat data structure, and supports exhaustive search.
GoogleLongrunningCancelOperationRequest = $Empty
The request message for Operations.CancelOperation.
LatLng = $LatLng
An object that represents a latitude/longitude pair.
Location = $Location00
A resource that represents a Google Cloud location.
PlanSummary = $PlanSummary
Planning phase information for the query.
RunAggregationQueryResponse = List<RunAggregationQueryResponseElement>
The response for Firestore.RunAggregationQuery.
RunQueryResponse = List<RunQueryResponseElement>
The response for Firestore.RunQuery.
Status = $Status
The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs.
TimeOfDay = $TimeOfDay
Represents a time of day.

Exceptions / Errors

ApiRequestError
Represents a general error reported by the API endpoint.
DetailedApiRequestError
Represents a specific error reported by the API endpoint.