Reference documentation and code samples for the Cloud Spanner V1 Client class RestoreDatabaseRequest.
The request for
RestoreDatabase.
Generated from protobuf message google.spanner.admin.database.v1.RestoreDatabaseRequest
Namespace
Google \ Cloud \ Spanner \ Admin \ Database \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ parent
string
Required. The name of the instance in which to create the restored database. This instance must be in the same project and have the same instance configuration as the instance containing the source backup. Values are of the form projects/<project>/instances/<instance>.
↳ database_id
string
Required. The id of the database to create and restore to. This database must not already exist. The database_id appended to parent forms the full database name of the form projects/<project>/instances/<instance>/databases/<database_id>.
↳ backup
string
Name of the backup from which to restore. Values are of the form projects/<project>/instances/<instance>/backups/<backup>.
Optional. An encryption configuration describing the encryption type and key resources in Cloud KMS used to encrypt/decrypt the database to restore to. If this field is not specified, the restored database will use the same encryption configuration as the backup by default, namely encryption_type = USE_CONFIG_DEFAULT_OR_BACKUP_ENCRYPTION.
getParent
Required. The name of the instance in which to create the
restored database. This instance must be in the same project and
have the same instance configuration as the instance containing
the source backup. Values are of the form
projects/<project>/instances/<instance>.
Returns
Type
Description
string
setParent
Required. The name of the instance in which to create the
restored database. This instance must be in the same project and
have the same instance configuration as the instance containing
the source backup. Values are of the form
projects/<project>/instances/<instance>.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getDatabaseId
Required. The id of the database to create and restore to. This
database must not already exist. The database_id appended to
parent forms the full database name of the form
projects/<project>/instances/<instance>/databases/<database_id>.
Returns
Type
Description
string
setDatabaseId
Required. The id of the database to create and restore to. This
database must not already exist. The database_id appended to
parent forms the full database name of the form
projects/<project>/instances/<instance>/databases/<database_id>.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getBackup
Name of the backup from which to restore. Values are of the form
projects/<project>/instances/<instance>/backups/<backup>.
Returns
Type
Description
string
hasBackup
setBackup
Name of the backup from which to restore. Values are of the form
projects/<project>/instances/<instance>/backups/<backup>.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getEncryptionConfig
Optional. An encryption configuration describing the encryption type and
key resources in Cloud KMS used to encrypt/decrypt the database to restore
to. If this field is not specified, the restored database will use the same
encryption configuration as the backup by default, namely
encryption_type
= USE_CONFIG_DEFAULT_OR_BACKUP_ENCRYPTION.
Optional. An encryption configuration describing the encryption type and
key resources in Cloud KMS used to encrypt/decrypt the database to restore
to. If this field is not specified, the restored database will use the same
encryption configuration as the backup by default, namely
encryption_type
= USE_CONFIG_DEFAULT_OR_BACKUP_ENCRYPTION.
Required. The name of the instance in which to create the
restored database. This instance must be in the same project and
have the same instance configuration as the instance containing
the source backup. Values are of the form
projects/<project>/instances/<instance>. Please see
DatabaseAdminClient::instanceName() for help formatting this field.
databaseId
string
Required. The id of the database to create and restore to. This
database must not already exist. The database_id appended to
parent forms the full database name of the form
projects/<project>/instances/<instance>/databases/<database_id>.
backup
string
Name of the backup from which to restore. Values are of the form
projects/<project>/instances/<instance>/backups/<backup>.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Cloud Spanner V1 Client - Class RestoreDatabaseRequest (1.104.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.104.0 (latest)](/php/docs/reference/cloud-spanner/latest/Admin.Database.V1.RestoreDatabaseRequest)\n- [1.103.0](/php/docs/reference/cloud-spanner/1.103.0/Admin.Database.V1.RestoreDatabaseRequest)\n- [1.102.0](/php/docs/reference/cloud-spanner/1.102.0/Admin.Database.V1.RestoreDatabaseRequest)\n- [1.101.0](/php/docs/reference/cloud-spanner/1.101.0/Admin.Database.V1.RestoreDatabaseRequest)\n- [1.100.0](/php/docs/reference/cloud-spanner/1.100.0/Admin.Database.V1.RestoreDatabaseRequest)\n- [1.98.0](/php/docs/reference/cloud-spanner/1.98.0/Admin.Database.V1.RestoreDatabaseRequest)\n- [1.97.0](/php/docs/reference/cloud-spanner/1.97.0/Admin.Database.V1.RestoreDatabaseRequest)\n- [1.96.0](/php/docs/reference/cloud-spanner/1.96.0/Admin.Database.V1.RestoreDatabaseRequest)\n- [1.95.0](/php/docs/reference/cloud-spanner/1.95.0/Admin.Database.V1.RestoreDatabaseRequest)\n- [1.94.0](/php/docs/reference/cloud-spanner/1.94.0/Admin.Database.V1.RestoreDatabaseRequest)\n- [1.93.1](/php/docs/reference/cloud-spanner/1.93.1/Admin.Database.V1.RestoreDatabaseRequest)\n- [1.92.1](/php/docs/reference/cloud-spanner/1.92.1/Admin.Database.V1.RestoreDatabaseRequest)\n- [1.91.0](/php/docs/reference/cloud-spanner/1.91.0/Admin.Database.V1.RestoreDatabaseRequest)\n- [1.90.0](/php/docs/reference/cloud-spanner/1.90.0/Admin.Database.V1.RestoreDatabaseRequest)\n- [1.89.0](/php/docs/reference/cloud-spanner/1.89.0/Admin.Database.V1.RestoreDatabaseRequest)\n- [1.88.0](/php/docs/reference/cloud-spanner/1.88.0/Admin.Database.V1.RestoreDatabaseRequest)\n- [1.87.0](/php/docs/reference/cloud-spanner/1.87.0/Admin.Database.V1.RestoreDatabaseRequest)\n- [1.86.0](/php/docs/reference/cloud-spanner/1.86.0/Admin.Database.V1.RestoreDatabaseRequest)\n- [1.85.0](/php/docs/reference/cloud-spanner/1.85.0/Admin.Database.V1.RestoreDatabaseRequest)\n- [1.84.0](/php/docs/reference/cloud-spanner/1.84.0/Admin.Database.V1.RestoreDatabaseRequest)\n- [1.83.0](/php/docs/reference/cloud-spanner/1.83.0/Admin.Database.V1.RestoreDatabaseRequest)\n- [1.82.0](/php/docs/reference/cloud-spanner/1.82.0/Admin.Database.V1.RestoreDatabaseRequest)\n- [1.81.0](/php/docs/reference/cloud-spanner/1.81.0/Admin.Database.V1.RestoreDatabaseRequest)\n- [1.80.0](/php/docs/reference/cloud-spanner/1.80.0/Admin.Database.V1.RestoreDatabaseRequest)\n- [1.79.0](/php/docs/reference/cloud-spanner/1.79.0/Admin.Database.V1.RestoreDatabaseRequest)\n- [1.78.0](/php/docs/reference/cloud-spanner/1.78.0/Admin.Database.V1.RestoreDatabaseRequest)\n- [1.77.0](/php/docs/reference/cloud-spanner/1.77.0/Admin.Database.V1.RestoreDatabaseRequest)\n- [1.76.1](/php/docs/reference/cloud-spanner/1.76.1/Admin.Database.V1.RestoreDatabaseRequest)\n- [1.68.0](/php/docs/reference/cloud-spanner/1.68.0/Admin.Database.V1.RestoreDatabaseRequest)\n- [1.67.0](/php/docs/reference/cloud-spanner/1.67.0/Admin.Database.V1.RestoreDatabaseRequest)\n- [1.66.0](/php/docs/reference/cloud-spanner/1.66.0/Admin.Database.V1.RestoreDatabaseRequest)\n- [1.65.0](/php/docs/reference/cloud-spanner/1.65.0/Admin.Database.V1.RestoreDatabaseRequest)\n- [1.64.0](/php/docs/reference/cloud-spanner/1.64.0/Admin.Database.V1.RestoreDatabaseRequest)\n- [1.63.2](/php/docs/reference/cloud-spanner/1.63.2/Admin.Database.V1.RestoreDatabaseRequest)\n- [1.62.1](/php/docs/reference/cloud-spanner/1.62.1/Admin.Database.V1.RestoreDatabaseRequest)\n- [1.61.0](/php/docs/reference/cloud-spanner/1.61.0/Admin.Database.V1.RestoreDatabaseRequest)\n- [1.60.0](/php/docs/reference/cloud-spanner/1.60.0/Admin.Database.V1.RestoreDatabaseRequest)\n- [1.59.0](/php/docs/reference/cloud-spanner/1.59.0/Admin.Database.V1.RestoreDatabaseRequest)\n- [1.58.4](/php/docs/reference/cloud-spanner/1.58.4/Admin.Database.V1.RestoreDatabaseRequest)\n- [1.57.0](/php/docs/reference/cloud-spanner/1.57.0/Admin.Database.V1.RestoreDatabaseRequest)\n- [1.56.0](/php/docs/reference/cloud-spanner/1.56.0/Admin.Database.V1.RestoreDatabaseRequest)\n- [1.55.0](/php/docs/reference/cloud-spanner/1.55.0/Admin.Database.V1.RestoreDatabaseRequest)\n- [1.54.2](/php/docs/reference/cloud-spanner/1.54.2/Admin.Database.V1.RestoreDatabaseRequest) \nReference documentation and code samples for the Cloud Spanner V1 Client class RestoreDatabaseRequest.\n\nThe request for\nRestoreDatabase.\n\nGenerated from protobuf message `google.spanner.admin.database.v1.RestoreDatabaseRequest`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Spanner \\\\ Admin \\\\ Database \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getParent\n\nRequired. The name of the instance in which to create the\nrestored database. This instance must be in the same project and\nhave the same instance configuration as the instance containing\nthe source backup. Values are of the form\n`projects/\u003cproject\u003e/instances/\u003cinstance\u003e`.\n\n### setParent\n\nRequired. The name of the instance in which to create the\nrestored database. This instance must be in the same project and\nhave the same instance configuration as the instance containing\nthe source backup. Values are of the form\n`projects/\u003cproject\u003e/instances/\u003cinstance\u003e`.\n\n### getDatabaseId\n\nRequired. The id of the database to create and restore to. This\ndatabase must not already exist. The `database_id` appended to\n`parent` forms the full database name of the form\n`projects/\u003cproject\u003e/instances/\u003cinstance\u003e/databases/\u003cdatabase_id\u003e`.\n\n### setDatabaseId\n\nRequired. The id of the database to create and restore to. This\ndatabase must not already exist. The `database_id` appended to\n`parent` forms the full database name of the form\n`projects/\u003cproject\u003e/instances/\u003cinstance\u003e/databases/\u003cdatabase_id\u003e`.\n\n### getBackup\n\nName of the backup from which to restore. Values are of the form\n`projects/\u003cproject\u003e/instances/\u003cinstance\u003e/backups/\u003cbackup\u003e`.\n\n### hasBackup\n\n### setBackup\n\nName of the backup from which to restore. Values are of the form\n`projects/\u003cproject\u003e/instances/\u003cinstance\u003e/backups/\u003cbackup\u003e`.\n\n### getEncryptionConfig\n\nOptional. An encryption configuration describing the encryption type and\nkey resources in Cloud KMS used to encrypt/decrypt the database to restore\nto. If this field is not specified, the restored database will use the same\nencryption configuration as the backup by default, namely\n[encryption_type](/php/docs/reference/cloud-spanner/latest/Admin.Database.V1.RestoreDatabaseEncryptionConfig#_Google_Cloud_Spanner_Admin_Database_V1_RestoreDatabaseEncryptionConfig__getEncryptionType__)\n= `USE_CONFIG_DEFAULT_OR_BACKUP_ENCRYPTION`.\n\n### hasEncryptionConfig\n\n### clearEncryptionConfig\n\n### setEncryptionConfig\n\nOptional. An encryption configuration describing the encryption type and\nkey resources in Cloud KMS used to encrypt/decrypt the database to restore\nto. If this field is not specified, the restored database will use the same\nencryption configuration as the backup by default, namely\n[encryption_type](/php/docs/reference/cloud-spanner/latest/Admin.Database.V1.RestoreDatabaseEncryptionConfig#_Google_Cloud_Spanner_Admin_Database_V1_RestoreDatabaseEncryptionConfig__getEncryptionType__)\n= `USE_CONFIG_DEFAULT_OR_BACKUP_ENCRYPTION`.\n\n### getSource\n\n### static::build"]]
