Function reference • googleFirestore

All functions
`ArrayValue()`	ArrayValue Object
`BatchGetDocumentsRequest()`	BatchGetDocumentsRequest Object
`BatchGetDocumentsResponse()`	BatchGetDocumentsResponse Object
`BatchWriteRequest()`	BatchWriteRequest Object
`BatchWriteResponse()`	BatchWriteResponse Object
`BeginTransactionRequest()`	BeginTransactionRequest Object
`BeginTransactionResponse()`	BeginTransactionResponse Object
`CollectionSelector()`	CollectionSelector Object
`CommitRequest()`	CommitRequest Object
`CommitResponse()`	CommitResponse Object
`CompositeFilter()`	CompositeFilter Object
`Cursor()`	Cursor Object
`Document()`	Document Object
`DocumentChange()`	DocumentChange Object
`DocumentDelete()`	DocumentDelete Object
`DocumentMask()`	DocumentMask Object
`DocumentRemove()`	DocumentRemove Object
`DocumentTransform()`	DocumentTransform Object
`DocumentsTarget()`	DocumentsTarget Object
`Empty()`	Empty Object
`ExistenceFilter()`	ExistenceFilter Object
`FieldFilter()`	FieldFilter Object
`FieldReference()`	FieldReference Object
`FieldTransform()`	FieldTransform Object
`Filter()`	Filter Object
`GoogleFirestoreAdminV1ExportDocumentsMetadata()`	GoogleFirestoreAdminV1ExportDocumentsMetadata Object
`GoogleFirestoreAdminV1ExportDocumentsRequest()`	GoogleFirestoreAdminV1ExportDocumentsRequest Object
`GoogleFirestoreAdminV1ExportDocumentsResponse()`	GoogleFirestoreAdminV1ExportDocumentsResponse Object
`GoogleFirestoreAdminV1Field()`	GoogleFirestoreAdminV1Field Object
`GoogleFirestoreAdminV1FieldOperationMetadata()`	GoogleFirestoreAdminV1FieldOperationMetadata Object
`GoogleFirestoreAdminV1ImportDocumentsMetadata()`	GoogleFirestoreAdminV1ImportDocumentsMetadata Object
`GoogleFirestoreAdminV1ImportDocumentsRequest()`	GoogleFirestoreAdminV1ImportDocumentsRequest Object
`GoogleFirestoreAdminV1Index()`	GoogleFirestoreAdminV1Index Object
`GoogleFirestoreAdminV1IndexConfig()`	GoogleFirestoreAdminV1IndexConfig Object
`GoogleFirestoreAdminV1IndexConfigDelta()`	GoogleFirestoreAdminV1IndexConfigDelta Object
`GoogleFirestoreAdminV1IndexField()`	GoogleFirestoreAdminV1IndexField Object
`GoogleFirestoreAdminV1IndexOperationMetadata()`	GoogleFirestoreAdminV1IndexOperationMetadata Object
`GoogleFirestoreAdminV1ListFieldsResponse()`	GoogleFirestoreAdminV1ListFieldsResponse Object
`GoogleFirestoreAdminV1ListIndexesResponse()`	GoogleFirestoreAdminV1ListIndexesResponse Object
`GoogleFirestoreAdminV1LocationMetadata()`	GoogleFirestoreAdminV1LocationMetadata Object
`GoogleFirestoreAdminV1Progress()`	GoogleFirestoreAdminV1Progress Object
`GoogleLongrunningCancelOperationRequest()`	GoogleLongrunningCancelOperationRequest Object
`GoogleLongrunningListOperationsResponse()`	GoogleLongrunningListOperationsResponse Object
`GoogleLongrunningOperation()`	GoogleLongrunningOperation Object
`LatLng()`	LatLng Object
`ListCollectionIdsRequest()`	ListCollectionIdsRequest Object
`ListCollectionIdsResponse()`	ListCollectionIdsResponse Object
`ListDocumentsResponse()`	ListDocumentsResponse Object
`ListLocationsResponse()`	ListLocationsResponse Object
`ListenRequest()`	ListenRequest Object
`ListenResponse()`	ListenResponse Object
`Location()`	Location Object
`MapValue()`	MapValue Object
`Order()`	Order Object
`PartitionQueryRequest()`	PartitionQueryRequest Object
`PartitionQueryResponse()`	PartitionQueryResponse Object
`Precondition()`	Precondition Object
`Projection()`	Projection Object
`QueryTarget()`	QueryTarget Object
`ReadOnly()`	ReadOnly Object
`ReadWrite()`	ReadWrite Object
`RollbackRequest()`	RollbackRequest Object
`RunQueryRequest()`	RunQueryRequest Object
`RunQueryResponse()`	RunQueryResponse Object
`Status()`	Status Object
`StructuredQuery()`	StructuredQuery Object
`Target()`	Target Object
`TargetChange()`	TargetChange Object
`TransactionOptions()`	TransactionOptions Object
`UnaryFilter()`	UnaryFilter Object
`Value()`	Value Object
`Write()`	Cloud Firestore API Objects Accesses the NoSQL document database built for automatic scaling, high performance, and ease of application development.
`WriteRequest()`	WriteRequest Object
`WriteResponse()`	WriteResponse Object
`WriteResult()`	WriteResult Object
`firestore_googleAuthR`	Cloud Firestore API Accesses the NoSQL document database built for automatic scaling, high performance, and ease of application development.
`projects.databases.collectionGroups.fields.get()`	Gets the metadata and configuration for a Field.
`projects.databases.collectionGroups.fields.list()`	Lists the field configuration and metadata for this database. Currently, FirestoreAdmin.ListFields only supports listing fields that have been explicitly overridden. To issue this query, call FirestoreAdmin.ListFields with the filter set to `indexConfig.usesAncestorConfig:false` .
`projects.databases.collectionGroups.fields.patch()`	Updates a field configuration. Currently, field updates apply only to single field index configuration. However, calls to FirestoreAdmin.UpdateField should provide a field mask to avoid changing any configuration that the caller isn't aware of. The field mask should be specified as: `{ paths: 'index_config' }`. This call returns a google.longrunning.Operation which may be used to track the status of the field update. The metadata for the operation will be the type FieldOperationMetadata. To configure the default field settings for the database, use the special `Field` with resource name: `projects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/*`.
`projects.databases.collectionGroups.indexes.create()`	Creates a composite index. This returns a google.longrunning.Operation which may be used to track the status of the creation. The metadata for the operation will be the type IndexOperationMetadata.
`projects.databases.collectionGroups.indexes.delete()`	Deletes a composite index.
`projects.databases.collectionGroups.indexes.get()`	Gets a composite index.
`projects.databases.collectionGroups.indexes.list()`	Lists composite indexes.
`projects.databases.documents.batchGet()`	Gets multiple documents. Documents returned by this method are not guaranteed to be returned in the same order that they were requested.
`projects.databases.documents.batchWrite()`	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.
`projects.databases.documents.beginTransaction()`	Starts a new transaction.
`projects.databases.documents.commit()`	Commits a transaction, while optionally updating documents.
`projects.databases.documents.createDocument()`	Creates a new document.
`projects.databases.documents.delete()`	Deletes a document.
`projects.databases.documents.get()`	Gets a single document.
`projects.databases.documents.list()`	Lists documents.
`projects.databases.documents.listCollectionIds()`	Lists all the collection IDs underneath a document.
`projects.databases.documents.listen()`	Listens to changes.
`projects.databases.documents.partitionQuery()`	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.
`projects.databases.documents.patch()`	Updates or inserts a document.
`projects.databases.documents.rollback()`	Rolls back a transaction.
`projects.databases.documents.runQuery()`	Runs a query.
`projects.databases.documents.write()`	Streams batches of document updates and deletes, in order.
`projects.databases.exportDocuments()`	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. For more details on export behavior and output format, refer to: https://cloud.google.com/firestore/docs/manage-data/export-import
`projects.databases.importDocuments()`	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.
`projects.databases.operations.cancel()`	Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.
`projects.databases.operations.delete()`	Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
`projects.databases.operations.get()`	Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
`projects.databases.operations.list()`	Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users//operations`. To override the binding, API services can add a binding such as `'/v1/{name=users/}/operations'` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.
`projects.locations.get()`	Gets information about a location.
`projects.locations.list()`	Lists information about the supported locations for this service.

Reference

All functions