Cloud Bigtable V2 Client - Class AutomatedBackupPolicy (2.22.0)

Reference documentation and code samples for the Cloud Bigtable V2 Client class AutomatedBackupPolicy.

Defines an automated backup policy for a table

Generated from protobuf message google.bigtable.admin.v2.Table.AutomatedBackupPolicy

Namespace

Google \ Cloud \ Bigtable \ Admin \ V2 \ Table

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ retention_period`	`Google\Protobuf\Duration` Required. How long the automated backups should be retained. Values must be at least 3 days and at most 90 days.
`↳ frequency`	`Google\Protobuf\Duration` How frequently automated backups should occur. The only supported value at this time is 24 hours. An undefined frequency is treated as 24 hours.
`↳ locations`	`string[]` Optional. A list of Cloud Bigtable zones where automated backups are allowed to be created. If empty, automated backups will be created in all zones of the instance. Locations are in the format `projects/{project}/locations/{zone}`. This field can only set for tables in Enterprise Plus instances.

getRetentionPeriod

Required. How long the automated backups should be retained. Values must be at least 3 days and at most 90 days.

Returns
Type	Description
`Google\Protobuf\Duration\|null`

hasRetentionPeriod

clearRetentionPeriod

setRetentionPeriod

Required. How long the automated backups should be retained. Values must be at least 3 days and at most 90 days.

Parameter
Name	Description
`var`	`Google\Protobuf\Duration`

Returns
Type	Description
`$this`

getFrequency

How frequently automated backups should occur. The only supported value at this time is 24 hours. An undefined frequency is treated as 24 hours.

Returns
Type	Description
`Google\Protobuf\Duration\|null`

hasFrequency

clearFrequency

setFrequency