FirestoreAdminClient

The DNS address for this API service - same as servicePath(), exists for compatibility reasons.

The port for this API service.

The scopes needed to make gRPC calls for every method defined in this service.

The DNS address for this API service.

Check the status of the long running operation returned by the createIndex() method.

Check the status of the long running operation returned by the exportDocuments() method.

Check the status of the long running operation returned by the importDocuments() method.

Check the status of the long running operation returned by the updateField() method.

Terminate the GRPC channel and close the client.

The client will no longer be usable and all future behavior is undefined.

Return a fully-qualified collectionGroup resource name string.

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.

Return a fully-qualified database resource name string.

Deletes a composite index.

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.

Return a fully-qualified field resource name string.

Gets the metadata and configuration for a Field.

Gets a composite index.

Return the project ID used by this class.

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.

Return a fully-qualified index resource name string.

Initialize the client. Performs asynchronous operations (such as authentication) and prepares the client. This function will be called automatically when any class method is called for the first time, but if you need to initialize it before calling an actual method, feel free to call initialize() directly.

You can await on this method if you want to make sure the client is initialized.

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.

Equivalent to listFields, but returns an iterable object.

for-await-of syntax is used with the iterable to recursively get response element on-demand.

Equivalent to listFields, but returns a NodeJS Stream object.

This fetches the paged responses for listFields continuously and invokes the callback registered for 'data' event for each element in the responses.

The returned object has 'end' method when no more elements are required.

autoPaginate option will be ignored.

Lists composite indexes.

Equivalent to listIndexes, but returns an iterable object.

for-await-of syntax is used with the iterable to recursively get response element on-demand.

Equivalent to listIndexes, but returns a NodeJS Stream object.

This fetches the paged responses for listIndexes continuously and invokes the callback registered for 'data' event for each element in the responses.

The returned object has 'end' method when no more elements are required.

autoPaginate option will be ignored.

Parse the collection from CollectionGroup resource.

Parse the collection from Field resource.

Parse the collection from Index resource.

Parse the database from CollectionGroup resource.

Parse the database from Database resource.

Parse the database from Field resource.

Parse the database from Index resource.

Parse the field from Field resource.

Parse the index from Index resource.

Parse the project from CollectionGroup resource.

Parse the project from Database resource.

Parse the project from Field resource.

Parse the project from Index resource.

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