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
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 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>.
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.
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.
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.
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.
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.
Required. The name of the destination instance that will contain the backup
copy. Values are of the form: projects/<project>/instances/<instance>. Please see
DatabaseAdminClient::instanceName() for help formatting this field.
backupId
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>.
sourceBackup
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>. Please see
DatabaseAdminClient::backupName() for help formatting this field.
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.
[[["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 CopyBackupRequest (1.104.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.104.0 (latest)](/php/docs/reference/cloud-spanner/latest/Admin.Database.V1.CopyBackupRequest)\n- [1.103.0](/php/docs/reference/cloud-spanner/1.103.0/Admin.Database.V1.CopyBackupRequest)\n- [1.102.0](/php/docs/reference/cloud-spanner/1.102.0/Admin.Database.V1.CopyBackupRequest)\n- [1.101.0](/php/docs/reference/cloud-spanner/1.101.0/Admin.Database.V1.CopyBackupRequest)\n- [1.100.0](/php/docs/reference/cloud-spanner/1.100.0/Admin.Database.V1.CopyBackupRequest)\n- [1.98.0](/php/docs/reference/cloud-spanner/1.98.0/Admin.Database.V1.CopyBackupRequest)\n- [1.97.0](/php/docs/reference/cloud-spanner/1.97.0/Admin.Database.V1.CopyBackupRequest)\n- [1.96.0](/php/docs/reference/cloud-spanner/1.96.0/Admin.Database.V1.CopyBackupRequest)\n- [1.95.0](/php/docs/reference/cloud-spanner/1.95.0/Admin.Database.V1.CopyBackupRequest)\n- [1.94.0](/php/docs/reference/cloud-spanner/1.94.0/Admin.Database.V1.CopyBackupRequest)\n- [1.93.1](/php/docs/reference/cloud-spanner/1.93.1/Admin.Database.V1.CopyBackupRequest)\n- [1.92.1](/php/docs/reference/cloud-spanner/1.92.1/Admin.Database.V1.CopyBackupRequest)\n- [1.91.0](/php/docs/reference/cloud-spanner/1.91.0/Admin.Database.V1.CopyBackupRequest)\n- [1.90.0](/php/docs/reference/cloud-spanner/1.90.0/Admin.Database.V1.CopyBackupRequest)\n- [1.89.0](/php/docs/reference/cloud-spanner/1.89.0/Admin.Database.V1.CopyBackupRequest)\n- [1.88.0](/php/docs/reference/cloud-spanner/1.88.0/Admin.Database.V1.CopyBackupRequest)\n- [1.87.0](/php/docs/reference/cloud-spanner/1.87.0/Admin.Database.V1.CopyBackupRequest)\n- [1.86.0](/php/docs/reference/cloud-spanner/1.86.0/Admin.Database.V1.CopyBackupRequest)\n- [1.85.0](/php/docs/reference/cloud-spanner/1.85.0/Admin.Database.V1.CopyBackupRequest)\n- [1.84.0](/php/docs/reference/cloud-spanner/1.84.0/Admin.Database.V1.CopyBackupRequest)\n- [1.83.0](/php/docs/reference/cloud-spanner/1.83.0/Admin.Database.V1.CopyBackupRequest)\n- [1.82.0](/php/docs/reference/cloud-spanner/1.82.0/Admin.Database.V1.CopyBackupRequest)\n- [1.81.0](/php/docs/reference/cloud-spanner/1.81.0/Admin.Database.V1.CopyBackupRequest)\n- [1.80.0](/php/docs/reference/cloud-spanner/1.80.0/Admin.Database.V1.CopyBackupRequest)\n- [1.79.0](/php/docs/reference/cloud-spanner/1.79.0/Admin.Database.V1.CopyBackupRequest)\n- [1.78.0](/php/docs/reference/cloud-spanner/1.78.0/Admin.Database.V1.CopyBackupRequest)\n- [1.77.0](/php/docs/reference/cloud-spanner/1.77.0/Admin.Database.V1.CopyBackupRequest)\n- [1.76.1](/php/docs/reference/cloud-spanner/1.76.1/Admin.Database.V1.CopyBackupRequest)\n- [1.68.0](/php/docs/reference/cloud-spanner/1.68.0/Admin.Database.V1.CopyBackupRequest)\n- [1.67.0](/php/docs/reference/cloud-spanner/1.67.0/Admin.Database.V1.CopyBackupRequest)\n- [1.66.0](/php/docs/reference/cloud-spanner/1.66.0/Admin.Database.V1.CopyBackupRequest)\n- [1.65.0](/php/docs/reference/cloud-spanner/1.65.0/Admin.Database.V1.CopyBackupRequest)\n- [1.64.0](/php/docs/reference/cloud-spanner/1.64.0/Admin.Database.V1.CopyBackupRequest)\n- [1.63.2](/php/docs/reference/cloud-spanner/1.63.2/Admin.Database.V1.CopyBackupRequest)\n- [1.62.1](/php/docs/reference/cloud-spanner/1.62.1/Admin.Database.V1.CopyBackupRequest)\n- [1.61.0](/php/docs/reference/cloud-spanner/1.61.0/Admin.Database.V1.CopyBackupRequest)\n- [1.60.0](/php/docs/reference/cloud-spanner/1.60.0/Admin.Database.V1.CopyBackupRequest)\n- [1.59.0](/php/docs/reference/cloud-spanner/1.59.0/Admin.Database.V1.CopyBackupRequest)\n- [1.58.4](/php/docs/reference/cloud-spanner/1.58.4/Admin.Database.V1.CopyBackupRequest)\n- [1.57.0](/php/docs/reference/cloud-spanner/1.57.0/Admin.Database.V1.CopyBackupRequest)\n- [1.56.0](/php/docs/reference/cloud-spanner/1.56.0/Admin.Database.V1.CopyBackupRequest)\n- [1.55.0](/php/docs/reference/cloud-spanner/1.55.0/Admin.Database.V1.CopyBackupRequest)\n- [1.54.2](/php/docs/reference/cloud-spanner/1.54.2/Admin.Database.V1.CopyBackupRequest) \nReference documentation and code samples for the Cloud Spanner V1 Client class CopyBackupRequest.\n\nThe request for\nCopyBackup.\n\nGenerated from protobuf message `google.spanner.admin.database.v1.CopyBackupRequest`\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 destination instance that will contain the backup\ncopy. Values are of the form: `projects/\u003cproject\u003e/instances/\u003cinstance\u003e`.\n\n### setParent\n\nRequired. The name of the destination instance that will contain the backup\ncopy. Values are of the form: `projects/\u003cproject\u003e/instances/\u003cinstance\u003e`.\n\n### getBackupId\n\nRequired. The id of the backup copy.\n\nThe `backup_id` appended to `parent` forms the full backup_uri of the form\n`projects/\u003cproject\u003e/instances/\u003cinstance\u003e/backups/\u003cbackup\u003e`.\n\n### setBackupId\n\nRequired. The id of the backup copy.\n\nThe `backup_id` appended to `parent` forms the full backup_uri of the form\n`projects/\u003cproject\u003e/instances/\u003cinstance\u003e/backups/\u003cbackup\u003e`.\n\n### getSourceBackup\n\nRequired. The source backup to be copied.\n\nThe source backup needs to be in READY state for it to be copied.\nOnce CopyBackup is in progress, the source backup cannot be deleted or\ncleaned up on expiration until CopyBackup is finished.\nValues are of the form:\n`projects/\u003cproject\u003e/instances/\u003cinstance\u003e/backups/\u003cbackup\u003e`.\n\n### setSourceBackup\n\nRequired. The source backup to be copied.\n\nThe source backup needs to be in READY state for it to be copied.\nOnce CopyBackup is in progress, the source backup cannot be deleted or\ncleaned up on expiration until CopyBackup is finished.\nValues are of the form:\n`projects/\u003cproject\u003e/instances/\u003cinstance\u003e/backups/\u003cbackup\u003e`.\n\n### getExpireTime\n\nRequired. The expiration time of the backup in microsecond granularity.\n\nThe expiration time must be at least 6 hours and at most 366 days\nfrom the `create_time` of the source backup. Once the `expire_time` has\npassed, the backup is eligible to be automatically deleted by Cloud Spanner\nto free the resources used by the backup.\n\n### hasExpireTime\n\n### clearExpireTime\n\n### setExpireTime\n\nRequired. The expiration time of the backup in microsecond granularity.\n\nThe expiration time must be at least 6 hours and at most 366 days\nfrom the `create_time` of the source backup. Once the `expire_time` has\npassed, the backup is eligible to be automatically deleted by Cloud Spanner\nto free the resources used by the backup.\n\n### getEncryptionConfig\n\nOptional. The encryption configuration used to encrypt the backup. If this\nfield is not specified, the backup will use the same encryption\nconfiguration as the source backup by default, namely\n[encryption_type](/php/docs/reference/cloud-spanner/latest/Admin.Database.V1.CopyBackupEncryptionConfig#_Google_Cloud_Spanner_Admin_Database_V1_CopyBackupEncryptionConfig__getEncryptionType__)\n= `USE_CONFIG_DEFAULT_OR_BACKUP_ENCRYPTION`.\n\n### hasEncryptionConfig\n\n### clearEncryptionConfig\n\n### setEncryptionConfig\n\nOptional. The encryption configuration used to encrypt the backup. If this\nfield is not specified, the backup will use the same encryption\nconfiguration as the source backup by default, namely\n[encryption_type](/php/docs/reference/cloud-spanner/latest/Admin.Database.V1.CopyBackupEncryptionConfig#_Google_Cloud_Spanner_Admin_Database_V1_CopyBackupEncryptionConfig__getEncryptionType__)\n= `USE_CONFIG_DEFAULT_OR_BACKUP_ENCRYPTION`.\n\n### static::build"]]
