Google Cloud Sql Admin V1beta4 Client - Class BackupRun (0.11.0)

Version 0.11.0

• 1.2.2 (latest)
• 1.2.1
• 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 BackupRun.

A BackupRun resource.

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

Namespace

Google \ Cloud \ Sql \ V1beta4

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ kind	string This is always sql#backupRun.
↳ status	int The status of this run.
↳ enqueued_time	Google\Protobuf\Timestamp The time the run was enqueued in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
↳ id	int|string The identifier for this backup run. Unique only for a specific Cloud SQL instance.
↳ start_time	Google\Protobuf\Timestamp The time the backup operation actually started in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
↳ end_time	Google\Protobuf\Timestamp The time the backup operation completed in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
↳ error	Google\Cloud\Sql\V1beta4\OperationError Information about why the backup operation failed. This is only present if the run has the FAILED status.
↳ type	int The type of this run; can be either "AUTOMATED" or "ON_DEMAND" or "FINAL". This field defaults to "ON_DEMAND" and is ignored, when specified for insert requests.
↳ description	string The description of this run, only applicable to on-demand backups.
↳ window_start_time	Google\Protobuf\Timestamp The start time of the backup window during which this the backup was attempted in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
↳ instance	string Name of the database instance.
↳ self_link	string The URI of this resource.
↳ location	string Location of the backups.
↳ disk_encryption_configuration	Google\Cloud\Sql\V1beta4\DiskEncryptionConfiguration Encryption configuration specific to a backup.
↳ disk_encryption_status	Google\Cloud\Sql\V1beta4\DiskEncryptionStatus Encryption status specific to a backup.
↳ backup_kind	int Specifies the kind of backup, PHYSICAL or DEFAULT_SNAPSHOT.
↳ time_zone	string Backup time zone to prevent restores to an instance with a different time zone. Now relevant only for SQL Server.

getKind

This is always sql#backupRun.

Returns
Type	Description
string

setKind

This is always sql#backupRun.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getStatus

The status of this run.

Returns
Type	Description
int

setStatus

The status of this run.

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getEnqueuedTime

The time the run was enqueued in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.

Returns
Type	Description
Google\Protobuf\Timestamp|null

hasEnqueuedTime

clearEnqueuedTime

setEnqueuedTime

The time the run was enqueued in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.

Parameter
Name	Description
var	Google\Protobuf\Timestamp

Returns
Type	Description
$this

getId

The identifier for this backup run. Unique only for a specific Cloud SQL instance.

Returns
Type	Description
int|string

setId

The identifier for this backup run. Unique only for a specific Cloud SQL instance.

Parameter
Name	Description
var	int|string

Returns
Type	Description
$this

getStartTime

The time the backup operation actually started in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.

Returns
Type	Description
Google\Protobuf\Timestamp|null

hasStartTime

clearStartTime

setStartTime

The time the backup operation actually started in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.

Parameter
Name	Description
var	Google\Protobuf\Timestamp

Returns
Type	Description
$this

getEndTime

The time the backup operation completed in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.

Returns
Type	Description
Google\Protobuf\Timestamp|null

hasEndTime

clearEndTime

setEndTime

The time the backup operation completed in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.

Parameter
Name	Description
var	Google\Protobuf\Timestamp

Returns
Type	Description
$this

getError

Information about why the backup operation failed. This is only present if the run has the FAILED status.

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

hasError

clearError

setError

Information about why the backup operation failed. This is only present if the run has the FAILED status.

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

Returns
Type	Description
$this

getType

The type of this run; can be either "AUTOMATED" or "ON_DEMAND" or "FINAL".

This field defaults to "ON_DEMAND" and is ignored, when specified for insert requests.

Returns
Type	Description
int

setType

The type of this run; can be either "AUTOMATED" or "ON_DEMAND" or "FINAL".

This field defaults to "ON_DEMAND" and is ignored, when specified for insert requests.

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getDescription

The description of this run, only applicable to on-demand backups.

Returns
Type	Description
string

setDescription

The description of this run, only applicable to on-demand backups.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getWindowStartTime

The start time of the backup window during which this the backup was attempted in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.

Returns
Type	Description
Google\Protobuf\Timestamp|null

hasWindowStartTime

clearWindowStartTime

setWindowStartTime

The start time of the backup window during which this the backup was attempted in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.

Parameter
Name	Description
var	Google\Protobuf\Timestamp

Returns
Type	Description
$this

getInstance

Name of the database instance.

Returns
Type	Description
string

setInstance

Name of the database instance.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getSelfLink

The URI of this resource.

Returns
Type	Description
string

setSelfLink

The URI of this resource.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getLocation

Location of the backups.

Returns
Type	Description
string

setLocation

Location of the backups.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getDiskEncryptionConfiguration

Encryption configuration specific to a backup.

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

hasDiskEncryptionConfiguration

clearDiskEncryptionConfiguration

setDiskEncryptionConfiguration

Encryption configuration specific to a backup.

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

Returns
Type	Description
$this

getDiskEncryptionStatus

Encryption status specific to a backup.

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

hasDiskEncryptionStatus

clearDiskEncryptionStatus

setDiskEncryptionStatus

Encryption status specific to a backup.

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

Returns
Type	Description
$this

getBackupKind

Specifies the kind of backup, PHYSICAL or DEFAULT_SNAPSHOT.

Returns
Type	Description
int

setBackupKind

Specifies the kind of backup, PHYSICAL or DEFAULT_SNAPSHOT.

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getTimeZone

Backup time zone to prevent restores to an instance with a different time zone. Now relevant only for SQL Server.

Returns
Type	Description
string

setTimeZone

Backup time zone to prevent restores to an instance with a different time zone. Now relevant only for SQL Server.

Parameter
Name	Description
var	string

Returns
Type	Description
$this