backups

Overview

Name	backups
Type	Resource
Id	google.spanner.backups

Fields

Name	Datatype	Description
name	string	Output only for the CreateBackup operation. Required for the UpdateBackup operation. A globally unique identifier for the backup which cannot be changed. Values are of the form projects//instances//backups/a-z*[a-z0-9] The final segment of the name must be between 2 and 60 characters in length. The backup is stored in the location(s) specified in the instance configuration of the instance containing the backup, identified by the prefix of the backup name of the form projects//instances/.
expireTime	string	Required for the CreateBackup operation. The expiration time of the backup, with microseconds granularity that must be at least 6 hours and at most 366 days from the time the CreateBackup request is processed. Once the expire_time has passed, the backup is eligible to be automatically deleted by Cloud Spanner to free the resources used by the backup.
databaseDialect	string	Output only. The database dialect information for the backup.
encryptionInfo	object	Encryption information for a Cloud Spanner database or backup.
referencingBackups	array	Output only. The names of the destination backups being created by copying this source backup. The backup names are of the form projects//instances//backups/. Referencing backups may exist in different instances. The existence of any referencing backup prevents the backup from being deleted. When the copy operation is done (either successfully completed or cancelled or the destination backup is deleted), the reference to the backup is removed.
sizeBytes	string	Output only. Size of the backup in bytes.
versionTime	string	The backup will contain an externally consistent copy of the database at the timestamp specified by version_time. If version_time is not specified, the system will set version_time to the create_time of the backup.
state	string	Output only. The current state of the backup.
referencingDatabases	array	Output only. The names of the restored databases that reference the backup. The database names are of the form projects//instances//databases/. Referencing databases may exist in different instances. The existence of any referencing database prevents the backup from being deleted. When a restored database from the backup enters the READY state, the reference to the backup is removed.
maxExpireTime	string	Output only. The max allowed expiration time of the backup, with microseconds granularity. A backup's expiration time can be configured in multiple APIs: CreateBackup, UpdateBackup, CopyBackup. When updating or copying an existing backup, the expiration time specified must be less than Backup.max_expire_time.
createTime	string	Output only. The time the CreateBackup request is received. If the request does not specify version_time, the version_time of the backup will be equivalent to the create_time.
database	string	Required for the CreateBackup operation. Name of the database from which this backup was created. This needs to be in the same instance as the backup. Values are of the form projects//instances//databases/.

Methods

Name	Accessible by	Required Params	Description
projects_instances_backups_get	SELECT	backupsId, instancesId, projectsId	Gets metadata on a pending or completed Backup.
projects_instances_backups_list	SELECT	instancesId, projectsId	Lists completed and pending backups. Backups returned are ordered by create_time in descending order, starting from the most recent create_time.
projects_instances_backups_create	INSERT	instancesId, projectsId	Starts creating a new Cloud Spanner Backup. The returned backup long-running operation will have a name of the format projects//instances//backups//operations/ and can be used to track creation of the backup. The metadata field type is CreateBackupMetadata. The response field type is Backup, if successful. Cancelling the returned operation will stop the creation and delete the backup. There can be only one pending backup creation per database. Backup creation of different databases can run concurrently.
projects_instances_backups_delete	DELETE	backupsId, instancesId, projectsId	Deletes a pending or completed Backup.
_projects_instances_backups_list	EXEC	instancesId, projectsId	Lists completed and pending backups. Backups returned are ordered by create_time in descending order, starting from the most recent create_time.
projects_instances_backups_copy	EXEC	instancesId, projectsId	Starts copying a Cloud Spanner Backup. The returned backup long-running operation will have a name of the format projects//instances//backups//operations/ and can be used to track copying of the backup. The operation is associated with the destination backup. The metadata field type is CopyBackupMetadata. The response field type is Backup, if successful. Cancelling the returned operation will stop the copying and delete the destination backup. Concurrent CopyBackup requests can run on the same source backup.
projects_instances_backups_patch	EXEC	backupsId, instancesId, projectsId	Updates a pending or completed Backup.