Cloud Spanner V1 Client - Class CopyBackupRequest (1.59.0)

Reference documentation and code samples for the Cloud Spanner V1 Client class CopyBackupRequest.

The request for CopyBackup .

Generated from protobuf message google.spanner.admin.database.v1.CopyBackupRequest

Methods

__construct

Constructor.

Parameters
Name
Description
data
array

Optional. Data for populating the Message object.

↳ parent
string

Required. The name of the destination instance that will contain the backup copy. Values are of the form: projects/<project>/instances/<instance> .

↳ backup_id
string

Required. The id of the backup copy. The backup_id appended to parent forms the full backup_uri of the form projects/<project>/instances/<instance>/backups/<backup> .

↳ source_backup
string

Required. The source backup to be copied. The source backup needs to be in READY state for it to be copied. Once CopyBackup is in progress, the source backup cannot be deleted or cleaned up on expiration until CopyBackup is finished. Values are of the form: projects/<project>/instances/<instance>/backups/<backup> .

↳ expire_time
Google\Protobuf\Timestamp

Required. The expiration time of the backup in microsecond granularity. The expiration time must be at least 6 hours and at most 366 days from the create_time of the source backup. Once the expire_time has passed, the backup is eligible to be automatically deleted by Cloud Spanner to free the resources used by the backup.

↳ encryption_config
Google\Cloud\Spanner\Admin\Database\V1\CopyBackupEncryptionConfig

Optional. The encryption configuration used to encrypt the backup. If this field is not specified, the backup will use the same encryption configuration as the source backup by default, namely encryption_type = USE_CONFIG_DEFAULT_OR_BACKUP_ENCRYPTION .

getParent

Required. The name of the destination instance that will contain the backup copy.

Values are of the form: projects/<project>/instances/<instance> .

Returns
Type
Description
string

setParent

Required. The name of the destination instance that will contain the backup copy.

Values are of the form: projects/<project>/instances/<instance> .

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getBackupId

Required. The id of the backup copy.

The backup_id appended to parent forms the full backup_uri of the form projects/<project>/instances/<instance>/backups/<backup> .

Returns
Type
Description
string

setBackupId

Required. The id of the backup copy.

The backup_id appended to parent forms the full backup_uri of the form projects/<project>/instances/<instance>/backups/<backup> .

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getSourceBackup

Required. The source backup to be copied.

The source backup needs to be in READY state for it to be copied. Once CopyBackup is in progress, the source backup cannot be deleted or cleaned up on expiration until CopyBackup is finished. Values are of the form: projects/<project>/instances/<instance>/backups/<backup> .

Returns
Type
Description
string

setSourceBackup

Required. The source backup to be copied.

The source backup needs to be in READY state for it to be copied. Once CopyBackup is in progress, the source backup cannot be deleted or cleaned up on expiration until CopyBackup is finished. Values are of the form: projects/<project>/instances/<instance>/backups/<backup> .

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getExpireTime

Required. The expiration time of the backup in microsecond granularity.

The expiration time must be at least 6 hours and at most 366 days from the create_time of the source backup. Once the expire_time has passed, the backup is eligible to be automatically deleted by Cloud Spanner to free the resources used by the backup.

Returns
Type
Description

hasExpireTime

clearExpireTime

setExpireTime

Required. The expiration time of the backup in microsecond granularity.

The expiration time must be at least 6 hours and at most 366 days from the create_time of the source backup. Once the expire_time has passed, the backup is eligible to be automatically deleted by Cloud Spanner to free the resources used by the backup.

Parameter
Name
Description
Returns
Type
Description
$this

getEncryptionConfig

Optional. The encryption configuration used to encrypt the backup. If this field is not specified, the backup will use the same encryption configuration as the source backup by default, namely encryption_type = USE_CONFIG_DEFAULT_OR_BACKUP_ENCRYPTION .

hasEncryptionConfig

clearEncryptionConfig

setEncryptionConfig

Optional. The encryption configuration used to encrypt the backup. If this field is not specified, the backup will use the same encryption configuration as the source backup by default, namely encryption_type = USE_CONFIG_DEFAULT_OR_BACKUP_ENCRYPTION .

Returns
Type
Description
$this
Design a Mobile Site
View Site in Mobile | Classic
Share by: