Google Cloud Database Center V1beta Client - Class RetentionSettingsInfo (0.5.0)

Reference documentation and code samples for the Google Cloud Database Center V1beta Client class RetentionSettingsInfo.

Metadata about backup retention settings for a database resource.

Generated from protobuf message google.cloud.databasecenter.v1beta.RetentionSettingsInfo

Namespace

Google \ Cloud \ DatabaseCenter \ V1beta

Methods

__construct

Constructor.

Parameters
Name
Description
data
array

Optional. Data for populating the Message object.

↳ quantity_based_retention
Google\Protobuf\Int32Value

Number of backups that will be retained.

↳ duration_based_retention
Google\Protobuf\Duration

Duration based retention period i.e. 172800 seconds (2 days)

↳ timestamp_based_retention_time
Google\Protobuf\Timestamp

Timestamp based retention period i.e. till 2024-05-01T00:00:00Z

↳ sub_resource
SubResource

Optional. Sub resource details associated with the backup configuration.

getQuantityBasedRetention

Number of backups that will be retained.

Returns
Type
Description

hasQuantityBasedRetention

getQuantityBasedRetentionUnwrapped

Returns the unboxed value from getQuantityBasedRetention()

Number of backups that will be retained.

Returns
Type
Description
int|null

setQuantityBasedRetention

Number of backups that will be retained.

Parameter
Name
Description
Returns
Type
Description
$this

setQuantityBasedRetentionUnwrapped

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

Number of backups that will be retained.

Parameter
Name
Description
var
int|null
Returns
Type
Description
$this

getDurationBasedRetention

Duration based retention period i.e. 172800 seconds (2 days)

Returns
Type
Description

hasDurationBasedRetention

setDurationBasedRetention

Duration based retention period i.e. 172800 seconds (2 days)

Parameter
Name
Description
Returns
Type
Description
$this

getTimestampBasedRetentionTime

Timestamp based retention period i.e. till 2024-05-01T00:00:00Z

Returns
Type
Description

hasTimestampBasedRetentionTime

setTimestampBasedRetentionTime

Timestamp based retention period i.e. till 2024-05-01T00:00:00Z

Parameter
Name
Description
Returns
Type
Description
$this

getSubResource

Optional. Sub resource details associated with the backup configuration.

Returns
Type
Description
SubResource |null

hasSubResource

clearSubResource

setSubResource

Optional. Sub resource details associated with the backup configuration.

Parameter
Name
Description
Returns
Type
Description
$this

getRetention

Returns
Type
Description
string
Design a Mobile Site
View Site in Mobile | Classic
Share by: