Cloud Firestore V1 Client - Class FirestoreAdminClient (1.43.1)

Version 1.43.1

• 1.43.3 (latest)
• 1.43.2
• 1.40.0
• 1.39.0
• 1.38.0
• 1.37.7
• 1.36.1
• 1.35.0
• 1.34.0
• 1.33.0
• 1.32.0
• 1.31.0
• 1.30.0
• 1.28.0
• 1.27.3

Reference documentation and code samples for the Cloud Firestore V1 Client class FirestoreAdminClient.

Service Description: The Cloud Firestore Admin API.

Namespace

Google \ Cloud \ Firestore \ Admin \ V1

Methods

createIndex

See also:

• \Google\Cloud\Firestore\Admin\V1\FirestoreAdminClient::createIndexLRO

Parameters
Name	Description
parent	mixed
index	mixed
optionalArgs	array

Returns
Type	Description
Google\LongRunning\Operation

exportDocuments

See also:

• \Google\Cloud\Firestore\Admin\V1\FirestoreAdminClient::exportDocumentsLRO

Parameters
Name	Description
name	mixed
optionalArgs	array

Returns
Type	Description
Google\LongRunning\Operation

importDocuments

See also:

• \Google\Cloud\Firestore\Admin\V1\FirestoreAdminClient::importDocumentsLRO

Parameters
Name	Description
name	mixed
optionalArgs	array

Returns
Type	Description
Google\LongRunning\Operation

updateField

See also:

• \Google\Cloud\Firestore\Admin\V1\FirestoreAdminClient::updateFieldLRO

Parameters
Name	Description
field	mixed
optionalArgs	array

Returns
Type	Description
Google\LongRunning\Operation

static::parentName

Formats a string containing the fully-qualified path to represent a parent resource.

Parameters
Name	Description
project	string
database	string
collectionId	string

Returns
Type	Description
string	The formatted parent resource.