FirestoreAdminClient

Operations are created by service FirestoreAdmin, but are accessed via service google.longrunning.Operations.

Constructor

new FirestoreAdminClient(optionsopt)

Construct an instance of FirestoreAdminClient.

Parameters:

Name Type Attributes Description

options

object

The configuration object. The options accepted by the constructor are described in detail in this document. The common options are:

Properties

Name Type Attributes Description

credentials

object

Credentials object.

Properties

Name	Type	Attributes	Description
`client_email`	string	<optional>
`private_key`	string	<optional>

email

string

Account email address. Required when using a .pem or .p12 keyFilename.

keyFilename

string

Full path to the a .json, .pem, or .p12 key downloaded from the Google Developers Console. If you provide a path to a JSON file, the projectId option below is not necessary. NOTE: .pem and .p12 require you to specify options.email as well.

port

number

The port on which to connect to the remote host.

projectId

string

The project ID from the Google Developer's Console, e.g. 'grape-spaceship-123'. We will also check the environment variable GCLOUD_PROJECT for your project ID. If your app is running in an environment which supports Application Default Credentials, your project ID will be detected automatically.

apiEndpoint

string

The domain name of the API remote host.

clientConfig

gax.ClientConfig

Client configuration override. Follows the structure of gapicConfig.

fallback

boolean

Use HTTP fallback mode. In fallback mode, a special browser-compatible transport implementation is used instead of gRPC transport. In browser context (if the window object is defined) the fallback mode is enabled automatically; set options.fallback to false if you need to override this behavior.

Members

apiEndpoint

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

port

The port for this API service.

scopes

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

servicePath

The DNS address for this API service.

Methods

(async) checkCreateIndexProgress(name) → {Promise}

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

Parameters:

Name	Type	Description
`name`	String	The operation name that will be passed.

Returns:

Type	Description
Promise	The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.

Example

include:samples/generated/v1/firestore_admin.create_index.js

region_tag:firestore_v1_generated_FirestoreAdmin_CreateIndex_async

(async) checkExportDocumentsProgress(name) → {Promise}

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

Parameters:

Name	Type	Description
`name`	String	The operation name that will be passed.

Returns:

Type	Description
Promise	The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.

Example

include:samples/generated/v1/firestore_admin.export_documents.js

region_tag:firestore_v1_generated_FirestoreAdmin_ExportDocuments_async

(async) checkImportDocumentsProgress(name) → {Promise}

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

Parameters:

Name	Type	Description
`name`	String	The operation name that will be passed.

Returns:

Type	Description
Promise	The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.

Example

include:samples/generated/v1/firestore_admin.import_documents.js

region_tag:firestore_v1_generated_FirestoreAdmin_ImportDocuments_async

(async) checkUpdateFieldProgress(name) → {Promise}

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

Parameters:

Name	Type	Description
`name`	String	The operation name that will be passed.

Returns:

Type	Description
Promise	The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.

Example

include:samples/generated/v1/firestore_admin.update_field.js

region_tag:firestore_v1_generated_FirestoreAdmin_UpdateField_async

close() → {Promise}

Terminate the gRPC channel and close the client.

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

Returns:

Type	Description
Promise	A promise that resolves when the client is closed.

collectionGroupPath(project, database, collection) → {string}

Return a fully-qualified collectionGroup resource name string.

Parameters:

Name	Type	Description
`project`	string
`database`	string
`collection`	string

Returns:

Type	Description
string	Resource name string.

databasePath(project, database) → {string}

Return a fully-qualified database resource name string.

Parameters:

Name	Type	Description
`project`	string
`database`	string

Returns:

Type	Description
string	Resource name string.

fieldPath(project, database, collection, field) → {string}

Return a fully-qualified field resource name string.

Parameters:

Name	Type	Description
`project`	string
`database`	string
`collection`	string
`field`	string

Returns:

Type	Description
string	Resource name string.

getProjectId() → {Promise}

Return the project ID used by this class.

Returns:

Type	Description
Promise	A promise that resolves to string containing the project ID.

indexPath(project, database, collection, index) → {string}

Return a fully-qualified index resource name string.

Parameters:

Name	Type	Description
`project`	string
`database`	string
`collection`	string
`index`	string

Returns:

Type	Description
string	Resource name string.

initialize() → {Promise}

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.

Returns:

Type	Description
Promise	A promise that resolves to an authenticated service stub.

listFieldsAsync(request, optionsopt) → {Object}

Equivalent to listFields, but returns an iterable object.

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

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Description
`parent`	string	Required. A parent name of the form `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}`
`filter`	string	The filter to apply to list results. 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`.
`pageSize`	number	The number of results to return.
`pageToken`	string	A page token, returned from a previous call to FirestoreAdmin.ListFields, that may be used to get the next page of results.

options

object

Call options. See CallOptions for more details.

Returns:

Type	Description
Object	An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing Field. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.

Example

include:samples/generated/v1/firestore_admin.list_fields.js

region_tag:firestore_v1_generated_FirestoreAdmin_ListFields_async

listFieldsStream(request, optionsopt) → {Stream}

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Description
`parent`	string	Required. A parent name of the form `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}`
`filter`	string	The filter to apply to list results. 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`.
`pageSize`	number	The number of results to return.
`pageToken`	string	A page token, returned from a previous call to FirestoreAdmin.ListFields, that may be used to get the next page of results.

