Resource: Backup
A backup of a Cloud Spanner database.
JSON representation |
---|
{ "database": string, "versionTime": string, "expireTime": string, "name": string, "createTime": string, "sizeBytes": string, "freeableSizeBytes": string, "exclusiveSizeBytes": string, "state": enum ( |
Fields | |
---|---|
database |
Required for the |
version |
The backup will contain an externally consistent copy of the database at the timestamp specified by A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
expire |
Required for the A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
name |
Output only for the A globally unique identifier for the backup which cannot be changed. Values are of the form 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 |
create |
Output only. The time the A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
size |
Output only. Size of the backup in bytes. For a backup in an incremental backup chain, this is the sum of the |
freeable |
Output only. The number of bytes that will be freed by deleting this backup. This value will be zero if, for example, this backup is part of an incremental backup chain and younger backups in the chain require that we keep its data. For backups not in an incremental backup chain, this is always the size of the backup. This value may change if backups on the same chain get created, deleted or expired. |
exclusive |
Output only. For a backup in an incremental backup chain, this is the storage space needed to keep the data that has changed since the previous backup. For all other backups, this is always the size of the backup. This value may change if backups on the same chain get deleted or expired. This field can be used to calculate the total storage space used by a set of backups. For example, the total space used by all backups of a database can be computed by summing up this field. |
state |
Output only. The current state of the backup. |
referencing |
Output only. The names of the restored databases that reference the backup. The database names are of the form |
encryption |
Output only. The encryption information for the backup. |
encryption |
Output only. The encryption information for the backup, whether it is protected by one or more KMS keys. The information includes all Cloud KMS key versions used to encrypt the backup. The |
database |
Output only. The database dialect information for the backup. |
referencing |
Output only. The names of the destination backups being created by copying this source backup. The backup names are of the form |
max |
Output only. The max allowed expiration time of the backup, with microseconds granularity. A backup's expiration time can be configured in multiple APIs: backups.create, backups.patch, backups.copy. When updating or copying an existing backup, the expiration time specified must be less than A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
backup |
Output only. List of backup schedule URIs that are associated with creating this backup. This is only applicable for scheduled backups, and is empty for on-demand backups. To optimize for storage, whenever possible, multiple schedules are collapsed together to create one backup. In such cases, this field captures the list of all backup schedule URIs that are associated with creating this backup. If collapsing is not done, then this field captures the single backup schedule URI associated with creating this backup. |
incremental |
Output only. Populated only for backups in an incremental backup chain. Backups share the same chain id if and only if they belong to the same incremental backup chain. Use this field to determine which backups are part of the same incremental backup chain. The ordering of backups in the chain can be determined by ordering the backup |
oldest |
Output only. Data deleted at a time older than this is guaranteed not to be retained in order to support this backup. For a backup in an incremental backup chain, this is the version time of the oldest backup that exists or ever existed in the chain. For all other backups, this is the version time of the backup. This field can be used to understand what data is being retained by the backup system. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
State
Indicates the current state of the backup.
Enums | |
---|---|
STATE_UNSPECIFIED |
Not specified. |
CREATING |
The pending backup is still being created. Operations on the backup may fail with FAILED_PRECONDITION in this state. |
READY |
The backup is complete and ready for use. |
Methods |
|
---|---|
|
Starts copying a Cloud Spanner Backup. |
|
Starts creating a new Cloud Spanner Backup. |
|
Deletes a pending or completed Backup . |
|
Gets metadata on a pending or completed Backup . |
|
Gets the access control policy for a database or backup resource. |
|
Lists completed and pending backups. |
|
Updates a pending or completed Backup . |
|
Sets the access control policy on a database or backup resource. |
|
Returns permissions that the caller has on the specified database or backup resource. |