Google Cloud Oracle Database V1 Client - Class DbBackupConfig (0.8.0)

Reference documentation and code samples for the Google Cloud Oracle Database V1 Client class DbBackupConfig.

Backup Options for the Database.

Generated from protobuf message google.cloud.oracledatabase.v1.DbBackupConfig

Namespace

Google \ Cloud \ OracleDatabase \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ auto_backup_enabled bool

Optional. If set to true, enables automatic backups on the database.

↳ backup_destination_details array<DbBackupConfig\BackupDestinationDetails>

Optional. Details of the database backup destinations.

↳ retention_period_days int

Optional. The number of days an automatic backup is retained before being automatically deleted. This value determines the earliest point in time to which a database can be restored. Min: 1, Max: 60.

↳ backup_deletion_policy int

Optional. This defines when the backups will be deleted after Database termination.

↳ auto_full_backup_day int

Optional. The day of the week on which the full backup should be performed on the database. If no value is provided, it will default to Sunday.

↳ auto_full_backup_window int

Optional. The window in which the full backup should be performed on the database. If no value is provided, the default is anytime.

↳ auto_incremental_backup_window int

Optional. The window in which the incremental backup should be performed on the database. If no value is provided, the default is anytime except the auto full backup day.

getAutoBackupEnabled

Optional. If set to true, enables automatic backups on the database.

Returns
Type Description
bool

setAutoBackupEnabled

Optional. If set to true, enables automatic backups on the database.

Parameter
Name Description
var bool
Returns
Type Description
$this

getBackupDestinationDetails

Optional. Details of the database backup destinations.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setBackupDestinationDetails

Optional. Details of the database backup destinations.

Parameter
Name Description
var array<DbBackupConfig\BackupDestinationDetails>
Returns
Type Description
$this

getRetentionPeriodDays

Optional. The number of days an automatic backup is retained before being automatically deleted. This value determines the earliest point in time to which a database can be restored. Min: 1, Max: 60.

Returns
Type Description
int

setRetentionPeriodDays

Optional. The number of days an automatic backup is retained before being automatically deleted. This value determines the earliest point in time to which a database can be restored. Min: 1, Max: 60.

Parameter
Name Description
var int
Returns
Type Description
$this

getBackupDeletionPolicy

Optional. This defines when the backups will be deleted after Database termination.

Returns
Type Description
int Enum of type BackupDeletionPolicy.

setBackupDeletionPolicy

Optional. This defines when the backups will be deleted after Database termination.

Parameter
Name Description
var int

Enum of type BackupDeletionPolicy.

Returns
Type Description
$this

getAutoFullBackupDay

Optional. The day of the week on which the full backup should be performed on the database. If no value is provided, it will default to Sunday.

Returns
Type Description
int Enum of type DayOfWeek.

setAutoFullBackupDay

Optional. The day of the week on which the full backup should be performed on the database. If no value is provided, it will default to Sunday.

Parameter
Name Description
var int

Enum of type DayOfWeek.

Returns
Type Description
$this

getAutoFullBackupWindow

Optional. The window in which the full backup should be performed on the database. If no value is provided, the default is anytime.

Returns
Type Description
int Enum of type BackupWindow.

setAutoFullBackupWindow

Optional. The window in which the full backup should be performed on the database. If no value is provided, the default is anytime.

Parameter
Name Description
var int

Enum of type BackupWindow.

Returns
Type Description
$this

getAutoIncrementalBackupWindow

Optional. The window in which the incremental backup should be performed on the database. If no value is provided, the default is anytime except the auto full backup day.

Returns
Type Description
int Enum of type BackupWindow.

setAutoIncrementalBackupWindow

Optional. The window in which the incremental backup should be performed on the database. If no value is provided, the default is anytime except the auto full backup day.

Parameter
Name Description
var int

Enum of type BackupWindow.

Returns
Type Description
$this