options

object

Call options. See CallOptions for more details.

Returns:

Type	Description
Stream	An object stream which emits an object representing Field on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using `listFieldsAsync()` method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listIndexesAsync(request, optionsopt) → {Object}

Equivalent to listIndexes, but returns an iterable object.

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

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Description
`parent`	string	Required. A parent name of the form `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}`
`filter`	string	The filter to apply to list results.
`pageSize`	number	The number of results to return.
`pageToken`	string	A page token, returned from a previous call to FirestoreAdmin.ListIndexes, that may be used to get the next page of results.

options

object

Call options. See CallOptions for more details.

Returns:

Type	Description
Object	An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing Index. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.

Example

include:samples/generated/v1/firestore_admin.list_indexes.js

region_tag:firestore_v1_generated_FirestoreAdmin_ListIndexes_async

listIndexesStream(request, optionsopt) → {Stream}

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Description
`parent`	string	Required. A parent name of the form `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}`
`filter`	string	The filter to apply to list results.
`pageSize`	number	The number of results to return.
`pageToken`	string	A page token, returned from a previous call to FirestoreAdmin.ListIndexes, that may be used to get the next page of results.

options

object

Call options. See CallOptions for more details.

Returns:

Type	Description
Stream	An object stream which emits an object representing Index on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using `listIndexesAsync()` method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

matchCollectionFromCollectionGroupName(collectionGroupName) → {string}

Parse the collection from CollectionGroup resource.

Parameters:

Name	Type	Description
`collectionGroupName`	string	A fully-qualified path representing CollectionGroup resource.

Returns:

Type	Description
string	A string representing the collection.

matchCollectionFromFieldName(fieldName) → {string}

Parse the collection from Field resource.

Parameters:

Name	Type	Description
`fieldName`	string	A fully-qualified path representing Field resource.

Returns:

Type	Description
string	A string representing the collection.

matchCollectionFromIndexName(indexName) → {string}

Parse the collection from Index resource.

Parameters:

Name	Type	Description
`indexName`	string	A fully-qualified path representing Index resource.

Returns:

Type	Description
string	A string representing the collection.

matchDatabaseFromCollectionGroupName(collectionGroupName) → {string}

Parse the database from CollectionGroup resource.

Parameters:

Name	Type	Description
`collectionGroupName`	string	A fully-qualified path representing CollectionGroup resource.

Returns:

Type	Description
string	A string representing the database.

matchDatabaseFromDatabaseName(databaseName) → {string}

Parse the database from Database resource.

Parameters:

Name	Type	Description
`databaseName`	string	A fully-qualified path representing Database resource.

Returns:

Type	Description
string	A string representing the database.

matchDatabaseFromFieldName(fieldName) → {string}

Parse the database from Field resource.

Parameters:

Name	Type	Description
`fieldName`	string	A fully-qualified path representing Field resource.

Returns:

Type	Description
string	A string representing the database.

matchDatabaseFromIndexName(indexName) → {string}

Parse the database from Index resource.

Parameters:

Name	Type	Description
`indexName`	string	A fully-qualified path representing Index resource.

Returns:

Type	Description
string	A string representing the database.

matchFieldFromFieldName(fieldName) → {string}

Parse the field from Field resource.

Parameters:

Name	Type	Description
`fieldName`	string	A fully-qualified path representing Field resource.

Returns:

Type	Description
string	A string representing the field.

matchIndexFromIndexName(indexName) → {string}

Parse the index from Index resource.

Parameters:

Name	Type	Description
`indexName`	string	A fully-qualified path representing Index resource.

Returns:

Type	Description
string	A string representing the index.

matchProjectFromCollectionGroupName(collectionGroupName) → {string}

Parse the project from CollectionGroup resource.

Parameters:

Name	Type	Description
`collectionGroupName`	string	A fully-qualified path representing CollectionGroup resource.

Returns:

Type	Description
string	A string representing the project.

matchProjectFromDatabaseName(databaseName) → {string}

Parse the project from Database resource.

Parameters:

Name	Type	Description
`databaseName`	string	A fully-qualified path representing Database resource.

Returns:

Type	Description
string	A string representing the project.

matchProjectFromFieldName(fieldName) → {string}

Parse the project from Field resource.

Parameters:

Name	Type	Description
`fieldName`	string	A fully-qualified path representing Field resource.

Returns:

Type	Description
string	A string representing the project.

matchProjectFromIndexName(indexName) → {string}

Parse the project from Index resource.

Parameters:

Name	Type	Description
`indexName`	string	A fully-qualified path representing Index resource.

Returns:

Type	Description
string	A string representing the project.