Google Cloud Sql Admin V1beta4 Client - Class BackupConfiguration (0.17.1)

Version 0.17.1

• 1.2.1 (latest)
• 1.2.0
• 1.1.0
• 1.0.0
• 0.19.0
• 0.18.0
• 0.17.1
• 0.16.1
• 0.12.0
• 0.11.0
• 0.10.0
• 0.9.0
• 0.8.0
• 0.7.0
• 0.6.0
• 0.5.0
• 0.4.1
• 0.3.1
• 0.2.12

Beta

This library is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

Reference documentation and code samples for the Google Cloud Sql Admin V1beta4 Client class BackupConfiguration.

Database instance backup configuration.

Generated from protobuf message google.cloud.sql.v1beta4.BackupConfiguration

Namespace

Google \ Cloud \ Sql \ V1beta4

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ start_time	string Start time for the daily backup configuration in UTC timezone in the 24 hour format - HH:MM.
↳ enabled	Google\Protobuf\BoolValue Whether this configuration is enabled.
↳ kind	string This is always sql#backupConfiguration.
↳ binary_log_enabled	Google\Protobuf\BoolValue (MySQL only) Whether binary log is enabled. If backup configuration is disabled, binarylog must be disabled as well.
↳ replication_log_archiving_enabled	Google\Protobuf\BoolValue Reserved for future use.
↳ location	string Location of the backup
↳ point_in_time_recovery_enabled	Google\Protobuf\BoolValue Whether point in time recovery is enabled.
↳ transaction_log_retention_days	Google\Protobuf\Int32Value The number of days of transaction logs we retain for point in time restore, from 1-7.
↳ backup_retention_settings	Google\Cloud\Sql\V1beta4\BackupRetentionSettings Backup retention settings.
↳ transactional_log_storage_state	int Output only. This value contains the storage location of transactional logs for the database for point-in-time recovery.

getStartTime

Start time for the daily backup configuration in UTC timezone in the 24 hour format - HH:MM.

Returns
Type	Description
string

setStartTime

Start time for the daily backup configuration in UTC timezone in the 24 hour format - HH:MM.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getEnabled

Whether this configuration is enabled.

Returns
Type	Description
Google\Protobuf\BoolValue|null

hasEnabled

clearEnabled

getEnabledValue

Returns the unboxed value from getEnabled()

Whether this configuration is enabled.

Returns
Type	Description
bool|null

setEnabled

Whether this configuration is enabled.

Parameter
Name	Description
var	Google\Protobuf\BoolValue

Returns
Type	Description
$this

setEnabledValue

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

Whether this configuration is enabled.

Parameter
Name	Description
var	bool|null

Returns
Type	Description
$this

getKind

This is always sql#backupConfiguration.

Returns
Type	Description
string

setKind

This is always sql#backupConfiguration.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getBinaryLogEnabled

(MySQL only) Whether binary log is enabled. If backup configuration is disabled, binarylog must be disabled as well.

Returns
Type	Description
Google\Protobuf\BoolValue|null

hasBinaryLogEnabled

clearBinaryLogEnabled

getBinaryLogEnabledValue

Returns the unboxed value from getBinaryLogEnabled()

(MySQL only) Whether binary log is enabled. If backup configuration is disabled, binarylog must be disabled as well.

Returns
Type	Description
bool|null

setBinaryLogEnabled

(MySQL only) Whether binary log is enabled. If backup configuration is disabled, binarylog must be disabled as well.

Parameter
Name	Description
var	Google\Protobuf\BoolValue

Returns
Type	Description
$this

setBinaryLogEnabledValue

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

(MySQL only) Whether binary log is enabled. If backup configuration is disabled, binarylog must be disabled as well.

Parameter
Name	Description
var	bool|null

Returns
Type	Description
$this

getReplicationLogArchivingEnabled

Reserved for future use.

Returns
Type	Description
Google\Protobuf\BoolValue|null

hasReplicationLogArchivingEnabled

clearReplicationLogArchivingEnabled

getReplicationLogArchivingEnabledValue

Returns the unboxed value from getReplicationLogArchivingEnabled()

Reserved for future use.

Returns
Type	Description
bool|null

setReplicationLogArchivingEnabled

Reserved for future use.

Parameter
Name	Description
var	Google\Protobuf\BoolValue

Returns
Type	Description
$this

setReplicationLogArchivingEnabledValue

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

Reserved for future use.

Parameter
Name	Description
var	bool|null

Returns
Type	Description
$this

getLocation

Location of the backup

Returns
Type	Description
string

setLocation

Location of the backup

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getPointInTimeRecoveryEnabled

Whether point in time recovery is enabled.

Returns
Type	Description
Google\Protobuf\BoolValue|null

hasPointInTimeRecoveryEnabled

clearPointInTimeRecoveryEnabled

getPointInTimeRecoveryEnabledValue

Returns the unboxed value from getPointInTimeRecoveryEnabled()

Whether point in time recovery is enabled.

Returns
Type	Description
bool|null

setPointInTimeRecoveryEnabled

Whether point in time recovery is enabled.

Parameter
Name	Description
var	Google\Protobuf\BoolValue

Returns
Type	Description
$this

setPointInTimeRecoveryEnabledValue

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

Whether point in time recovery is enabled.

Parameter
Name	Description
var	bool|null

Returns
Type	Description
$this

getTransactionLogRetentionDays

The number of days of transaction logs we retain for point in time restore, from 1-7.

Returns
Type	Description
Google\Protobuf\Int32Value|null

hasTransactionLogRetentionDays

clearTransactionLogRetentionDays

getTransactionLogRetentionDaysValue

Returns the unboxed value from getTransactionLogRetentionDays()

The number of days of transaction logs we retain for point in time restore, from 1-7.

Returns
Type	Description
int|null

setTransactionLogRetentionDays

The number of days of transaction logs we retain for point in time restore, from 1-7.

Parameter
Name	Description
var	Google\Protobuf\Int32Value

Returns
Type	Description
$this

setTransactionLogRetentionDaysValue

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

The number of days of transaction logs we retain for point in time restore, from 1-7.

Parameter
Name	Description
var	int|null

Returns
Type	Description
$this

getBackupRetentionSettings

Backup retention settings.

Returns
Type	Description
Google\Cloud\Sql\V1beta4\BackupRetentionSettings|null

hasBackupRetentionSettings

clearBackupRetentionSettings

setBackupRetentionSettings

Backup retention settings.

Parameter
Name	Description
var	Google\Cloud\Sql\V1beta4\BackupRetentionSettings

Returns
Type	Description
$this

getTransactionalLogStorageState

Output only. This value contains the storage location of transactional logs for the database for point-in-time recovery.

Returns
Type	Description
int

hasTransactionalLogStorageState

clearTransactionalLogStorageState

setTransactionalLogStorageState

Output only. This value contains the storage location of transactional logs for the database for point-in-time recovery.

Parameter
Name	Description
var	int

Returns
Type	Description
$this