Google Cloud AlloyDB for PostgreSQL V1 Client - Class QuantityBasedExpiry (1.0.0)

Reference documentation and code samples for the Google Cloud AlloyDB for PostgreSQL V1 Client class QuantityBasedExpiry.

A backup's position in a quantity-based retention queue, of backups with the same source cluster and type, with length, retention, specified by the backup's retention policy.

Once the position is greater than the retention, the backup is eligible to be garbage collected. Example: 5 backups from the same source cluster and type with a quantity-based retention of 3 and denoted by backup_id (position, retention). Safe: backup_5 (1, 3), backup_4, (2, 3), backup_3 (3, 3). Awaiting garbage collection: backup_2 (4, 3), backup_1 (5, 3)

Generated from protobuf message google.cloud.alloydb.v1.Backup.QuantityBasedExpiry

Namespace

Google \ Cloud \ AlloyDb \ V1 \ Backup

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ retention_count int

Output only. The backup's position among its backups with the same source cluster and type, by descending chronological order create time(i.e. newest first).

↳ total_retention_count int

Output only. The length of the quantity-based queue, specified by the backup's retention policy.

getRetentionCount

Output only. The backup's position among its backups with the same source cluster and type, by descending chronological order create time(i.e.

newest first).

Returns
Type Description
int

setRetentionCount

Output only. The backup's position among its backups with the same source cluster and type, by descending chronological order create time(i.e.

newest first).

Parameter
Name Description
var int
Returns
Type Description
$this

getTotalRetentionCount

Output only. The length of the quantity-based queue, specified by the backup's retention policy.

Returns
Type Description
int

setTotalRetentionCount

Output only. The length of the quantity-based queue, specified by the backup's retention policy.

Parameter
Name Description
var int
Returns
Type Description
$this