Class: Google::Cloud::GkeBackup::V1::BackupPlan::RetentionPolicy

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/gkebackup/v1/backup_plan.rb

Overview

RetentionPolicy defines a Backup retention policy for a BackupPlan.

Instance Attribute Summary collapse

Instance Attribute Details

#backup_delete_lock_days ⇒ ::Integer

Returns Optional. Minimum age for Backups created via this BackupPlan (in days). This field MUST be an integer value between 0-90 (inclusive). A Backup created under this BackupPlan will NOT be deletable until it reaches Backup's (create_time + backup_delete_lock_days). Updating this field of a BackupPlan does NOT affect existing Backups under it. Backups created AFTER a successful update will inherit the new value.

Default: 0 (no delete blocking).

Returns:

  • (::Integer) —

    Optional. Minimum age for Backups created via this BackupPlan (in days). This field MUST be an integer value between 0-90 (inclusive). A Backup created under this BackupPlan will NOT be deletable until it reaches Backup's (create_time + backup_delete_lock_days). Updating this field of a BackupPlan does NOT affect existing Backups under it. Backups created AFTER a successful update will inherit the new value.

    Default: 0 (no delete blocking)



150
151
152
153
 
# File 'proto_docs/google/cloud/gkebackup/v1/backup_plan.rb', line 150

class RetentionPolicy
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#backup_retain_days ⇒ ::Integer

Returns Optional. The default maximum age of a Backup created via this BackupPlan. This field MUST be an integer value >= 0 and <= 365. If specified, a Backup created under this BackupPlan will be automatically deleted after its age reaches (create_time + backup_retain_days). If not specified, Backups created under this BackupPlan will NOT be subject to automatic deletion. Updating this field does NOT affect existing Backups under it. Backups created AFTER a successful update will automatically pick up the new value. NOTE: backup_retain_days must be >= backup_delete_lock_days. If cron_schedule is defined, then this must be <= 360 * the creation interval. If rpo_config is defined, then this must be <= 360 * [target_rpo_minutes][Schedule.rpo_config.target_rpo_minutes] / (1440minutes/day).

Default: 0 (no automatic deletion).

Returns:

  • (::Integer) —

    Optional. The default maximum age of a Backup created via this BackupPlan. This field MUST be an integer value >= 0 and <= 365. If specified, a Backup created under this BackupPlan will be automatically deleted after its age reaches (create_time + backup_retain_days). If not specified, Backups created under this BackupPlan will NOT be subject to automatic deletion. Updating this field does NOT affect existing Backups under it. Backups created AFTER a successful update will automatically pick up the new value. NOTE: backup_retain_days must be >= backup_delete_lock_days. If cron_schedule is defined, then this must be <= 360 * the creation interval. If rpo_config is defined, then this must be <= 360 * [target_rpo_minutes][Schedule.rpo_config.target_rpo_minutes] / (1440minutes/day).

    Default: 0 (no automatic deletion)



150
151
152
153
 
# File 'proto_docs/google/cloud/gkebackup/v1/backup_plan.rb', line 150

class RetentionPolicy
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#locked ⇒ ::Boolean

Returns Optional. This flag denotes whether the retention policy of this BackupPlan is locked. If set to True, no further update is allowed on this policy, including the locked field itself.

Default: False.

Returns:

  • (::Boolean) —

    Optional. This flag denotes whether the retention policy of this BackupPlan is locked. If set to True, no further update is allowed on this policy, including the locked field itself.

    Default: False



150
151
152
153
 
# File 'proto_docs/google/cloud/gkebackup/v1/backup_plan.rb', line 150

class RetentionPolicy
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end