Backup for GKE V1 API - Class Google::Cloud::GkeBackup::V1::BackupPlan::RetentionPolicy (v1.0.0)

Reference documentation and code samples for the Backup for GKE V1 API class Google::Cloud::GkeBackup::V1::BackupPlan::RetentionPolicy.

RetentionPolicy defines a Backup retention policy for a BackupPlan.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#backup_delete_lock_days

def backup_delete_lock_days() -> ::Integer
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)

#backup_delete_lock_days=

def backup_delete_lock_days=(value) -> ::Integer
Parameter
  • value (::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)

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)

#backup_retain_days

def backup_retain_days() -> ::Integer
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)

#backup_retain_days=

def backup_retain_days=(value) -> ::Integer
Parameter
  • value (::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)

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)

#locked

def locked() -> ::Boolean
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

#locked=

def locked=(value) -> ::Boolean
Parameter
  • value (::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

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