Google Cloud Redis Cluster V1 Client - Class AutomatedBackupConfig (0.4.0)

Reference documentation and code samples for the Google Cloud Redis Cluster V1 Client class AutomatedBackupConfig.

The automated backup config for a cluster.

Generated from protobuf message google.cloud.redis.cluster.v1.AutomatedBackupConfig

Namespace

Google \ Cloud \ Redis \ Cluster \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ fixed_frequency_schedule AutomatedBackupConfig\FixedFrequencySchedule

Optional. Trigger automated backups at a fixed frequency.

↳ automated_backup_mode int

Optional. The automated backup mode. If the mode is disabled, the other fields will be ignored.

↳ retention Google\Protobuf\Duration

Optional. How long to keep automated backups before the backups are deleted. The value should be between 1 day and 365 days. If not specified, the default value is 35 days.

getFixedFrequencySchedule

Optional. Trigger automated backups at a fixed frequency.

Returns
Type Description
AutomatedBackupConfig\FixedFrequencySchedule|null

hasFixedFrequencySchedule

setFixedFrequencySchedule

Optional. Trigger automated backups at a fixed frequency.

Parameter
Name Description
var AutomatedBackupConfig\FixedFrequencySchedule
Returns
Type Description
$this

getAutomatedBackupMode

Optional. The automated backup mode. If the mode is disabled, the other fields will be ignored.

Returns
Type Description
int

setAutomatedBackupMode

Optional. The automated backup mode. If the mode is disabled, the other fields will be ignored.

Parameter
Name Description
var int
Returns
Type Description
$this

getRetention

Optional. How long to keep automated backups before the backups are deleted. The value should be between 1 day and 365 days. If not specified, the default value is 35 days.

Returns
Type Description
Google\Protobuf\Duration|null

hasRetention

clearRetention

setRetention

Optional. How long to keep automated backups before the backups are deleted. The value should be between 1 day and 365 days. If not specified, the default value is 35 days.

Parameter
Name Description
var Google\Protobuf\Duration
Returns
Type Description
$this

getSchedule

Returns
Type Description
string