AlloyDB V1BETA API - Class Google::Cloud::AlloyDB::V1beta::AutomatedBackupPolicy (v0.10.0)

Reference documentation and code samples for the AlloyDB V1BETA API class Google::Cloud::AlloyDB::V1beta::AutomatedBackupPolicy.

Message describing the user-specified automated backup policy.

All fields in the automated backup policy are optional. Defaults for each field are provided if they are not set.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#backup_window

def backup_window() -> ::Google::Protobuf::Duration
Returns
  • (::Google::Protobuf::Duration) — The length of the time window during which a backup can be taken. If a backup does not succeed within this time window, it will be canceled and considered failed.

    The backup window must be at least 5 minutes long. There is no upper bound on the window. If not set, it defaults to 1 hour.

#backup_window=

def backup_window=(value) -> ::Google::Protobuf::Duration
Parameter
  • value (::Google::Protobuf::Duration) — The length of the time window during which a backup can be taken. If a backup does not succeed within this time window, it will be canceled and considered failed.

    The backup window must be at least 5 minutes long. There is no upper bound on the window. If not set, it defaults to 1 hour.

Returns
  • (::Google::Protobuf::Duration) — The length of the time window during which a backup can be taken. If a backup does not succeed within this time window, it will be canceled and considered failed.

    The backup window must be at least 5 minutes long. There is no upper bound on the window. If not set, it defaults to 1 hour.

#enabled

def enabled() -> ::Boolean
Returns
  • (::Boolean) — Whether automated automated backups are enabled. If not set, defaults to true.

#enabled=

def enabled=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Whether automated automated backups are enabled. If not set, defaults to true.
Returns
  • (::Boolean) — Whether automated automated backups are enabled. If not set, defaults to true.

#encryption_config

def encryption_config() -> ::Google::Cloud::AlloyDB::V1beta::EncryptionConfig
Returns
  • (::Google::Cloud::AlloyDB::V1beta::EncryptionConfig) — Optional. The encryption config can be specified to encrypt the backups with a customer-managed encryption key (CMEK). When this field is not specified, the backup will then use default encryption scheme to protect the user data.

#encryption_config=

def encryption_config=(value) -> ::Google::Cloud::AlloyDB::V1beta::EncryptionConfig
Parameter
  • value (::Google::Cloud::AlloyDB::V1beta::EncryptionConfig) — Optional. The encryption config can be specified to encrypt the backups with a customer-managed encryption key (CMEK). When this field is not specified, the backup will then use default encryption scheme to protect the user data.
Returns
  • (::Google::Cloud::AlloyDB::V1beta::EncryptionConfig) — Optional. The encryption config can be specified to encrypt the backups with a customer-managed encryption key (CMEK). When this field is not specified, the backup will then use default encryption scheme to protect the user data.

#labels

def labels() -> ::Google::Protobuf::Map{::String => ::String}
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — Labels to apply to backups created using this configuration.

#labels=

def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
  • value (::Google::Protobuf::Map{::String => ::String}) — Labels to apply to backups created using this configuration.
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — Labels to apply to backups created using this configuration.

#location

def location() -> ::String
Returns
  • (::String) — The location where the backup will be stored. Currently, the only supported option is to store the backup in the same region as the cluster.

    If empty, defaults to the region of the cluster.

#location=

def location=(value) -> ::String
Parameter
  • value (::String) — The location where the backup will be stored. Currently, the only supported option is to store the backup in the same region as the cluster.

    If empty, defaults to the region of the cluster.

Returns
  • (::String) — The location where the backup will be stored. Currently, the only supported option is to store the backup in the same region as the cluster.

    If empty, defaults to the region of the cluster.

#quantity_based_retention

def quantity_based_retention() -> ::Google::Cloud::AlloyDB::V1beta::AutomatedBackupPolicy::QuantityBasedRetention
Returns

#quantity_based_retention=

def quantity_based_retention=(value) -> ::Google::Cloud::AlloyDB::V1beta::AutomatedBackupPolicy::QuantityBasedRetention
Parameter
Returns

#time_based_retention

def time_based_retention() -> ::Google::Cloud::AlloyDB::V1beta::AutomatedBackupPolicy::TimeBasedRetention
Returns

#time_based_retention=

def time_based_retention=(value) -> ::Google::Cloud::AlloyDB::V1beta::AutomatedBackupPolicy::TimeBasedRetention
Parameter
Returns

#weekly_schedule

def weekly_schedule() -> ::Google::Cloud::AlloyDB::V1beta::AutomatedBackupPolicy::WeeklySchedule
Returns

#weekly_schedule=

def weekly_schedule=(value) -> ::Google::Cloud::AlloyDB::V1beta::AutomatedBackupPolicy::WeeklySchedule
Parameter
Returns