Reference documentation and code samples for the Cloud Firestore V1 Client class RestoreDatabaseRequest.
The request message for FirestoreAdmin.RestoreDatabase.
Generated from protobuf message google.firestore.admin.v1.RestoreDatabaseRequest
Namespace
Google \ Cloud \ Firestore \ Admin \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ parent |
string
Required. The project to restore the database in. Format is |
↳ database_id |
string
Required. The ID to use for the database, which will become the final component of the database's resource name. This database id must not be associated with an existing database. This value should be 4-63 characters. Valid characters are /[a-z][0-9]-/ with first character a letter and the last a letter or a number. Must not be UUID-like /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/. "(default)" database id is also valid. |
↳ backup |
string
Required. Backup to restore from. Must be from the same project as the parent. Format is: |
getParent
Required. The project to restore the database in. Format is
projects/{project_id}.
| Returns | |
|---|---|
| Type | Description |
string |
|
setParent
Required. The project to restore the database in. Format is
projects/{project_id}.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDatabaseId
Required. The ID to use for the database, which will become the final component of the database's resource name. This database id must not be associated with an existing database.
This value should be 4-63 characters. Valid characters are /[a-z][0-9]-/ with first character a letter and the last a letter or a number. Must not be UUID-like /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/. "(default)" database id is also valid.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDatabaseId
Required. The ID to use for the database, which will become the final component of the database's resource name. This database id must not be associated with an existing database.
This value should be 4-63 characters. Valid characters are /[a-z][0-9]-/ with first character a letter and the last a letter or a number. Must not be UUID-like /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/. "(default)" database id is also valid.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getBackup
Required. Backup to restore from. Must be from the same project as the parent.
Format is: projects/{project_id}/locations/{location}/backups/{backup}
| Returns | |
|---|---|
| Type | Description |
string |
|
setBackup
Required. Backup to restore from. Must be from the same project as the parent.
Format is: projects/{project_id}/locations/{location}/backups/{backup}
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|