Backup for GKE v1 API - Class BackupPlan.Types.RetentionPolicy (2.5.0) 

public sealed class BackupPlan.Types.RetentionPolicy : IMessage<BackupPlan.Types.RetentionPolicy>, IEquatable<BackupPlan.Types.RetentionPolicy>, IDeepCloneable<BackupPlan.Types.RetentionPolicy>, IBufferMessage, IMessage

Reference documentation and code samples for the Backup for GKE v1 API class BackupPlan.Types.RetentionPolicy.

RetentionPolicy defines a Backup retention policy for a BackupPlan.

Inheritance

object > BackupPlan.Types.RetentionPolicy

Namespace

Google.Cloud.GkeBackup.V1

Assembly

Google.Cloud.GkeBackup.V1.dll

Constructors

RetentionPolicy()

public RetentionPolicy()

RetentionPolicy(RetentionPolicy)

public RetentionPolicy(BackupPlan.Types.RetentionPolicy other)
Parameter
Name Description
other BackupPlanTypesRetentionPolicy

Properties

BackupDeleteLockDays

public int BackupDeleteLockDays { get; set; }

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)

Property Value
Type Description
int

BackupRetainDays

public int BackupRetainDays { get; set; }

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][google.cloud.gkebackup.v1.BackupPlan.RetentionPolicy.backup_delete_lock_days]. If [cron_schedule][google.cloud.gkebackup.v1.BackupPlan.Schedule.cron_schedule] is defined, then this must be <= 360 * the creation interval. If [rpo_config][google.cloud.gkebackup.v1.BackupPlan.Schedule.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)

Property Value
Type Description
int

Locked

public bool Locked { get; set; }

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

Property Value
Type Description
bool