Reference documentation and code samples for the Cloud Firestore V1 Client class FirestoreAdminClient.
Service Description: The Cloud Firestore Admin API.
This API provides several administrative services for Cloud Firestore.
Project, Database, Namespace, Collection, Collection Group, and Document are used as defined in the Google Cloud Firestore API.
Operation: An Operation represents work being performed in the background.
The index service manages Cloud Firestore indexes.
Index creation is performed asynchronously. An Operation resource is created for each such asynchronous operation. The state of the operation (including any errors encountered) may be queried via the Operation resource.
The Operations collection provides a record of actions performed for the specified Project (including any Operations in progress). Operations are not created directly but through calls on other collections or resources.
An Operation that is done may be deleted so that it is no longer listed as
part of the Operation collection. Operations are garbage collected after
30 days. By default, ListOperations will only return in progress and failed
operations. To list completed operation, issue a ListOperations request with
the filter done: true
.
Operations are created by service FirestoreAdmin
, but are accessed via
service google.longrunning.Operations
.
This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:
$firestoreAdminClient = new FirestoreAdminClient();
try {
$formattedParent = $firestoreAdminClient->projectName('[PROJECT]');
$database = new Database();
$databaseId = 'database_id';
$operationResponse = $firestoreAdminClient->createDatabase($formattedParent, $database, $databaseId);
$operationResponse->pollUntilComplete();
if ($operationResponse->operationSucceeded()) {
$result = $operationResponse->getResult();
// doSomethingWith($result)
} else {
$error = $operationResponse->getError();
// handleError($error)
}
// Alternatively:
// start the operation, keep the operation name, and resume later
$operationResponse = $firestoreAdminClient->createDatabase($formattedParent, $database, $databaseId);
$operationName = $operationResponse->getName();
// ... do other work
$newOperationResponse = $firestoreAdminClient->resumeOperation($operationName, 'createDatabase');
while (!$newOperationResponse->isDone()) {
// ... do other work
$newOperationResponse->reload();
}
if ($newOperationResponse->operationSucceeded()) {
$result = $newOperationResponse->getResult();
// doSomethingWith($result)
} else {
$error = $newOperationResponse->getError();
// handleError($error)
}
} finally {
$firestoreAdminClient->close();
}
Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parseName method to extract the individual identifiers contained within formatted names that are returned by the API.
This service has a new (beta) implementation. See Google\Cloud\Firestore\Admin\V1\Client\FirestoreAdminClient to use the new surface.
Namespace
Google \ Cloud \ Firestore \ Admin \ V1Methods
createIndex
Parameters | |
---|---|
Name | Description |
parent |
mixed
|
index |
mixed
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
Google\LongRunning\Operation |
exportDocuments
Parameters | |
---|---|
Name | Description |
name |
mixed
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
Google\LongRunning\Operation |
importDocuments
Parameters | |
---|---|
Name | Description |
name |
mixed
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
Google\LongRunning\Operation |
updateField
Parameters | |
---|---|
Name | Description |
field |
mixed
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
Google\LongRunning\Operation |
__construct
Constructor.
Parameters | |
---|---|
Name | Description |
options |
array
Optional. Options for configuring the service API wrapper. |
↳ apiEndpoint |
string
The address of the API remote host. May optionally include the port, formatted as "
|
↳ credentials |
string|array|FetchAuthTokenInterface|CredentialsWrapper
The credentials to be used by the client to authorize API calls. This option accepts either a path to a credentials file, or a decoded credentials file as a PHP array. Advanced usage: In addition, this option can also accept a pre-constructed Google\Auth\FetchAuthTokenInterface object or Google\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored. |
↳ credentialsConfig |
array
Options used to configure credentials, including auth token caching, for the client. For a full list of supporting configuration options, see Google\ApiCore\CredentialsWrapper::build() . |
↳ disableRetries |
bool
Determines whether or not retries defined by the client configuration should be disabled. Defaults to |
↳ clientConfig |
string|array
Client method configuration, including retry settings. This option can be either a path to a JSON file, or a PHP array containing the decoded JSON data. By default this settings points to the default client config file, which is provided in the resources folder. |
↳ transport |
string|TransportInterface
The transport used for executing network requests. May be either the string |
↳ transportConfig |
array
Configuration options that will be used to construct the transport. Options for each supported transport type should be passed in a key for that transport. For example: $transportConfig = [ 'grpc' => [...], 'rest' => [...], ]; See the Google\ApiCore\Transport\GrpcTransport::build() and Google\ApiCore\Transport\RestTransport::build() methods for the supported options. |
↳ clientCertSource |
callable
A callable which returns the client cert as a string. This can be used to provide a certificate and private key to the transport layer for mTLS. |
createDatabase
Create a database.
Sample code:
$firestoreAdminClient = new FirestoreAdminClient();
try {
$formattedParent = $firestoreAdminClient->projectName('[PROJECT]');
$database = new Database();
$databaseId = 'database_id';
$operationResponse = $firestoreAdminClient->createDatabase($formattedParent, $database, $databaseId);
$operationResponse->pollUntilComplete();
if ($operationResponse->operationSucceeded()) {
$result = $operationResponse->getResult();
// doSomethingWith($result)
} else {
$error = $operationResponse->getError();
// handleError($error)
}
// Alternatively:
// start the operation, keep the operation name, and resume later
$operationResponse = $firestoreAdminClient->createDatabase($formattedParent, $database, $databaseId);
$operationName = $operationResponse->getName();
// ... do other work
$newOperationResponse = $firestoreAdminClient->resumeOperation($operationName, 'createDatabase');
while (!$newOperationResponse->isDone()) {
// ... do other work
$newOperationResponse->reload();
}
if ($newOperationResponse->operationSucceeded()) {
$result = $newOperationResponse->getResult();
// doSomethingWith($result)
} else {
$error = $newOperationResponse->getError();
// handleError($error)
}
} finally {
$firestoreAdminClient->close();
}
Parameters | |
---|---|
Name | Description |
parent |
string
Required. A parent name of the form
|
database |
Google\Cloud\Firestore\Admin\V1\Database
Required. The Database to create. |
databaseId |
string
Required. The ID to use for the database, which will become the final component of the database's resource name. The value must be set to "(default)". |
optionalArgs |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\ApiCore\OperationResponse |
createIndexLRO
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.
Sample code:
$firestoreAdminClient = new FirestoreAdminClient();
try {
$formattedParent = $firestoreAdminClient->collectionGroupName('[PROJECT]', '[DATABASE]', '[COLLECTION]');
$index = new Index();
$operationResponse = $firestoreAdminClient->createIndexLRO($formattedParent, $index);
$operationResponse->pollUntilComplete();
if ($operationResponse->operationSucceeded()) {
$result = $operationResponse->getResult();
// doSomethingWith($result)
} else {
$error = $operationResponse->getError();
// handleError($error)
}
// Alternatively:
// start the operation, keep the operation name, and resume later
$operationResponse = $firestoreAdminClient->createIndexLRO($formattedParent, $index);
$operationName = $operationResponse->getName();
// ... do other work
$newOperationResponse = $firestoreAdminClient->resumeOperation($operationName, 'createIndex');
while (!$newOperationResponse->isDone()) {
// ... do other work
$newOperationResponse->reload();
}
if ($newOperationResponse->operationSucceeded()) {
$result = $newOperationResponse->getResult();
// doSomethingWith($result)
} else {
$error = $newOperationResponse->getError();
// handleError($error)
}
} finally {
$firestoreAdminClient->close();
}
Parameters | |
---|---|
Name | Description |
parent |
string
Required. A parent name of the form
|
index |
Google\Cloud\Firestore\Admin\V1\Index
Required. The composite index to create. |
optionalArgs |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\ApiCore\OperationResponse |
deleteIndex
Deletes a composite index.
Sample code:
$firestoreAdminClient = new FirestoreAdminClient();
try {
$formattedName = $firestoreAdminClient->indexName('[PROJECT]', '[DATABASE]', '[COLLECTION]', '[INDEX]');
$firestoreAdminClient->deleteIndex($formattedName);
} finally {
$firestoreAdminClient->close();
}
Parameters | |
---|---|
Name | Description |
name |
string
Required. A name of the form
|
optionalArgs |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
exportDocumentsLRO
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
Sample code:
$firestoreAdminClient = new FirestoreAdminClient();
try {
$formattedName = $firestoreAdminClient->databaseName('[PROJECT]', '[DATABASE]');
$operationResponse = $firestoreAdminClient->exportDocumentsLRO($formattedName);
$operationResponse->pollUntilComplete();
if ($operationResponse->operationSucceeded()) {
$result = $operationResponse->getResult();
// doSomethingWith($result)
} else {
$error = $operationResponse->getError();
// handleError($error)
}
// Alternatively:
// start the operation, keep the operation name, and resume later
$operationResponse = $firestoreAdminClient->exportDocumentsLRO($formattedName);
$operationName = $operationResponse->getName();
// ... do other work
$newOperationResponse = $firestoreAdminClient->resumeOperation($operationName, 'exportDocuments');
while (!$newOperationResponse->isDone()) {
// ... do other work
$newOperationResponse->reload();
}
if ($newOperationResponse->operationSucceeded()) {
$result = $newOperationResponse->getResult();
// doSomethingWith($result)
} else {
$error = $newOperationResponse->getError();
// handleError($error)
}
} finally {
$firestoreAdminClient->close();
}
Parameters | |
---|---|
Name | Description |
name |
string
Required. Database to export. Should be of the form:
|
optionalArgs |
array
Optional. |
↳ collectionIds |
string[]
Which collection ids to export. Unspecified means all collections. |
↳ outputUriPrefix |
string
The output URI. Currently only supports Google Cloud Storage URIs of the form: |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\ApiCore\OperationResponse |
getDatabase
Gets information about a database.
Sample code:
$firestoreAdminClient = new FirestoreAdminClient();
try {
$formattedName = $firestoreAdminClient->databaseName('[PROJECT]', '[DATABASE]');
$response = $firestoreAdminClient->getDatabase($formattedName);
} finally {
$firestoreAdminClient->close();
}
Parameters | |
---|---|
Name | Description |
name |
string
Required. A name of the form
|
optionalArgs |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\Cloud\Firestore\Admin\V1\Database |
getField
Gets the metadata and configuration for a Field.
Sample code:
$firestoreAdminClient = new FirestoreAdminClient();
try {
$formattedName = $firestoreAdminClient->fieldName('[PROJECT]', '[DATABASE]', '[COLLECTION]', '[FIELD]');
$response = $firestoreAdminClient->getField($formattedName);
} finally {
$firestoreAdminClient->close();
}
Parameters | |
---|---|
Name | Description |
name |
string
Required. A name of the form
|
optionalArgs |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\Cloud\Firestore\Admin\V1\Field |
getIndex
Gets a composite index.
Sample code:
$firestoreAdminClient = new FirestoreAdminClient();
try {
$formattedName = $firestoreAdminClient->indexName('[PROJECT]', '[DATABASE]', '[COLLECTION]', '[INDEX]');
$response = $firestoreAdminClient->getIndex($formattedName);
} finally {
$firestoreAdminClient->close();
}
Parameters | |
---|---|
Name | Description |
name |
string
Required. A name of the form
|
optionalArgs |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\Cloud\Firestore\Admin\V1\Index |
importDocumentsLRO
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.
Sample code:
$firestoreAdminClient = new FirestoreAdminClient();
try {
$formattedName = $firestoreAdminClient->databaseName('[PROJECT]', '[DATABASE]');
$operationResponse = $firestoreAdminClient->importDocumentsLRO($formattedName);
$operationResponse->pollUntilComplete();
if ($operationResponse->operationSucceeded()) {
// operation succeeded and returns no value
} else {
$error = $operationResponse->getError();
// handleError($error)
}
// Alternatively:
// start the operation, keep the operation name, and resume later
$operationResponse = $firestoreAdminClient->importDocumentsLRO($formattedName);
$operationName = $operationResponse->getName();
// ... do other work
$newOperationResponse = $firestoreAdminClient->resumeOperation($operationName, 'importDocuments');
while (!$newOperationResponse->isDone()) {
// ... do other work
$newOperationResponse->reload();
}
if ($newOperationResponse->operationSucceeded()) {
// operation succeeded and returns no value
} else {
$error = $newOperationResponse->getError();
// handleError($error)
}
} finally {
$firestoreAdminClient->close();
}
Parameters | |
---|---|
Name | Description |
name |
string
Required. Database to import into. Should be of the form:
|
optionalArgs |
array
Optional. |
↳ collectionIds |
string[]
Which collection ids to import. Unspecified means all collections included in the import. |
↳ inputUriPrefix |
string
Location of the exported files. This must match the output_uri_prefix of an ExportDocumentsResponse from an export that has completed successfully. See: google.firestore.admin.v1.ExportDocumentsResponse.output_uri_prefix. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\ApiCore\OperationResponse |
listDatabases
List all the databases in the project.
Sample code:
$firestoreAdminClient = new FirestoreAdminClient();
try {
$formattedParent = $firestoreAdminClient->projectName('[PROJECT]');
$response = $firestoreAdminClient->listDatabases($formattedParent);
} finally {
$firestoreAdminClient->close();
}
Parameters | |
---|---|
Name | Description |
parent |
string
Required. A parent name of the form
|
optionalArgs |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\Cloud\Firestore\Admin\V1\ListDatabasesResponse |
listFields
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
.
Sample code:
$firestoreAdminClient = new FirestoreAdminClient();
try {
$formattedParent = $firestoreAdminClient->collectionGroupName('[PROJECT]', '[DATABASE]', '[COLLECTION]');
// Iterate over pages of elements
$pagedResponse = $firestoreAdminClient->listFields($formattedParent);
foreach ($pagedResponse->iteratePages() as $page) {
foreach ($page as $element) {
// doSomethingWith($element);
}
}
// Alternatively:
// Iterate through all elements
$pagedResponse = $firestoreAdminClient->listFields($formattedParent);
foreach ($pagedResponse->iterateAllElements() as $element) {
// doSomethingWith($element);
}
} finally {
$firestoreAdminClient->close();
}
Parameters | |
---|---|
Name | Description |
parent |
string
Required. A parent name of the form
|
optionalArgs |
array
Optional. |
↳ 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 a filter that includes |
↳ pageSize |
int
The maximum number of resources contained in the underlying API response. The API may return fewer values in a page, even if there are additional values to be retrieved. |
↳ pageToken |
string
A page token is used to specify a page of values to be returned. If no page token is specified (the default), the first page of values will be returned. Any page token used here must have been generated by a previous call to the API. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\ApiCore\PagedListResponse |
listIndexes
Lists composite indexes.
Sample code:
$firestoreAdminClient = new FirestoreAdminClient();
try {
$formattedParent = $firestoreAdminClient->collectionGroupName('[PROJECT]', '[DATABASE]', '[COLLECTION]');
// Iterate over pages of elements
$pagedResponse = $firestoreAdminClient->listIndexes($formattedParent);
foreach ($pagedResponse->iteratePages() as $page) {
foreach ($page as $element) {
// doSomethingWith($element);
}
}
// Alternatively:
// Iterate through all elements
$pagedResponse = $firestoreAdminClient->listIndexes($formattedParent);
foreach ($pagedResponse->iterateAllElements() as $element) {
// doSomethingWith($element);
}
} finally {
$firestoreAdminClient->close();
}
Parameters | |
---|---|
Name | Description |
parent |
string
Required. A parent name of the form
|
optionalArgs |
array
Optional. |
↳ filter |
string
The filter to apply to list results. |
↳ pageSize |
int
The maximum number of resources contained in the underlying API response. The API may return fewer values in a page, even if there are additional values to be retrieved. |
↳ pageToken |
string
A page token is used to specify a page of values to be returned. If no page token is specified (the default), the first page of values will be returned. Any page token used here must have been generated by a previous call to the API. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\ApiCore\PagedListResponse |
updateDatabase
Updates a database.
Sample code:
$firestoreAdminClient = new FirestoreAdminClient();
try {
$database = new Database();
$operationResponse = $firestoreAdminClient->updateDatabase($database);
$operationResponse->pollUntilComplete();
if ($operationResponse->operationSucceeded()) {
$result = $operationResponse->getResult();
// doSomethingWith($result)
} else {
$error = $operationResponse->getError();
// handleError($error)
}
// Alternatively:
// start the operation, keep the operation name, and resume later
$operationResponse = $firestoreAdminClient->updateDatabase($database);
$operationName = $operationResponse->getName();
// ... do other work
$newOperationResponse = $firestoreAdminClient->resumeOperation($operationName, 'updateDatabase');
while (!$newOperationResponse->isDone()) {
// ... do other work
$newOperationResponse->reload();
}
if ($newOperationResponse->operationSucceeded()) {
$result = $newOperationResponse->getResult();
// doSomethingWith($result)
} else {
$error = $newOperationResponse->getError();
// handleError($error)
}
} finally {
$firestoreAdminClient->close();
}
Parameters | |
---|---|
Name | Description |
database |
Google\Cloud\Firestore\Admin\V1\Database
Required. The database to update. |
optionalArgs |
array
Optional. |
↳ updateMask |
FieldMask
The list of fields to be updated. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\ApiCore\OperationResponse |
updateFieldLRO
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/*
.
Sample code:
$firestoreAdminClient = new FirestoreAdminClient();
try {
$field = new Field();
$operationResponse = $firestoreAdminClient->updateFieldLRO($field);
$operationResponse->pollUntilComplete();
if ($operationResponse->operationSucceeded()) {
$result = $operationResponse->getResult();
// doSomethingWith($result)
} else {
$error = $operationResponse->getError();
// handleError($error)
}
// Alternatively:
// start the operation, keep the operation name, and resume later
$operationResponse = $firestoreAdminClient->updateFieldLRO($field);
$operationName = $operationResponse->getName();
// ... do other work
$newOperationResponse = $firestoreAdminClient->resumeOperation($operationName, 'updateField');
while (!$newOperationResponse->isDone()) {
// ... do other work
$newOperationResponse->reload();
}
if ($newOperationResponse->operationSucceeded()) {
$result = $newOperationResponse->getResult();
// doSomethingWith($result)
} else {
$error = $newOperationResponse->getError();
// handleError($error)
}
} finally {
$firestoreAdminClient->close();
}
Parameters | |
---|---|
Name | Description |
field |
Google\Cloud\Firestore\Admin\V1\Field
Required. The field to be updated. |
optionalArgs |
array
Optional. |
↳ updateMask |
FieldMask
A mask, relative to the field. If specified, only configuration specified by this field_mask will be updated in the field. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\ApiCore\OperationResponse |
getOperationsClient
Return an OperationsClient object with the same endpoint as $this.
Returns | |
---|---|
Type | Description |
Google\ApiCore\LongRunning\OperationsClient |
resumeOperation
Resume an existing long running operation that was previously started by a long running API method. If $methodName is not provided, or does not match a long running API method, then the operation can still be resumed, but the OperationResponse object will not deserialize the final response.
Parameters | |
---|---|
Name | Description |
operationName |
string
The name of the long running operation |
methodName |
string
The name of the method used to start the operation |
Returns | |
---|---|
Type | Description |
Google\ApiCore\OperationResponse |
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. |
static::collectionGroupName
Formats a string containing the fully-qualified path to represent a collection_group resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
database |
string
|
collection |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted collection_group resource. |
static::databaseName
Formats a string containing the fully-qualified path to represent a database resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
database |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted database resource. |
static::fieldName
Formats a string containing the fully-qualified path to represent a field resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
database |
string
|
collection |
string
|
field |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted field resource. |
static::indexName
Formats a string containing the fully-qualified path to represent a index resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
database |
string
|
collection |
string
|
index |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted index resource. |
static::projectName
Formats a string containing the fully-qualified path to represent a project resource.
Parameter | |
---|---|
Name | Description |
project |
string
|
Returns | |
---|---|
Type | Description |
string | The formatted project resource. |
static::parseName
Parses a formatted name string and returns an associative array of the components in the name.
The following name formats are supported: Template: Pattern
- collectionGroup: projects/{project}/databases/{database}/collectionGroups/{collection}
- database: projects/{project}/databases/{database}
- field: projects/{project}/databases/{database}/collectionGroups/{collection}/fields/{field}
- index: projects/{project}/databases/{database}/collectionGroups/{collection}/indexes/{index}
- project: projects/{project}
The optional $template argument can be supplied to specify a particular pattern, and must match one of the templates listed above. If no $template argument is provided, or if the $template argument does not match one of the templates listed, then parseName will check each of the supported templates, and return the first match.
Parameters | |
---|---|
Name | Description |
formattedName |
string
The formatted name string |
template |
string
Optional name of template to match |
Returns | |
---|---|
Type | Description |
array | An associative array from name component IDs to component values. |
Constants
SERVICE_NAME
Value: 'google.firestore.admin.v1.FirestoreAdmin'
The name of the service.
SERVICE_ADDRESS
Value: 'firestore.googleapis.com'
The default address of the service.
DEFAULT_SERVICE_PORT
Value: 443
The default port of the service.
CODEGEN_NAME
Value: 'gapic'
The name of the code generator, to be included in the agent header.