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
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ backup_delete_lock_days |
int
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
The default maximum age of a Backup created via this BackupPlan. This field MUST be an integer value >= 0. 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. Default: 0 (no automatic deletion) |
↳ locked |
bool
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 |
getBackupDeleteLockDays
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
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
The default maximum age of a Backup created via this BackupPlan.
This field MUST be an integer value >= 0. 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. Default: 0 (no automatic deletion)
| Returns | |
|---|---|
| Type | Description |
int | |
setBackupRetainDays
The default maximum age of a Backup created via this BackupPlan.
This field MUST be an integer value >= 0. 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. Default: 0 (no automatic deletion)
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getLocked
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
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
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |