Google Cloud Backup Dr V1 Client - Class BackupRule (0.4.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.

↳ standard_schedule Google\Cloud\BackupDR\V1\StandardSchedule

Required. 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

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}/.

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.

Returns
Type Description
int

setBackupRetentionDays

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.

Parameter
Name Description
var int
Returns
Type Description
$this

getStandardSchedule

Required. Defines a schedule that runs within the confines of a defined window of time.

Returns
Type Description
Google\Cloud\BackupDR\V1\StandardSchedule|null

hasStandardSchedule

setStandardSchedule

Required. Defines a schedule that runs within the confines of a defined window of time.

Parameter
Name Description
var Google\Cloud\BackupDR\V1\StandardSchedule
Returns
Type Description
$this

getBackupScheduleOneof

Returns
Type Description
string