Cloud Spanner Database Admin V1 API - Class Google::Cloud::Spanner::Admin::Database::V1::CreateBackupRequest (v0.17.0)

Reference documentation and code samples for the Cloud Spanner Database Admin V1 API class Google::Cloud::Spanner::Admin::Database::V1::CreateBackupRequest.

The request for CreateBackup.

Inherits

Object

Extended By

Google::Protobuf::MessageExts::ClassMethods

Includes

Google::Protobuf::MessageExts

Methods

#backup

def backup() -> ::Google::Cloud::Spanner::Admin::Database::V1::Backup

Returns

(::Google::Cloud::Spanner::Admin::Database::V1::Backup) — Required. The backup to create.

#backup=

def backup=(value) -> ::Google::Cloud::Spanner::Admin::Database::V1::Backup

Parameter

value (::Google::Cloud::Spanner::Admin::Database::V1::Backup) — Required. The backup to create.

Returns

(::Google::Cloud::Spanner::Admin::Database::V1::Backup) — Required. The backup to create.

#backup_id

def backup_id() -> ::String

Returns

(::String) — Required. The id of the backup to be created. The backup_id appended to parent forms the full backup name of the form projects/<project>/instances/<instance>/backups/<backup_id>.

#backup_id=

def backup_id=(value) -> ::String

Parameter

value (::String) — Required. The id of the backup to be created. The backup_id appended to parent forms the full backup name of the form projects/<project>/instances/<instance>/backups/<backup_id>.

Returns

(::String) — Required. The id of the backup to be created. The backup_id appended to parent forms the full backup name of the form projects/<project>/instances/<instance>/backups/<backup_id>.

#encryption_config

def encryption_config() -> ::Google::Cloud::Spanner::Admin::Database::V1::CreateBackupEncryptionConfig

Returns

(::Google::Cloud::Spanner::Admin::Database::V1::CreateBackupEncryptionConfig) — 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 database by default, namely encryption_type = USE_DATABASE_ENCRYPTION.

#encryption_config=

def encryption_config=(value) -> ::Google::Cloud::Spanner::Admin::Database::V1::CreateBackupEncryptionConfig

Parameter

value (::Google::Cloud::Spanner::Admin::Database::V1::CreateBackupEncryptionConfig) — 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 database by default, namely encryption_type = USE_DATABASE_ENCRYPTION.

Returns

(::Google::Cloud::Spanner::Admin::Database::V1::CreateBackupEncryptionConfig) — 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 database by default, namely encryption_type = USE_DATABASE_ENCRYPTION.

#parent

def parent() -> ::String

Returns

(::String) — Required. The name of the instance in which the backup will be created. This must be the same instance that contains the database the backup will be created from. The backup will be stored in the location(s) specified in the instance configuration of this instance. Values are of the form projects/<project>/instances/<instance>.

#parent=

def parent=(value) -> ::String

Parameter

value (::String) — Required. The name of the instance in which the backup will be created. This must be the same instance that contains the database the backup will be created from. The backup will be stored in the location(s) specified in the instance configuration of this instance. Values are of the form projects/<project>/instances/<instance>.

Returns

(::String) — Required. The name of the instance in which the backup will be created. This must be the same instance that contains the database the backup will be created from. The backup will be stored in the location(s) specified in the instance configuration of this instance. Values are of the form projects/<project>/instances/<instance>.