backups

Creates, updates, deletes, gets or lists a backups resource.

Overview

Name	backups
Type	Resource
Id	google.backupdr.backups

Fields

Name	Datatype	Description
name	string	Output only. Identifier. Name of the resource.
description	string	Output only. The description of the Backup instance (2048 characters or less).
backupApplianceBackupProperties	object	BackupApplianceBackupProperties represents BackupDR backup appliance's properties.
backupApplianceLocks	array	Optional. The list of BackupLocks taken by the accessor Backup Appliance.
backupType	string	Output only. Type of the backup, unspecified, scheduled or ondemand.
computeInstanceBackupProperties	object	ComputeInstanceBackupProperties represents Compute Engine instance backup properties.
consistencyTime	string	Output only. The point in time when this backup was captured from the source.
createTime	string	Output only. The time when the instance was created.
enforcedRetentionEndTime	string	Optional. The backup can not be deleted before this time.
etag	string	Optional. Server specified ETag to prevent updates from overwriting each other.
expireTime	string	Optional. When this backup is automatically expired.
gcpBackupPlanInfo	object	GCPBackupPlanInfo captures the plan configuration details of Google Cloud resources at the time of backup.
labels	object	Optional. Resource labels to represent user provided metadata. No labels currently defined.
resourceSizeBytes	string	Output only. source resource size in bytes at the time of the backup.
serviceLocks	array	Output only. The list of BackupLocks taken by the service to prevent the deletion of the backup.
state	string	Output only. The Backup resource instance state.
updateTime	string	Output only. The time when the instance was updated.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	backupVaultsId, backupsId, dataSourcesId, locationsId, projectsId	Gets details of a Backup.
list	SELECT	backupVaultsId, dataSourcesId, locationsId, projectsId	Lists Backups in a given project and location.
delete	DELETE	backupVaultsId, backupsId, dataSourcesId, locationsId, projectsId	Deletes a Backup.
patch	UPDATE	backupVaultsId, backupsId, dataSourcesId, locationsId, projectsId	Updates the settings of a Backup.
restore	EXEC	backupVaultsId, backupsId, dataSourcesId, locationsId, projectsId	Restore from a Backup

SELECT examples

Lists Backups in a given project and location.

SELECT
name,
description,
backupApplianceBackupProperties,
backupApplianceLocks,
backupType,
computeInstanceBackupProperties,
consistencyTime,
createTime,
enforcedRetentionEndTime,
etag,
expireTime,
gcpBackupPlanInfo,
labels,
resourceSizeBytes,
serviceLocks,
state,
updateTime
FROM google.backupdr.backups
WHERE backupVaultsId = '{{ backupVaultsId }}'
AND dataSourcesId = '{{ dataSourcesId }}'
AND locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}';

UPDATE example

Updates a backups resource.

/*+ update */
UPDATE google.backupdr.backups
SET 
labels = '{{ labels }}',
enforcedRetentionEndTime = '{{ enforcedRetentionEndTime }}',
expireTime = '{{ expireTime }}',
etag = '{{ etag }}',
backupApplianceLocks = '{{ backupApplianceLocks }}'
WHERE 
backupVaultsId = '{{ backupVaultsId }}'
AND backupsId = '{{ backupsId }}'
AND dataSourcesId = '{{ dataSourcesId }}'
AND locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}';

DELETE example

Deletes the specified backups resource.

/*+ delete */
DELETE FROM google.backupdr.backups
WHERE backupVaultsId = '{{ backupVaultsId }}'
AND backupsId = '{{ backupsId }}'
AND dataSourcesId = '{{ dataSourcesId }}'
AND locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}';