backups

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

Overview

Name	backups
Type	Resource
Id	google.redis.backups

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
name	string	Identifier. Full resource path of the backup. the last part of the name is the backup id with the following format: [YYYYMMDDHHMMSS]_[Shorted Cluster UID] OR customer specified while backup cluster. Example: 20240515123000_1234
backupFiles	array	Output only. List of backup files of the backup.
backupType	string	Output only. Type of the backup.
cluster	string	Output only. Cluster resource path of this backup.
clusterUid	string	Output only. Cluster uid of this backup.
createTime	string (google-datetime)	Output only. The time when the backup was created.
encryptionInfo	object	Output only. Encryption information of the backup. (id: EncryptionInfo)
engineVersion	string	Output only. redis-7.2, valkey-7.5
expireTime	string (google-datetime)	Output only. The time when the backup will expire.
nodeType	string	Output only. Node type of the cluster.
replicaCount	integer (int32)	Output only. Number of replicas for the cluster.
shardCount	integer (int32)	Output only. Number of shards for the cluster.
state	string	Output only. State of the backup.
totalSizeBytes	string (int64)	Output only. Total size of the backup in bytes.
uid	string	Output only. System assigned unique identifier of the backup.

list

Successful response

Name	Datatype	Description
name	string	Identifier. Full resource path of the backup. the last part of the name is the backup id with the following format: [YYYYMMDDHHMMSS]_[Shorted Cluster UID] OR customer specified while backup cluster. Example: 20240515123000_1234
backupFiles	array	Output only. List of backup files of the backup.
backupType	string	Output only. Type of the backup.
cluster	string	Output only. Cluster resource path of this backup.
clusterUid	string	Output only. Cluster uid of this backup.
createTime	string (google-datetime)	Output only. The time when the backup was created.
encryptionInfo	object	Output only. Encryption information of the backup. (id: EncryptionInfo)
engineVersion	string	Output only. redis-7.2, valkey-7.5
expireTime	string (google-datetime)	Output only. The time when the backup will expire.
nodeType	string	Output only. Node type of the cluster.
replicaCount	integer (int32)	Output only. Number of replicas for the cluster.
shardCount	integer (int32)	Output only. Number of shards for the cluster.
state	string	Output only. State of the backup.
totalSizeBytes	string (int64)	Output only. Total size of the backup in bytes.
uid	string	Output only. System assigned unique identifier of the backup.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, backupCollectionsId, backupsId		Gets the details of a specific backup.
list	select	projectsId, locationsId, backupCollectionsId	pageSize, pageToken	Lists all backups owned by a backup collection.
delete	delete	projectsId, locationsId, backupCollectionsId, backupsId	requestId	Deletes a specific backup.
export	exec	projectsId, locationsId, backupCollectionsId, backupsId		Exports a specific backup to a customer target Cloud Storage URI.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
backupCollectionsId	string
backupsId	string
locationsId	string
projectsId	string
pageSize	integer (int32)
pageToken	string
requestId	string

SELECT examples

get

Gets the details of a specific backup.

SELECT
name,
backupFiles,
backupType,
cluster,
clusterUid,
createTime,
encryptionInfo,
engineVersion,
expireTime,
nodeType,
replicaCount,
shardCount,
state,
totalSizeBytes,
uid
FROM google.redis.backups
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND backupCollectionsId = '{{ backupCollectionsId }}' -- required
AND backupsId = '{{ backupsId }}' -- required;

list

Lists all backups owned by a backup collection.

SELECT
name,
backupFiles,
backupType,
cluster,
clusterUid,
createTime,
encryptionInfo,
engineVersion,
expireTime,
nodeType,
replicaCount,
shardCount,
state,
totalSizeBytes,
uid
FROM google.redis.backups
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND backupCollectionsId = '{{ backupCollectionsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}';

DELETE examples

delete

Deletes a specific backup.

DELETE FROM google.redis.backups
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND backupCollectionsId = '{{ backupCollectionsId }}' --required
AND backupsId = '{{ backupsId }}' --required
AND requestId = '{{ requestId }}';

Lifecycle Methods

export

Exports a specific backup to a customer target Cloud Storage URI.

EXEC google.redis.backups.export 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@backupCollectionsId='{{ backupCollectionsId }}' --required, 
@backupsId='{{ backupsId }}' --required 
@@json=
'{
"gcsBucket": "{{ gcsBucket }}"
}';