Reference documentation and code samples for the Cloud Spanner Database Admin V1 API class Google::Cloud::Spanner::Admin::Database::V1::CopyBackupRequest.
The request for CopyBackup.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#backup_id
def backup_id() -> ::String
Returns
-
(::String) — Required. The id of the backup copy.
The
backup_id
appended toparent
forms the full backup_uri of the formprojects/<project>/instances/<instance>/backups/<backup>
.
#backup_id=
def backup_id=(value) -> ::String
Parameter
-
value (::String) — Required. The id of the backup copy.
The
backup_id
appended toparent
forms the full backup_uri of the formprojects/<project>/instances/<instance>/backups/<backup>
.
Returns
-
(::String) — Required. The id of the backup copy.
The
backup_id
appended toparent
forms the full backup_uri of the formprojects/<project>/instances/<instance>/backups/<backup>
.
#encryption_config
def encryption_config() -> ::Google::Cloud::Spanner::Admin::Database::V1::CopyBackupEncryptionConfig
Returns
-
(::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
.
#encryption_config=
def encryption_config=(value) -> ::Google::Cloud::Spanner::Admin::Database::V1::CopyBackupEncryptionConfig
Parameter
-
value (::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
.
Returns
-
(::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
.
#expire_time
def expire_time() -> ::Google::Protobuf::Timestamp
Returns
-
(::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 theexpire_time
has passed, the backup is eligible to be automatically deleted by Cloud Spanner to free the resources used by the backup.
#expire_time=
def expire_time=(value) -> ::Google::Protobuf::Timestamp
Parameter
-
value (::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 theexpire_time
has passed, the backup is eligible to be automatically deleted by Cloud Spanner to free the resources used by the backup.
Returns
-
(::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 theexpire_time
has passed, the backup is eligible to be automatically deleted by Cloud Spanner to free the resources used by the backup.
#parent
def parent() -> ::String
Returns
-
(::String) — Required. The name of the destination instance that will contain the backup copy.
Values are of the form:
projects/<project>/instances/<instance>
.
#parent=
def parent=(value) -> ::String
Parameter
-
value (::String) — Required. The name of the destination instance that will contain the backup copy.
Values are of the form:
projects/<project>/instances/<instance>
.
Returns
-
(::String) — Required. The name of the destination instance that will contain the backup copy.
Values are of the form:
projects/<project>/instances/<instance>
.
#source_backup
def source_backup() -> ::String
Returns
-
(::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>
.
#source_backup=
def source_backup=(value) -> ::String
Parameter
-
value (::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>
.
Returns
-
(::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>
.