Google Cloud Backup Dr V1 Client - Class BackupRule (0.7.0)

Reference documentation and code samples for the Google Cloud Backup Dr V1 Client class BackupRule.

BackupRule binds the backup schedule to a retention policy.

Generated from protobuf message google.cloud.backupdr.v1.BackupRule

Namespace

Google \ Cloud \ BackupDR \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ rule_id`	`string` Required. Immutable. The unique id of this `BackupRule`. The `rule_id` is unique per `BackupPlan`.The `rule_id` must start with a lowercase letter followed by up to 62 lowercase letters, numbers, or hyphens. Pattern, /[a-z][a-z0-9-]{,62}/.
`↳ backup_retention_days`	`int` Required. Configures the duration for which backup data will be kept. It is defined in “days”. The value should be greater than or equal to minimum enforced retention of the backup vault. Minimum value is 1 and maximum value is 36159 for custom retention on-demand backup. Minimum and maximum values are workload specific for all other rules.
`↳ standard_schedule`	`StandardSchedule` Optional. Defines a schedule that runs within the confines of a defined window of time.

getRuleId

Required. Immutable. The unique id of this BackupRule. The rule_id is unique per BackupPlan.The rule_id must start with a lowercase letter followed by up to 62 lowercase letters, numbers, or hyphens. Pattern, /[a-z][a-z0-9-]{,62}/.

Returns
Type	Description
`string`

setRuleId

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getBackupRetentionDays

Required. Configures the duration for which backup data will be kept. It is defined in “days”. The value should be greater than or equal to minimum enforced retention of the backup vault.

Minimum value is 1 and maximum value is 36159 for custom retention on-demand backup. Minimum and maximum values are workload specific for all other rules.

Returns
Type	Description
`int`

setBackupRetentionDays