Cloud Firestore V1 Client - Class RestoreDatabaseRequest (1.46.0)

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 \ V1

Methods

__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 projects/{project_id}.
↳ 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. The restored database will be created in the same location as the source backup. Format is: projects/{project_id}/locations/{location}/backups/{backup}
↳ encryption_config Google\Cloud\Firestore\Admin\V1\Database\EncryptionConfig

Optional. Encryption configuration for the restored database. If this field is not specified, the restored database will use the same encryption configuration as the backup, namely use_source_encryption.

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.

The restored database will be created in the same location as the source backup. 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.

The restored database will be created in the same location as the source backup. Format is: projects/{project_id}/locations/{location}/backups/{backup}

Parameter
Name Description
var string
Returns
Type Description
$this

getEncryptionConfig

Optional. Encryption configuration for the restored database.

If this field is not specified, the restored database will use the same encryption configuration as the backup, namely use_source_encryption.

Returns
Type Description
Google\Cloud\Firestore\Admin\V1\Database\EncryptionConfig|null

hasEncryptionConfig

clearEncryptionConfig

setEncryptionConfig

Optional. Encryption configuration for the restored database.

If this field is not specified, the restored database will use the same encryption configuration as the backup, namely use_source_encryption.

Parameter
Name Description
var Google\Cloud\Firestore\Admin\V1\Database\EncryptionConfig
Returns
Type Description
$this