Cloud Spanner Database Admin V1 API - Class Google::Cloud::Spanner::Admin::Database::V1::BackupSchedule (v1.1.0)

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

BackupSchedule expresses the automated backup creation specification for a Spanner database. Next ID: 10

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#encryption_config

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

#encryption_config=

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

#full_backup_spec

def full_backup_spec() -> ::Google::Cloud::Spanner::Admin::Database::V1::FullBackupSpec
Returns

#full_backup_spec=

def full_backup_spec=(value) -> ::Google::Cloud::Spanner::Admin::Database::V1::FullBackupSpec
Parameter
Returns

#incremental_backup_spec

def incremental_backup_spec() -> ::Google::Cloud::Spanner::Admin::Database::V1::IncrementalBackupSpec
Returns

#incremental_backup_spec=

def incremental_backup_spec=(value) -> ::Google::Cloud::Spanner::Admin::Database::V1::IncrementalBackupSpec
Parameter
Returns

#name

def name() -> ::String
Returns
  • (::String) — Identifier. Output only for the [CreateBackupSchedule][DatabaseAdmin.CreateBackupSchededule] operation. Required for the UpdateBackupSchedule operation. A globally unique identifier for the backup schedule which cannot be changed. Values are of the form projects/<project>/instances/<instance>/databases/<database>/backupSchedules/[a-z][a-z0-9_\-]*[a-z0-9] The final segment of the name must be between 2 and 60 characters in length.

#name=

def name=(value) -> ::String
Parameter
  • value (::String) — Identifier. Output only for the [CreateBackupSchedule][DatabaseAdmin.CreateBackupSchededule] operation. Required for the UpdateBackupSchedule operation. A globally unique identifier for the backup schedule which cannot be changed. Values are of the form projects/<project>/instances/<instance>/databases/<database>/backupSchedules/[a-z][a-z0-9_\-]*[a-z0-9] The final segment of the name must be between 2 and 60 characters in length.
Returns
  • (::String) — Identifier. Output only for the [CreateBackupSchedule][DatabaseAdmin.CreateBackupSchededule] operation. Required for the UpdateBackupSchedule operation. A globally unique identifier for the backup schedule which cannot be changed. Values are of the form projects/<project>/instances/<instance>/databases/<database>/backupSchedules/[a-z][a-z0-9_\-]*[a-z0-9] The final segment of the name must be between 2 and 60 characters in length.

#retention_duration

def retention_duration() -> ::Google::Protobuf::Duration
Returns
  • (::Google::Protobuf::Duration) — Optional. The retention duration of a backup that must be at least 6 hours and at most 366 days. The backup is eligible to be automatically deleted once the retention period has elapsed.

#retention_duration=

def retention_duration=(value) -> ::Google::Protobuf::Duration
Parameter
  • value (::Google::Protobuf::Duration) — Optional. The retention duration of a backup that must be at least 6 hours and at most 366 days. The backup is eligible to be automatically deleted once the retention period has elapsed.
Returns
  • (::Google::Protobuf::Duration) — Optional. The retention duration of a backup that must be at least 6 hours and at most 366 days. The backup is eligible to be automatically deleted once the retention period has elapsed.

#spec

def spec() -> ::Google::Cloud::Spanner::Admin::Database::V1::BackupScheduleSpec
Returns

#spec=

def spec=(value) -> ::Google::Cloud::Spanner::Admin::Database::V1::BackupScheduleSpec
Parameter
Returns

#update_time

def update_time() -> ::Google::Protobuf::Timestamp
Returns
  • (::Google::Protobuf::Timestamp) — Output only. The timestamp at which the schedule was last updated. If the schedule has never been updated, this field contains the timestamp when the schedule was first created.