public sealed class CopyBackupRequest : IMessage<CopyBackupRequest>, IEquatable<CopyBackupRequest>, IDeepCloneable<CopyBackupRequest>, IBufferMessage, IMessage
Reference documentation and code samples for the Google Cloud Spanner Database Administration v1 API class CopyBackupRequest.
The request for
[CopyBackup][google.spanner.admin.database.v1.DatabaseAdmin.CopyBackup].
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>.
public CopyBackupEncryptionConfig EncryptionConfig { get; set; }
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][google.spanner.admin.database.v1.CopyBackupEncryptionConfig.encryption_type]
= USE_CONFIG_DEFAULT_OR_BACKUP_ENCRYPTION.
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.
public InstanceName ParentAsInstanceName { get; set; }
Google.Cloud.Spanner.Common.V1.InstanceName-typed view over the Parent resource name property.
Property Value
Type
Description
Google.Cloud.Spanner.Common.V1.InstanceName
SourceBackup
public string SourceBackup { get; set; }
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>.
[[["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."],[[["\u003cp\u003eThe \u003ccode\u003eCopyBackupRequest\u003c/code\u003e class is used to initiate a request to copy a backup in the Google Cloud Spanner Database Administration v1 API.\u003c/p\u003e\n"],["\u003cp\u003eThis class supports various versions of the API, with the latest being version 5.0.0-beta05, and has many prior versions also available for use in development.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eCopyBackupRequest\u003c/code\u003e class inherits from the \u003ccode\u003eobject\u003c/code\u003e class and implements several interfaces, including \u003ccode\u003eIMessage\u003c/code\u003e, \u003ccode\u003eIEquatable\u003c/code\u003e, \u003ccode\u003eIDeepCloneable\u003c/code\u003e, and \u003ccode\u003eIBufferMessage\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe class requires several properties to be set, including \u003ccode\u003eBackupId\u003c/code\u003e, \u003ccode\u003eExpireTime\u003c/code\u003e, \u003ccode\u003eParent\u003c/code\u003e, and \u003ccode\u003eSourceBackup\u003c/code\u003e, for a copy operation, with optional \u003ccode\u003eEncryptionConfig\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe CopyBackupRequest has inherited members, such as \u003ccode\u003eGetHashCode()\u003c/code\u003e, \u003ccode\u003eGetType()\u003c/code\u003e, and \u003ccode\u003eToString()\u003c/code\u003e to perform other functions beyond just requesting a copy.\u003c/p\u003e\n"]]],[],null,["# Google Cloud Spanner Database Administration v1 API - Class CopyBackupRequest (5.1.0)\n\nVersion latestkeyboard_arrow_down\n\n- [5.1.0 (latest)](/dotnet/docs/reference/Google.Cloud.Spanner.Admin.Database.V1/latest/Google.Cloud.Spanner.Admin.Database.V1.CopyBackupRequest)\n- [5.0.0](/dotnet/docs/reference/Google.Cloud.Spanner.Admin.Database.V1/5.0.0/Google.Cloud.Spanner.Admin.Database.V1.CopyBackupRequest)\n- [4.6.0](/dotnet/docs/reference/Google.Cloud.Spanner.Admin.Database.V1/4.6.0/Google.Cloud.Spanner.Admin.Database.V1.CopyBackupRequest)\n- [4.5.0](/dotnet/docs/reference/Google.Cloud.Spanner.Admin.Database.V1/4.5.0/Google.Cloud.Spanner.Admin.Database.V1.CopyBackupRequest)\n- [4.4.0](/dotnet/docs/reference/Google.Cloud.Spanner.Admin.Database.V1/4.4.0/Google.Cloud.Spanner.Admin.Database.V1.CopyBackupRequest)\n- [4.3.0](/dotnet/docs/reference/Google.Cloud.Spanner.Admin.Database.V1/4.3.0/Google.Cloud.Spanner.Admin.Database.V1.CopyBackupRequest)\n- [4.2.0](/dotnet/docs/reference/Google.Cloud.Spanner.Admin.Database.V1/4.2.0/Google.Cloud.Spanner.Admin.Database.V1.CopyBackupRequest)\n- [4.1.0](/dotnet/docs/reference/Google.Cloud.Spanner.Admin.Database.V1/4.1.0/Google.Cloud.Spanner.Admin.Database.V1.CopyBackupRequest)\n- [4.0.0](/dotnet/docs/reference/Google.Cloud.Spanner.Admin.Database.V1/4.0.0/Google.Cloud.Spanner.Admin.Database.V1.CopyBackupRequest)\n- [3.15.1](/dotnet/docs/reference/Google.Cloud.Spanner.Admin.Database.V1/3.15.1/Google.Cloud.Spanner.Admin.Database.V1.CopyBackupRequest)\n- [3.14.0](/dotnet/docs/reference/Google.Cloud.Spanner.Admin.Database.V1/3.14.0/Google.Cloud.Spanner.Admin.Database.V1.CopyBackupRequest)\n- [3.13.0](/dotnet/docs/reference/Google.Cloud.Spanner.Admin.Database.V1/3.13.0/Google.Cloud.Spanner.Admin.Database.V1.CopyBackupRequest)\n- [3.12.0](/dotnet/docs/reference/Google.Cloud.Spanner.Admin.Database.V1/3.12.0/Google.Cloud.Spanner.Admin.Database.V1.CopyBackupRequest)\n- [3.11.0](/dotnet/docs/reference/Google.Cloud.Spanner.Admin.Database.V1/3.11.0/Google.Cloud.Spanner.Admin.Database.V1.CopyBackupRequest)\n- [3.10.0](/dotnet/docs/reference/Google.Cloud.Spanner.Admin.Database.V1/3.10.0/Google.Cloud.Spanner.Admin.Database.V1.CopyBackupRequest)\n- [3.9.0](/dotnet/docs/reference/Google.Cloud.Spanner.Admin.Database.V1/3.9.0/Google.Cloud.Spanner.Admin.Database.V1.CopyBackupRequest)\n- [3.8.0](/dotnet/docs/reference/Google.Cloud.Spanner.Admin.Database.V1/3.8.0/Google.Cloud.Spanner.Admin.Database.V1.CopyBackupRequest)\n- [3.7.0](/dotnet/docs/reference/Google.Cloud.Spanner.Admin.Database.V1/3.7.0/Google.Cloud.Spanner.Admin.Database.V1.CopyBackupRequest)\n- [3.6.0](/dotnet/docs/reference/Google.Cloud.Spanner.Admin.Database.V1/3.6.0/Google.Cloud.Spanner.Admin.Database.V1.CopyBackupRequest)\n- [3.5.0](/dotnet/docs/reference/Google.Cloud.Spanner.Admin.Database.V1/3.5.0/Google.Cloud.Spanner.Admin.Database.V1.CopyBackupRequest) \n\n public sealed class CopyBackupRequest : IMessage\u003cCopyBackupRequest\u003e, IEquatable\u003cCopyBackupRequest\u003e, IDeepCloneable\u003cCopyBackupRequest\u003e, IBufferMessage, IMessage\n\nReference documentation and code samples for the Google Cloud Spanner Database Administration v1 API class CopyBackupRequest.\n\nThe request for\n\\[CopyBackup\\]\\[google.spanner.admin.database.v1.DatabaseAdmin.CopyBackup\\]. \n\nInheritance\n-----------\n\n[object](https://learn.microsoft.com/dotnet/api/system.object) \\\u003e CopyBackupRequest \n\nImplements\n----------\n\n[IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage-1.html)[CopyBackupRequest](/dotnet/docs/reference/Google.Cloud.Spanner.Admin.Database.V1/latest/Google.Cloud.Spanner.Admin.Database.V1.CopyBackupRequest), [IEquatable](https://learn.microsoft.com/dotnet/api/system.iequatable-1)[CopyBackupRequest](/dotnet/docs/reference/Google.Cloud.Spanner.Admin.Database.V1/latest/Google.Cloud.Spanner.Admin.Database.V1.CopyBackupRequest), [IDeepCloneable](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IDeepCloneable-1.html)[CopyBackupRequest](/dotnet/docs/reference/Google.Cloud.Spanner.Admin.Database.V1/latest/Google.Cloud.Spanner.Admin.Database.V1.CopyBackupRequest), [IBufferMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IBufferMessage.html), [IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage.html) \n\nInherited Members\n-----------------\n\n[object.GetHashCode()](https://learn.microsoft.com/dotnet/api/system.object.gethashcode) \n[object.GetType()](https://learn.microsoft.com/dotnet/api/system.object.gettype) \n[object.ToString()](https://learn.microsoft.com/dotnet/api/system.object.tostring)\n\nNamespace\n---------\n\n[Google.Cloud.Spanner.Admin.Database.V1](/dotnet/docs/reference/Google.Cloud.Spanner.Admin.Database.V1/latest/Google.Cloud.Spanner.Admin.Database.V1)\n\nAssembly\n--------\n\nGoogle.Cloud.Spanner.Admin.Database.V1.dll\n\nConstructors\n------------\n\n### CopyBackupRequest()\n\n public CopyBackupRequest()\n\n### CopyBackupRequest(CopyBackupRequest)\n\n public CopyBackupRequest(CopyBackupRequest other)\n\nProperties\n----------\n\n### BackupId\n\n public string BackupId { get; set; }\n\nRequired. The id of the backup copy.\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### EncryptionConfig\n\n public CopyBackupEncryptionConfig EncryptionConfig { get; set; }\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\\]\\[google.spanner.admin.database.v1.CopyBackupEncryptionConfig.encryption_type\\]\n= `USE_CONFIG_DEFAULT_OR_BACKUP_ENCRYPTION`.\n\n### ExpireTime\n\n public Timestamp ExpireTime { get; set; }\n\nRequired. The expiration time of the backup in microsecond granularity.\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### Parent\n\n public string Parent { get; set; }\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### ParentAsInstanceName\n\n public InstanceName ParentAsInstanceName { get; set; }\n\nGoogle.Cloud.Spanner.Common.V1.InstanceName-typed view over the [Parent](/dotnet/docs/reference/Google.Cloud.Spanner.Admin.Database.V1/latest/Google.Cloud.Spanner.Admin.Database.V1.CopyBackupRequest#Google_Cloud_Spanner_Admin_Database_V1_CopyBackupRequest_Parent) resource name property.\n\n### SourceBackup\n\n public string SourceBackup { get; set; }\n\nRequired. The source backup to be copied.\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### SourceBackupAsBackupName\n\n public BackupName SourceBackupAsBackupName { get; set; }\n\n[BackupName](/dotnet/docs/reference/Google.Cloud.Spanner.Admin.Database.V1/latest/Google.Cloud.Spanner.Admin.Database.V1.BackupName)-typed view over the [SourceBackup](/dotnet/docs/reference/Google.Cloud.Spanner.Admin.Database.V1/latest/Google.Cloud.Spanner.Admin.Database.V1.CopyBackupRequest#Google_Cloud_Spanner_Admin_Database_V1_CopyBackupRequest_SourceBackup) resource name property."]]
