Google Cloud Sql Admin V1 Client - Class BackupRun (0.9.0)

Reference documentation and code samples for the Google Cloud Sql Admin V1 Client class BackupRun.

A BackupRun resource.

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

Namespace

Google \ Cloud \ Sql \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
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\V1\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\V1\DiskEncryptionConfiguration

Encryption configuration specific to a backup.

↳ disk_encryption_status Google\Cloud\Sql\V1\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
TypeDescription
string

setKind

This is always sql#backupRun.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getStatus

The status of this run.

Returns
TypeDescription
int

setStatus

The status of this run.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getEnqueuedTime

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

Returns
TypeDescription
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
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this

getId

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

Returns
TypeDescription
int|string

setId

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

Parameter
NameDescription
var int|string
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this

getEndTime

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

Returns
TypeDescription
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
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this

getError

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

Returns
TypeDescription
Google\Cloud\Sql\V1\OperationError|null

hasError

clearError

setError

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

Parameter
NameDescription
var Google\Cloud\Sql\V1\OperationError
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var int
Returns
TypeDescription
$this

getDescription

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

Returns
TypeDescription
string

setDescription

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

Parameter
NameDescription
var string
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this

getInstance

Name of the database instance.

Returns
TypeDescription
string

setInstance

Name of the database instance.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

The URI of this resource.

Returns
TypeDescription
string

The URI of this resource.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getLocation

Location of the backups.

Returns
TypeDescription
string

setLocation

Location of the backups.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getDiskEncryptionConfiguration

Encryption configuration specific to a backup.

Returns
TypeDescription
Google\Cloud\Sql\V1\DiskEncryptionConfiguration|null

hasDiskEncryptionConfiguration

clearDiskEncryptionConfiguration

setDiskEncryptionConfiguration

Encryption configuration specific to a backup.

Parameter
NameDescription
var Google\Cloud\Sql\V1\DiskEncryptionConfiguration
Returns
TypeDescription
$this

getDiskEncryptionStatus

Encryption status specific to a backup.

Returns
TypeDescription
Google\Cloud\Sql\V1\DiskEncryptionStatus|null

hasDiskEncryptionStatus

clearDiskEncryptionStatus

setDiskEncryptionStatus

Encryption status specific to a backup.

Parameter
NameDescription
var Google\Cloud\Sql\V1\DiskEncryptionStatus
Returns
TypeDescription
$this

getBackupKind

Specifies the kind of backup, PHYSICAL or DEFAULT_SNAPSHOT.

Returns
TypeDescription
int

setBackupKind

Specifies the kind of backup, PHYSICAL or DEFAULT_SNAPSHOT.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getTimeZone

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

Returns
TypeDescription
string

setTimeZone

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this