REST Resource: projects.locations.backups

Resource: Backup

Message describing Backup object

JSON representation

JSON representation
{ "name": string, "displayName": string, "uid": string, "createTime": string, "updateTime": string, "deleteTime": string, "labels": { string: string, ... }, "state": enum (`State`), "type": enum (`Type`), "description": string, "clusterUid": string, "clusterName": string, "reconciling": boolean, "encryptionConfig": { object (`EncryptionConfig`) }, "encryptionInfo": { object (`EncryptionInfo`) }, "etag": string, "annotations": { string: string, ... }, "sizeBytes": string, "expiryTime": string, "expiryQuantity": { object (`QuantityBasedExpiry`) }, "satisfiesPzs": boolean, "databaseVersion": enum (`DatabaseVersion`) }

{
  "name": string,
  "displayName": string,
  "uid": string,
  "createTime": string,
  "updateTime": string,
  "deleteTime": string,
  "labels": {
    string: string,
    ...
  },
  "state": enum (State),
  "type": enum (Type),
  "description": string,
  "clusterUid": string,
  "clusterName": string,
  "reconciling": boolean,
  "encryptionConfig": {
    object (EncryptionConfig)
  },
  "encryptionInfo": {
    object (EncryptionInfo)
  },
  "etag": string,
  "annotations": {
    string: string,
    ...
  },
  "sizeBytes": string,
  "expiryTime": string,
  "expiryQuantity": {
    object (QuantityBasedExpiry)
  },
  "satisfiesPzs": boolean,
  "databaseVersion": enum (DatabaseVersion)
}

Fields
`name`	`string` Output only. The name of the backup resource with the format: * projects/{project}/locations/{region}/backups/{backupId} where the cluster and backup ID segments should satisfy the regex expression `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`, e.g. 1-63 characters of lowercase letters, numbers, and dashes, starting with a letter, and ending with a letter or number. For more details see https://google.aip.dev/122. The prefix of the backup resource name is the name of the parent resource: * projects/{project}/locations/{region}
`displayName`	`string` User-settable and human-readable display name for the Backup.
`uid`	`string` Output only. The system-generated UID of the resource. The UID is assigned when the resource is created, and it is retained until it is deleted.
`createTime`	`string (Timestamp format)` Output only. Create time stamp A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: `"2014-10-02T15:01:23Z"` and `"2014-10-02T15:01:23.045123456Z"`.
`updateTime`	`string (Timestamp format)` Output only. Update time stamp A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: `"2014-10-02T15:01:23Z"` and `"2014-10-02T15:01:23.045123456Z"`.
`deleteTime`	`string (Timestamp format)` Output only. Delete time stamp A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: `"2014-10-02T15:01:23Z"` and `"2014-10-02T15:01:23.045123456Z"`.
`labels`	`map (key: string, value: string)` Labels as key value pairs An object containing a list of `"key": value` pairs. Example: `{ "name": "wrench", "mass": "1.3kg", "count": "3" }`.
`state`	`enum (State)` Output only. The current state of the backup.
`type`	`enum (Type)` The backup type, which suggests the trigger for the backup.
`description`	`string` User-provided description of the backup.
`clusterUid`	`string` Output only. The system-generated UID of the cluster which was used to create this resource.
`clusterName`	`string` Required. The full resource name of the backup source cluster (e.g., projects/{project}/locations/{region}/clusters/{clusterId}).
`reconciling`	`boolean` Output only. Reconciling (https://google.aip.dev/128#reconciliation), if true, indicates that the service is actively updating the resource. This can happen due to user-triggered updates or system actions like failover or maintenance.
`encryptionConfig`	`object (EncryptionConfig)` Optional. The encryption config can be specified to encrypt the backup with a customer-managed encryption key (CMEK). When this field is not specified, the backup will then use default encryption scheme to protect the user data.
`encryptionInfo`	`object (EncryptionInfo)` Output only. The encryption information for the backup.
`etag`	`string` For Resource freshness validation (https://google.aip.dev/154)
`annotations`	`map (key: string, value: string)` Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128 An object containing a list of `"key": value` pairs. Example: `{ "name": "wrench", "mass": "1.3kg", "count": "3" }`.
`sizeBytes`	`string (int64 format)` Output only. The size of the backup in bytes.
`expiryTime`	`string (Timestamp format)` Output only. The time at which after the backup is eligible to be garbage collected. It is the duration specified by the backup's retention policy, added to the backup's createTime. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: `"2014-10-02T15:01:23Z"` and `"2014-10-02T15:01:23.045123456Z"`.
`expiryQuantity`	`object (QuantityBasedExpiry)` Output only. The QuantityBasedExpiry of the backup, specified by the backup's retention policy. Once the expiry quantity is over retention, the backup is eligible to be garbage collected.
`satisfiesPzs`	`boolean` Output only. Reserved for future use.
`databaseVersion`	`enum (DatabaseVersion)` Output only. The database engine major version of the cluster this backup was created from. Any restored cluster created from this backup will have the same database version.

State

Backup State

Enums
`STATE_UNSPECIFIED`	The state of the backup is unknown.
`READY`	The backup is ready.
`CREATING`	The backup is creating.
`FAILED`	The backup failed.
`DELETING`	The backup is being deleted.

Type

Backup Type

Enums
`TYPE_UNSPECIFIED`	Backup Type is unknown.
`ON_DEMAND`	ON_DEMAND backups that were triggered by the customer (e.g., not AUTOMATED).
`AUTOMATED`	AUTOMATED backups triggered by the automated backups scheduler pursuant to an automated backup policy.
`CONTINUOUS`	CONTINUOUS backups triggered by the automated backups scheduler due to a continuous backup policy.

QuantityBasedExpiry

A backup's position in a quantity-based retention queue, of backups with the same source cluster and type, with length, retention, specified by the backup's retention policy. Once the position is greater than the retention, the backup is eligible to be garbage collected.

Example: 5 backups from the same source cluster and type with a quantity-based retention of 3 and denoted by backupId (position, retention).

Safe: backup_5 (1, 3), backup_4, (2, 3), backup_3 (3, 3). Awaiting garbage collection: backup_2 (4, 3), backup_1 (5, 3)

JSON representation
{ "retentionCount": integer, "totalRetentionCount": integer }

Fields

Fields
`retentionCount`	`integer` Output only. The backup's position among its backups with the same source cluster and type, by descending chronological order create time(i.e. newest first).
`totalRetentionCount`	`integer` Output only. The length of the quantity-based queue, specified by the backup's retention policy.

retentionCount

integer

Output only. The backup's position among its backups with the same source cluster and type, by descending chronological order create time(i.e. newest first).

totalRetentionCount

integer

Output only. The length of the quantity-based queue, specified by the backup's retention policy.

Methods
`create`	Creates a new Backup in a given project and location.
`delete`	Deletes a single Backup.
`get`	Gets details of a single Backup.
`list`	Lists Backups in a given project and location.
`patch`	Updates the parameters of a single Backup.

REST Resource: projects.locations.backups

Resource: Backup

State

Type

QuantityBasedExpiry

Methods

`create`

`delete`

`get`

`list`

`patch`