REST Resource: projects.locations.backupCollections.backups

Resource: Backup

Backup of a cluster.

JSON representation 
{
  "name": string,
  "createTime": string,
  "cluster": string,
  "clusterUid": string,
  "totalSizeBytes": string,
  "expireTime": string,
  "engineVersion": string,
  "backupFiles": [
    {
      object (BackupFile)
    }
  ],
  "nodeType": enum (NodeType),
  "replicaCount": integer,
  "shardCount": integer,
  "backupType": enum (BackupType),
  "state": enum (State),
  "encryptionInfo": {
    object (EncryptionInfo)
  },
  "uid": string
}
Fields
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
createTime

string (Timestamp format)

Output only. The time when the backup was created.

Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
cluster

string

Output only. Cluster resource path of this backup.
clusterUid

string

Output only. Cluster uid of this backup.
totalSizeBytes

string (int64 format)

Output only. Total size of the backup in bytes.
expireTime

string (Timestamp format)

Output only. The time when the backup will expire.

Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
engineVersion

string

Output only. redis-7.2, valkey-7.5
backupFiles[]

object (BackupFile)

Output only. List of backup files of the backup.
nodeType

enum (NodeType)

Output only. Node type of the cluster.
replicaCount

integer

Output only. Number of replicas for the cluster.
shardCount

integer

Output only. Number of shards for the cluster.
backupType

enum (BackupType)

Output only. Type of the backup.
state

enum (State)

Output only. State of the backup.
encryptionInfo

object (EncryptionInfo)

Output only. Encryption information of the backup.
uid

string

Output only. System assigned unique identifier of the backup.

BackupFile

Backup is consisted of multiple backup files.

JSON representation 
{
  "fileName": string,
  "sizeBytes": string,
  "createTime": string
}
Fields
fileName

string

Output only. e.g: .rdb
sizeBytes

string (int64 format)

Output only. Size of the backup file in bytes.
createTime

string (Timestamp format)

Output only. The time when the backup file was created.

Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

BackupType

Type of the backup.

Enums
BACKUP_TYPE_UNSPECIFIED The default value, not set.
ON_DEMAND On-demand backup.
AUTOMATED Automated backup.

State

State of the backup.

Enums
STATE_UNSPECIFIED The default value, not set.
CREATING The backup is being created.
ACTIVE The backup is active to be used.
DELETING The backup is being deleted.
SUSPENDED The backup is currently suspended due to reasons like project deletion, billing account closure, etc.

Methods

delete

 Deletes a specific backup.

export

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

get

 Gets the details of a specific backup.

list

 Lists all backups owned by a backup collection.