(::String) — Required. Backup to restore from. Must be from the same project as the
parent.
The restored database will be created in the same location as the source
backup.
Format is: projects/{project_id}/locations/{location}/backups/{backup}
#backup=
defbackup=(value)->::String
Parameter
value (::String) — Required. Backup to restore from. Must be from the same project as the
parent.
The restored database will be created in the same location as the source
backup.
Format is: projects/{project_id}/locations/{location}/backups/{backup}
Returns
(::String) — Required. Backup to restore from. Must be from the same project as the
parent.
The restored database will be created in the same location as the source
backup.
Format is: projects/{project_id}/locations/{location}/backups/{backup}
#database_id
defdatabase_id()->::String
Returns
(::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.
#database_id=
defdatabase_id=(value)->::String
Parameter
value (::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.
Returns
(::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}/.
[[["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 Firestore Admin V1 API - Class Google::Cloud::Firestore::Admin::V1::RestoreDatabaseRequest (v1.7.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.7.0 (latest)](/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-RestoreDatabaseRequest)\n- [1.6.0](/ruby/docs/reference/google-cloud-firestore-admin-v1/1.6.0/Google-Cloud-Firestore-Admin-V1-RestoreDatabaseRequest)\n- [1.5.0](/ruby/docs/reference/google-cloud-firestore-admin-v1/1.5.0/Google-Cloud-Firestore-Admin-V1-RestoreDatabaseRequest)\n- [1.4.1](/ruby/docs/reference/google-cloud-firestore-admin-v1/1.4.1/Google-Cloud-Firestore-Admin-V1-RestoreDatabaseRequest)\n- [1.3.0](/ruby/docs/reference/google-cloud-firestore-admin-v1/1.3.0/Google-Cloud-Firestore-Admin-V1-RestoreDatabaseRequest)\n- [1.2.0](/ruby/docs/reference/google-cloud-firestore-admin-v1/1.2.0/Google-Cloud-Firestore-Admin-V1-RestoreDatabaseRequest)\n- [1.1.0](/ruby/docs/reference/google-cloud-firestore-admin-v1/1.1.0/Google-Cloud-Firestore-Admin-V1-RestoreDatabaseRequest)\n- [1.0.1](/ruby/docs/reference/google-cloud-firestore-admin-v1/1.0.1/Google-Cloud-Firestore-Admin-V1-RestoreDatabaseRequest)\n- [0.18.0](/ruby/docs/reference/google-cloud-firestore-admin-v1/0.18.0/Google-Cloud-Firestore-Admin-V1-RestoreDatabaseRequest)\n- [0.17.1](/ruby/docs/reference/google-cloud-firestore-admin-v1/0.17.1/Google-Cloud-Firestore-Admin-V1-RestoreDatabaseRequest)\n- [0.16.0](/ruby/docs/reference/google-cloud-firestore-admin-v1/0.16.0/Google-Cloud-Firestore-Admin-V1-RestoreDatabaseRequest)\n- [0.15.0](/ruby/docs/reference/google-cloud-firestore-admin-v1/0.15.0/Google-Cloud-Firestore-Admin-V1-RestoreDatabaseRequest)\n- [0.14.3](/ruby/docs/reference/google-cloud-firestore-admin-v1/0.14.3/Google-Cloud-Firestore-Admin-V1-RestoreDatabaseRequest)\n- [0.13.0](/ruby/docs/reference/google-cloud-firestore-admin-v1/0.13.0/Google-Cloud-Firestore-Admin-V1-RestoreDatabaseRequest)\n- [0.12.0](/ruby/docs/reference/google-cloud-firestore-admin-v1/0.12.0/Google-Cloud-Firestore-Admin-V1-RestoreDatabaseRequest)\n- [0.11.0](/ruby/docs/reference/google-cloud-firestore-admin-v1/0.11.0/Google-Cloud-Firestore-Admin-V1-RestoreDatabaseRequest)\n- [0.10.0](/ruby/docs/reference/google-cloud-firestore-admin-v1/0.10.0/Google-Cloud-Firestore-Admin-V1-RestoreDatabaseRequest)\n- [0.9.0](/ruby/docs/reference/google-cloud-firestore-admin-v1/0.9.0/Google-Cloud-Firestore-Admin-V1-RestoreDatabaseRequest)\n- [0.8.0](/ruby/docs/reference/google-cloud-firestore-admin-v1/0.8.0/Google-Cloud-Firestore-Admin-V1-RestoreDatabaseRequest)\n- [0.7.1](/ruby/docs/reference/google-cloud-firestore-admin-v1/0.7.1/Google-Cloud-Firestore-Admin-V1-RestoreDatabaseRequest)\n- [0.6.0](/ruby/docs/reference/google-cloud-firestore-admin-v1/0.6.0/Google-Cloud-Firestore-Admin-V1-RestoreDatabaseRequest)\n- [0.5.0](/ruby/docs/reference/google-cloud-firestore-admin-v1/0.5.0/Google-Cloud-Firestore-Admin-V1-RestoreDatabaseRequest)\n- [0.4.0](/ruby/docs/reference/google-cloud-firestore-admin-v1/0.4.0/Google-Cloud-Firestore-Admin-V1-RestoreDatabaseRequest)\n- [0.3.5](/ruby/docs/reference/google-cloud-firestore-admin-v1/0.3.5/Google-Cloud-Firestore-Admin-V1-RestoreDatabaseRequest) \nReference documentation and code samples for the Cloud Firestore Admin V1 API class Google::Cloud::Firestore::Admin::V1::RestoreDatabaseRequest.\n\nThe request message for\n[FirestoreAdmin.RestoreDatabase](/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-FirestoreAdmin-Client#Google__Cloud__Firestore__Admin__V1__FirestoreAdmin__Client_restore_database_instance_ \"Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client#restore_database (method)\"). \n\nInherits\n--------\n\n- Object \n\nExtended By\n-----------\n\n- Google::Protobuf::MessageExts::ClassMethods \n\nIncludes\n--------\n\n- Google::Protobuf::MessageExts\n\nMethods\n-------\n\n### #backup\n\n def backup() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Required. Backup to restore from. Must be from the same project as the parent.\n\n The restored database will be created in the same location as the source\n backup.\n\n Format is: `projects/{project_id}/locations/{location}/backups/{backup}`\n\n### #backup=\n\n def backup=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- Required. Backup to restore from. Must be from the same project as the parent.\n\n\n The restored database will be created in the same location as the source\n backup.\n\nFormat is: `projects/{project_id}/locations/{location}/backups/{backup}` \n**Returns**\n\n- (::String) --- Required. Backup to restore from. Must be from the same project as the parent.\n\n The restored database will be created in the same location as the source\n backup.\n\n Format is: `projects/{project_id}/locations/{location}/backups/{backup}`\n\n### #database_id\n\n def database_id() -\u003e ::String\n\n**Returns**\n\n- (::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.\n\n This value should be 4-63 characters. Valid characters are /\\[a-z\\]\\[0-9\\]-/\n with first character a letter and the last a letter or a number. Must not\n be UUID-like /\\[0-9a-f\\]{8}(-\\[0-9a-f\\]{4}){3}-\\[0-9a-f\\]{12}/.\n\n \"(default)\" database ID is also valid.\n\n### #database_id=\n\n def database_id=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::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.\n\n\n This value should be 4-63 characters. Valid characters are /\\[a-z\\]\\[0-9\\]-/\n with first character a letter and the last a letter or a number. Must not\n be UUID-like /\\[0-9a-f\\]{8}(-\\[0-9a-f\\]{4}){3}-\\[0-9a-f\\]{12}/.\n\n\"(default)\" database ID is also valid. \n**Returns**\n\n- (::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.\n\n This value should be 4-63 characters. Valid characters are /\\[a-z\\]\\[0-9\\]-/\n with first character a letter and the last a letter or a number. Must not\n be UUID-like /\\[0-9a-f\\]{8}(-\\[0-9a-f\\]{4}){3}-\\[0-9a-f\\]{12}/.\n\n \"(default)\" database ID is also valid.\n\n### #encryption_config\n\n def encryption_config() -\u003e ::Google::Cloud::Firestore::Admin::V1::Database::EncryptionConfig\n\n**Returns**\n\n- ([::Google::Cloud::Firestore::Admin::V1::Database::EncryptionConfig](./Google-Cloud-Firestore-Admin-V1-Database-EncryptionConfig)) --- Optional. Encryption configuration for the restored database.\n\n\n If this field is not specified, the restored database will use\n the same encryption configuration as the backup, namely\n [use_source_encryption](/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-Database-EncryptionConfig#Google__Cloud__Firestore__Admin__V1__Database__EncryptionConfig_use_source_encryption_instance_ \"Google::Cloud::Firestore::Admin::V1::Database::EncryptionConfig#use_source_encryption (method)\").\n\n### #encryption_config=\n\n def encryption_config=(value) -\u003e ::Google::Cloud::Firestore::Admin::V1::Database::EncryptionConfig\n\n**Parameter**\n\n- **value** ([::Google::Cloud::Firestore::Admin::V1::Database::EncryptionConfig](./Google-Cloud-Firestore-Admin-V1-Database-EncryptionConfig)) --- Optional. Encryption configuration for the restored database.\n\n\n If this field is not specified, the restored database will use\n the same encryption configuration as the backup, namely\n[use_source_encryption](/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-Database-EncryptionConfig#Google__Cloud__Firestore__Admin__V1__Database__EncryptionConfig_use_source_encryption_instance_ \"Google::Cloud::Firestore::Admin::V1::Database::EncryptionConfig#use_source_encryption (method)\"). \n**Returns**\n\n- ([::Google::Cloud::Firestore::Admin::V1::Database::EncryptionConfig](./Google-Cloud-Firestore-Admin-V1-Database-EncryptionConfig)) --- Optional. Encryption configuration for the restored database.\n\n\n If this field is not specified, the restored database will use\n the same encryption configuration as the backup, namely\n [use_source_encryption](/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-Database-EncryptionConfig#Google__Cloud__Firestore__Admin__V1__Database__EncryptionConfig_use_source_encryption_instance_ \"Google::Cloud::Firestore::Admin::V1::Database::EncryptionConfig#use_source_encryption (method)\").\n\n### #parent\n\n def parent() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Required. The project to restore the database in. Format is `projects/{project_id}`.\n\n### #parent=\n\n def parent=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- Required. The project to restore the database in. Format is `projects/{project_id}`. \n**Returns**\n\n- (::String) --- Required. The project to restore the database in. Format is `projects/{project_id}`.\n\n### #tags\n\n def tags() -\u003e ::Google::Protobuf::Map{::String =\u003e ::String}\n\n**Returns**\n\n- (::Google::Protobuf::Map{::String =\\\u003e ::String}) --- Optional. Immutable. Tags to be bound to the restored database.\n\n The tags should be provided in the format of\n `tagKeys/{tag_key_id} -\u003e tagValues/{tag_value_id}`.\n\n### #tags=\n\n def tags=(value) -\u003e ::Google::Protobuf::Map{::String =\u003e ::String}\n\n**Parameter**\n\n- **value** (::Google::Protobuf::Map{::String =\\\u003e ::String}) --- Optional. Immutable. Tags to be bound to the restored database.\n\n\n The tags should be provided in the format of\n`tagKeys/{tag_key_id} -\u003e tagValues/{tag_value_id}`. \n**Returns**\n\n- (::Google::Protobuf::Map{::String =\\\u003e ::String}) --- Optional. Immutable. Tags to be bound to the restored database.\n\n The tags should be provided in the format of\n `tagKeys/{tag_key_id} -\u003e tagValues/{tag_value_id}`."]]
