Reference documentation and code samples for the Google Cloud AlloyDB for PostgreSQL V1alpha Client class AutomatedBackupPolicy.
Message describing the user-specified automated backup policy.
All fields in the automated backup policy are optional. Defaults for each field are provided if they are not set.
Generated from protobuf message google.cloud.alloydb.v1alpha.AutomatedBackupPolicy
Namespace
Google \ Cloud \ AlloyDb \ V1alphaMethods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ weekly_schedule
↳ time_based_retention
Google\Cloud\AlloyDb\V1alpha\AutomatedBackupPolicy\TimeBasedRetention
Time-based Backup retention policy.
↳ quantity_based_retention
Google\Cloud\AlloyDb\V1alpha\AutomatedBackupPolicy\QuantityBasedRetention
Quantity-based Backup retention policy to retain recent backups.
↳ enabled
bool
Whether automated automated backups are enabled. If not set, defaults to true.
↳ backup_window
Google\Protobuf\Duration
The length of the time window during which a backup can be taken. If a backup does not succeed within this time window, it will be canceled and considered failed. The backup window must be at least 5 minutes long. There is no upper bound on the window. If not set, it defaults to 1 hour.
↳ encryption_config
Google\Cloud\AlloyDb\V1alpha\EncryptionConfig
Optional. 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.
↳ location
string
The location where the backup will be stored. Currently, the only supported option is to store the backup in the same region as the cluster. If empty, defaults to the region of the cluster.
↳ labels
array| Google\Protobuf\Internal\MapField
Labels to apply to backups created using this configuration.
getWeeklySchedule
Weekly schedule for the Backup.
hasWeeklySchedule
setWeeklySchedule
Weekly schedule for the Backup.
$this
getTimeBasedRetention
Time-based Backup retention policy.
hasTimeBasedRetention
setTimeBasedRetention
Time-based Backup retention policy.
$this
getQuantityBasedRetention
Quantity-based Backup retention policy to retain recent backups.
hasQuantityBasedRetention
setQuantityBasedRetention
Quantity-based Backup retention policy to retain recent backups.
$this
getEnabled
Whether automated automated backups are enabled. If not set, defaults to true.
bool
hasEnabled
clearEnabled
setEnabled
Whether automated automated backups are enabled. If not set, defaults to true.
var
bool
$this
getBackupWindow
The length of the time window during which a backup can be taken. If a backup does not succeed within this time window, it will be canceled and considered failed.
The backup window must be at least 5 minutes long. There is no upper bound on the window. If not set, it defaults to 1 hour.
hasBackupWindow
clearBackupWindow
setBackupWindow
The length of the time window during which a backup can be taken. If a backup does not succeed within this time window, it will be canceled and considered failed.
The backup window must be at least 5 minutes long. There is no upper bound on the window. If not set, it defaults to 1 hour.
$this
getEncryptionConfig
Optional. 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.
hasEncryptionConfig
clearEncryptionConfig
setEncryptionConfig
Optional. 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.
$this
getLocation
The location where the backup will be stored. Currently, the only supported option is to store the backup in the same region as the cluster.
If empty, defaults to the region of the cluster.
string
setLocation
The location where the backup will be stored. Currently, the only supported option is to store the backup in the same region as the cluster.
If empty, defaults to the region of the cluster.
var
string
$this
getLabels
Labels to apply to backups created using this configuration.
setLabels
Labels to apply to backups created using this configuration.
$this
getSchedule
string
getRetention
string
