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
Type
Description
int
setRetentionUnit
The unit that 'retained_backups' represents.
Parameter
Name
Description
var
int
Returns
Type
Description
$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 the unboxed value fromgetRetainedBackups()
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
Type
Description
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.
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Cloud Sql Admin V1 Client - Class BackupRetentionSettings (1.2.6)\n\nVersion latestkeyboard_arrow_down\n\n- [1.2.6 (latest)](/php/docs/reference/cloud-sql-admin/latest/V1.BackupRetentionSettings)\n- [1.2.5](/php/docs/reference/cloud-sql-admin/1.2.5/V1.BackupRetentionSettings)\n- [1.1.0](/php/docs/reference/cloud-sql-admin/1.1.0/V1.BackupRetentionSettings)\n- [1.0.0](/php/docs/reference/cloud-sql-admin/1.0.0/V1.BackupRetentionSettings)\n- [0.19.0](/php/docs/reference/cloud-sql-admin/0.19.0/V1.BackupRetentionSettings)\n- [0.18.0](/php/docs/reference/cloud-sql-admin/0.18.0/V1.BackupRetentionSettings)\n- [0.17.1](/php/docs/reference/cloud-sql-admin/0.17.1/V1.BackupRetentionSettings)\n- [0.16.1](/php/docs/reference/cloud-sql-admin/0.16.1/V1.BackupRetentionSettings)\n- [0.12.0](/php/docs/reference/cloud-sql-admin/0.12.0/V1.BackupRetentionSettings)\n- [0.11.0](/php/docs/reference/cloud-sql-admin/0.11.0/V1.BackupRetentionSettings)\n- [0.10.0](/php/docs/reference/cloud-sql-admin/0.10.0/V1.BackupRetentionSettings)\n- [0.9.0](/php/docs/reference/cloud-sql-admin/0.9.0/V1.BackupRetentionSettings)\n- [0.8.0](/php/docs/reference/cloud-sql-admin/0.8.0/V1.BackupRetentionSettings)\n- [0.7.0](/php/docs/reference/cloud-sql-admin/0.7.0/V1.BackupRetentionSettings)\n- [0.6.0](/php/docs/reference/cloud-sql-admin/0.6.0/V1.BackupRetentionSettings)\n- [0.5.0](/php/docs/reference/cloud-sql-admin/0.5.0/V1.BackupRetentionSettings)\n- [0.4.1](/php/docs/reference/cloud-sql-admin/0.4.1/V1.BackupRetentionSettings)\n- [0.3.1](/php/docs/reference/cloud-sql-admin/0.3.1/V1.BackupRetentionSettings)\n- [0.2.12](/php/docs/reference/cloud-sql-admin/0.2.12/V1.BackupRetentionSettings) \nReference documentation and code samples for the Google Cloud Sql Admin V1 Client class BackupRetentionSettings.\n\nWe currently only support backup retention by specifying the number\nof backups we will retain.\n\nGenerated from protobuf message `google.cloud.sql.v1.BackupRetentionSettings`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Sql \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getRetentionUnit\n\nThe unit that 'retained_backups' represents.\n\n### setRetentionUnit\n\nThe unit that 'retained_backups' represents.\n\n### getRetainedBackups\n\nDepending on the value of retention_unit, this is used to determine\nif a backup needs to be deleted. If retention_unit is 'COUNT', we will\nretain this many backups.\n\n### hasRetainedBackups\n\n### clearRetainedBackups\n\n### getRetainedBackupsUnwrapped\n\nReturns the unboxed value from `getRetainedBackups()`\n\nDepending on the value of retention_unit, this is used to determine\nif a backup needs to be deleted. If retention_unit is 'COUNT', we will\nretain this many backups.\n\n### setRetainedBackups\n\nDepending on the value of retention_unit, this is used to determine\nif a backup needs to be deleted. If retention_unit is 'COUNT', we will\nretain this many backups.\n\n### setRetainedBackupsUnwrapped\n\nSets the field by wrapping a primitive type in a Google\\\\Protobuf\\\\Int32Value object.\n\nDepending on the value of retention_unit, this is used to determine\nif a backup needs to be deleted. If retention_unit is 'COUNT', we will\nretain this many backups."]]
