Google Cloud Sql Admin V1 Client - Class BackupRetentionSettings (0.11.0)

Reference documentation and code samples for the Google Cloud Sql Admin V1 Client class BackupRetentionSettings.

We currently only support backup retention by specifying the number of backups we will retain.

Generated from protobuf message google.cloud.sql.v1.BackupRetentionSettings

Namespace

Google \ Cloud \ Sql \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ retention_unit int

The unit that 'retained_backups' represents.

↳ retained_backups Google\Protobuf\Int32Value

Depending on the value of retention_unit, this is used to determine if a backup needs to be deleted. If retention_unit is 'COUNT', we will retain this many backups.

getRetentionUnit

The unit that 'retained_backups' represents.

Returns
TypeDescription
int

setRetentionUnit

The unit that 'retained_backups' represents.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getRetainedBackups

Depending on the value of retention_unit, this is used to determine if a backup needs to be deleted. If retention_unit is 'COUNT', we will retain this many backups.

Returns
TypeDescription
Google\Protobuf\Int32Value|null

hasRetainedBackups

clearRetainedBackups

getRetainedBackupsValue

Returns the unboxed value from getRetainedBackups()

Depending on the value of retention_unit, this is used to determine if a backup needs to be deleted. If retention_unit is 'COUNT', we will retain this many backups.

Returns
TypeDescription
int|null

setRetainedBackups

Depending on the value of retention_unit, this is used to determine if a backup needs to be deleted. If retention_unit is 'COUNT', we will retain this many backups.

Parameter
NameDescription
var Google\Protobuf\Int32Value
Returns
TypeDescription
$this

setRetainedBackupsValue

Sets the field by wrapping a primitive type in a Google\Protobuf\Int32Value object.

Depending on the value of retention_unit, this is used to determine if a backup needs to be deleted. If retention_unit is 'COUNT', we will retain this many backups.

Parameter
NameDescription
var int|null
Returns
TypeDescription
$this