Resource: BackupRun
A BackupRun resource.
| JSON representation |
|---|
{"kind": string,"status": enum ( |
| Fields | |
|---|---|
kind |
This is always |
status |
The status of this run. |
enqueuedTime |
The time the run was enqueued in UTC timezone in RFC 3339 format, for example A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
id |
The identifier for this backup run. Unique only for a specific Cloud SQL instance. |
startTime |
The time the backup operation actually started in UTC timezone in RFC 3339 format, for example A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
endTime |
The time the backup operation completed in UTC timezone in RFC 3339 format, for example A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
error |
Information about why the backup operation failed. This is only present if the run has the FAILED status. |
type |
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 |
The description of this run, only applicable to on-demand backups. |
windowStartTime |
The start time of the backup window during which this the backup was attempted in RFC 3339 format, for example A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
instance |
Name of the database instance. |
selfLink |
The URI of this resource. |
location |
Location of the backups. |
diskEncryptionConfiguration |
Encryption configuration specific to a backup. |
diskEncryptionStatus |
Encryption status specific to a backup. |
backupKind |
Specifies the kind of backup, PHYSICAL or DEFAULT_SNAPSHOT. |
timeZone |
Backup time zone to prevent restores to an instance with a different time zone. Now relevant only for SQL Server. |
maxChargeableBytes |
Output only. The maximum chargeable bytes for the backup. |
SqlBackupRunStatus
The status of a backup run.
| Enums | |
|---|---|
SQL_BACKUP_RUN_STATUS_UNSPECIFIED | The status of the run is unknown. |
ENQUEUED | The backup operation was enqueued. |
OVERDUE | The backup is overdue across a given backup window. Indicates a problem. Example: Long-running operation in progress during the whole window. |
RUNNING | The backup is in progress. |
FAILED | The backup failed. |
SUCCESSFUL | The backup was successful. |
SKIPPED | The backup was skipped (without problems) for a given backup window. Example: Instance was idle. |
DELETION_PENDING | The backup is about to be deleted. |
DELETION_FAILED | The backup deletion failed. |
DELETED | The backup has been deleted. |
SqlBackupRunType
Type of backup (i.e. automated, on demand, etc).
| Enums | |
|---|---|
SQL_BACKUP_RUN_TYPE_UNSPECIFIED | This is an unknown BackupRun type. |
AUTOMATED | The backup schedule automatically triggers a backup. |
ON_DEMAND | The user manually triggers a backup. |
SqlBackupKind
Defines the supported backup kinds.
| Enums | |
|---|---|
SQL_BACKUP_KIND_UNSPECIFIED | This is an unknown BackupKind. |
SNAPSHOT | The snapshot based backups |
PHYSICAL | Physical backups |
Methods | |
|---|---|
| Deletes the backup taken by a backup run. |
| Retrieves a resource containing information about a backup run. |
| Creates a new backup run on demand. |
| Lists all backup runs associated with the project or a given instance and configuration in the reverse chronological order of the backup initiation time. |
