Google Cloud AlloyDB for PostgreSQL V1alpha Client - Class ContinuousBackupConfig (0.5.0)

Reference documentation and code samples for the Google Cloud AlloyDB for PostgreSQL V1alpha Client class ContinuousBackupConfig.

ContinuousBackupConfig describes the continuous backups recovery configurations of a cluster.

Generated from protobuf message google.cloud.alloydb.v1alpha.ContinuousBackupConfig

Namespace

Google \ Cloud \ AlloyDb \ V1alpha

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ enabled bool

Whether ContinuousBackup is enabled.

↳ recovery_window_days int

The number of days that are eligible to restore from using PITR. To support the entire recovery window, backups and logs are retained for one day more than the recovery window. If not set, defaults to 14 days.

↳ encryption_config Google\Cloud\AlloyDb\V1alpha\EncryptionConfig

The encryption config can be specified to encrypt the backups with a customer-managed encryption key (CMEK). When this field is not specified, the backup will then use default encryption scheme to protect the user data.

getEnabled

Whether ContinuousBackup is enabled.

Returns
TypeDescription
bool

hasEnabled

clearEnabled

setEnabled

Whether ContinuousBackup is enabled.

Parameter
NameDescription
var bool
Returns
TypeDescription
$this

getRecoveryWindowDays

The number of days that are eligible to restore from using PITR. To support the entire recovery window, backups and logs are retained for one day more than the recovery window. If not set, defaults to 14 days.

Returns
TypeDescription
int

setRecoveryWindowDays

The number of days that are eligible to restore from using PITR. To support the entire recovery window, backups and logs are retained for one day more than the recovery window. If not set, defaults to 14 days.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getEncryptionConfig

The encryption config can be specified to encrypt the backups with a customer-managed encryption key (CMEK). When this field is not specified, the backup will then use default encryption scheme to protect the user data.

Returns
TypeDescription
Google\Cloud\AlloyDb\V1alpha\EncryptionConfig|null

hasEncryptionConfig

clearEncryptionConfig

setEncryptionConfig

The encryption config can be specified to encrypt the backups with a customer-managed encryption key (CMEK). When this field is not specified, the backup will then use default encryption scheme to protect the user data.

Parameter
NameDescription
var Google\Cloud\AlloyDb\V1alpha\EncryptionConfig
Returns
TypeDescription
$this