Cloud Bigtable V2 Client - Class AutomatedBackupPolicy (2.29.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.
`↳ keep_hot_duration`	`Google\Protobuf\Duration` Optional. The amount of time that the automated backups remain hot. If specified, the backups created by this policy are `HOT` backups. If not specified, the backups are `STANDARD` backups. The value must be at least 24 hours and at most 10 days, and can't exceed the policy's `retention_period`. Only SSD instances support `HOT` automated backups.
`↳ disabled`	`bool` Optional. If `true`, automated backups are explicitly disabled on this table. This allows users to opt out of default enablement.

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

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

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

Returns
Type	Description
`$this`

getLocations

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.

Returns
Type	Description
`Google\Protobuf\RepeatedField<string>`

setLocations

This field can only set for tables in Enterprise Plus instances.

Parameter
Name	Description
`var`	`string[]`

Returns
Type	Description
`$this`

getKeepHotDuration

Optional. The amount of time that the automated backups remain hot.

If specified, the backups created by this policy are HOT backups. If not specified, the backups are STANDARD backups. The value must be at least 24 hours and at most 10 days, and can't exceed the policy's retention_period. Only SSD instances support HOT automated backups.

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

hasKeepHotDuration

clearKeepHotDuration

setKeepHotDuration