Reference documentation and code samples for the Google Cloud Gke Backup V1 Client class RetentionPolicy.
RetentionPolicy defines a Backup retention policy for a BackupPlan.
Generated from protobuf message google.cloud.gkebackup.v1.BackupPlan.RetentionPolicy
Namespace
Google \ Cloud \ GkeBackup \ V1 \ BackupPlan
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ backup_delete_lock_days
int
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
int
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 / (1440minutes/day). Default: 0 (no automatic deletion)
↳ locked
bool
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
getBackupDeleteLockDays
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
Type
Description
int
setBackupDeleteLockDays
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)
Parameter
Name
Description
var
int
Returns
Type
Description
$this
getBackupRetainDays
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 /
(1440minutes/day).
Default: 0 (no automatic deletion)
Returns
Type
Description
int
setBackupRetainDays
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 /
(1440minutes/day).
Default: 0 (no automatic deletion)
Parameter
Name
Description
var
int
Returns
Type
Description
$this
getLocked
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
Type
Description
bool
setLocked
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Cloud Gke Backup V1 Client - Class RetentionPolicy (1.2.1)\n\nVersion latestkeyboard_arrow_down\n\n- [1.2.1 (latest)](/php/docs/reference/cloud-gke-backup/latest/V1.BackupPlan.RetentionPolicy)\n- [1.2.0](/php/docs/reference/cloud-gke-backup/1.2.0/V1.BackupPlan.RetentionPolicy)\n- [1.0.3](/php/docs/reference/cloud-gke-backup/1.0.3/V1.BackupPlan.RetentionPolicy)\n- [0.8.1](/php/docs/reference/cloud-gke-backup/0.8.1/V1.BackupPlan.RetentionPolicy)\n- [0.7.2](/php/docs/reference/cloud-gke-backup/0.7.2/V1.BackupPlan.RetentionPolicy)\n- [0.6.0](/php/docs/reference/cloud-gke-backup/0.6.0/V1.BackupPlan.RetentionPolicy)\n- [0.5.3](/php/docs/reference/cloud-gke-backup/0.5.3/V1.BackupPlan.RetentionPolicy)\n- [0.4.0](/php/docs/reference/cloud-gke-backup/0.4.0/V1.BackupPlan.RetentionPolicy)\n- [0.3.1](/php/docs/reference/cloud-gke-backup/0.3.1/V1.BackupPlan.RetentionPolicy)\n- [0.2.0](/php/docs/reference/cloud-gke-backup/0.2.0/V1.BackupPlan.RetentionPolicy)\n- [0.1.7](/php/docs/reference/cloud-gke-backup/0.1.7/V1.BackupPlan.RetentionPolicy) \nReference documentation and code samples for the Google Cloud Gke Backup V1 Client class RetentionPolicy.\n\nRetentionPolicy defines a Backup retention policy for a BackupPlan.\n\nGenerated from protobuf message `google.cloud.gkebackup.v1.BackupPlan.RetentionPolicy`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ GkeBackup \\\\ V1 \\\\ BackupPlan\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getBackupDeleteLockDays\n\nOptional. Minimum age for Backups created via this BackupPlan (in days).\n\nThis field MUST be an integer value between 0-90 (inclusive).\nA Backup created under this BackupPlan will NOT be deletable until it\nreaches Backup's (create_time + backup_delete_lock_days).\nUpdating this field of a BackupPlan does NOT affect existing Backups\nunder it. Backups created AFTER a successful update will inherit\nthe new value.\nDefault: 0 (no delete blocking)\n\n### setBackupDeleteLockDays\n\nOptional. Minimum age for Backups created via this BackupPlan (in days).\n\nThis field MUST be an integer value between 0-90 (inclusive).\nA Backup created under this BackupPlan will NOT be deletable until it\nreaches Backup's (create_time + backup_delete_lock_days).\nUpdating this field of a BackupPlan does NOT affect existing Backups\nunder it. Backups created AFTER a successful update will inherit\nthe new value.\nDefault: 0 (no delete blocking)\n\n### getBackupRetainDays\n\nOptional. The default maximum age of a Backup created via this\nBackupPlan. This field MUST be an integer value \\\u003e= 0 and \\\u003c= 365. If\nspecified, a Backup created under this BackupPlan will be automatically\ndeleted after its age reaches (create_time + backup_retain_days). If not\nspecified, Backups created under this BackupPlan will NOT be subject to\nautomatic deletion. Updating this field does NOT affect existing Backups\nunder it. Backups created AFTER a successful update will automatically\npick up the new value. NOTE: backup_retain_days must be \\\u003e=\n[backup_delete_lock_days](/php/docs/reference/cloud-gke-backup/latest/V1.BackupPlan.RetentionPolicy#_Google_Cloud_GkeBackup_V1_BackupPlan_RetentionPolicy__getBackupDeleteLockDays__).\n\nIf\n[cron_schedule](/php/docs/reference/cloud-gke-backup/latest/V1.BackupPlan.Schedule#_Google_Cloud_GkeBackup_V1_BackupPlan_Schedule__getCronSchedule__)\nis defined, then this must be\n\\\u003c= 360 \\* the creation interval. If\n[rpo_config](/php/docs/reference/cloud-gke-backup/latest/V1.BackupPlan.Schedule#_Google_Cloud_GkeBackup_V1_BackupPlan_Schedule__getRpoConfig__) is\ndefined, then this must be\n\\\u003c= 360 \\* target_rpo_minutes /\n(1440minutes/day).\nDefault: 0 (no automatic deletion)\n\n### setBackupRetainDays\n\nOptional. The default maximum age of a Backup created via this\nBackupPlan. This field MUST be an integer value \\\u003e= 0 and \\\u003c= 365. If\nspecified, a Backup created under this BackupPlan will be automatically\ndeleted after its age reaches (create_time + backup_retain_days). If not\nspecified, Backups created under this BackupPlan will NOT be subject to\nautomatic deletion. Updating this field does NOT affect existing Backups\nunder it. Backups created AFTER a successful update will automatically\npick up the new value. NOTE: backup_retain_days must be \\\u003e=\n[backup_delete_lock_days](/php/docs/reference/cloud-gke-backup/latest/V1.BackupPlan.RetentionPolicy#_Google_Cloud_GkeBackup_V1_BackupPlan_RetentionPolicy__getBackupDeleteLockDays__).\n\nIf\n[cron_schedule](/php/docs/reference/cloud-gke-backup/latest/V1.BackupPlan.Schedule#_Google_Cloud_GkeBackup_V1_BackupPlan_Schedule__getCronSchedule__)\nis defined, then this must be\n\\\u003c= 360 \\* the creation interval. If\n[rpo_config](/php/docs/reference/cloud-gke-backup/latest/V1.BackupPlan.Schedule#_Google_Cloud_GkeBackup_V1_BackupPlan_Schedule__getRpoConfig__) is\ndefined, then this must be\n\\\u003c= 360 \\* target_rpo_minutes /\n(1440minutes/day).\nDefault: 0 (no automatic deletion)\n\n### getLocked\n\nOptional. This flag denotes whether the retention policy of this\nBackupPlan is locked. If set to True, no further update is allowed on\nthis policy, including the `locked` field itself.\n\nDefault: False\n\n### setLocked\n\nOptional. This flag denotes whether the retention policy of this\nBackupPlan is locked. If set to True, no further update is allowed on\nthis policy, including the `locked` field itself.\n\nDefault: False"]]
