backup_collections

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

Overview

Name	backup_collections
Type	Resource
Id	google.redis.backup_collections

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
name	string	Identifier. Full resource path of the backup collection.
cluster	string	Output only. The full resource path of the cluster the backup collection belongs to. Example: projects/{project}/locations/{location}/clusters/{cluster}
clusterUid	string	Output only. The cluster uid of the backup collection.
createTime	string (google-datetime)	Output only. The time when the backup collection was created.
kmsKey	string	Output only. The KMS key used to encrypt the backups under this backup collection.
lastBackupTime	string (google-datetime)	Output only. The last time a backup was created in the backup collection.
totalBackupCount	string (int64)	Output only. Total number of backups in the backup collection.
totalBackupSizeBytes	string (int64)	Output only. Total size of all backups in the backup collection.
uid	string	Output only. System assigned unique identifier of the backup collection.

list

Successful response

Name	Datatype	Description
name	string	Identifier. Full resource path of the backup collection.
cluster	string	Output only. The full resource path of the cluster the backup collection belongs to. Example: projects/{project}/locations/{location}/clusters/{cluster}
clusterUid	string	Output only. The cluster uid of the backup collection.
createTime	string (google-datetime)	Output only. The time when the backup collection was created.
kmsKey	string	Output only. The KMS key used to encrypt the backups under this backup collection.
lastBackupTime	string (google-datetime)	Output only. The last time a backup was created in the backup collection.
totalBackupCount	string (int64)	Output only. Total number of backups in the backup collection.
totalBackupSizeBytes	string (int64)	Output only. Total size of all backups in the backup collection.
uid	string	Output only. System assigned unique identifier of the backup collection.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, backupCollectionsId		Get a backup collection.
list	select	projectsId, locationsId	pageSize, pageToken	Lists all backup collections owned by a consumer project in either the specified location (region) or all locations. If location_id is specified as - (wildcard), then all regions available to the project are queried, and the results are aggregated.

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
locationsId	string
projectsId	string
pageSize	integer (int32)
pageToken	string

SELECT examples

get

Get a backup collection.

SELECT
name,
cluster,
clusterUid,
createTime,
kmsKey,
lastBackupTime,
totalBackupCount,
totalBackupSizeBytes,
uid
FROM google.redis.backup_collections
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND backupCollectionsId = '{{ backupCollectionsId }}' -- required;

list

Lists all backup collections owned by a consumer project in either the specified location (region) or all locations. If location_id is specified as - (wildcard), then all regions available to the project are queried, and the results are aggregated.

SELECT
name,
cluster,
clusterUid,
createTime,
kmsKey,
lastBackupTime,
totalBackupCount,
totalBackupSizeBytes,
uid
FROM google.redis.backup_collections
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}';