Cloud Firestore V1 Client - Class FirestoreAdminClient (1.53.0)

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.