Resource: Backup
Message describing Backup object
JSON representation |
---|
{ "name": string, "displayName": string, "uid": string, "createTime": string, "updateTime": string, "deleteTime": string, "labels": { string: string, ... }, "state": enum ( |
Fields | |
---|---|
name |
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 |
displayName |
User-settable and human-readable display name for the Backup. |
uid |
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 |
Output only. Create time stamp A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
updateTime |
Output only. Update time stamp A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
deleteTime |
Output only. Delete time stamp A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
labels |
Labels as key value pairs An object containing a list of |
state |
Output only. The current state of the backup. |
type |
The backup type, which suggests the trigger for the backup. |
description |
User-provided description of the backup. |
clusterUid |
Output only. The system-generated UID of the cluster which was used to create this resource. |
clusterName |
Required. The full resource name of the backup source cluster (e.g., projects/{project}/locations/{region}/clusters/{clusterId}). |
reconciling |
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 |
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 |
Output only. The encryption information for the backup. |
etag |
For Resource freshness validation (https://google.aip.dev/154) |
annotations |
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 |
sizeBytes |
Output only. The size of the backup in bytes. |
expiryTime |
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: |
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. |
Methods |
|
---|---|
|
Creates a new Backup in a given project and location. |
|
Deletes a single Backup. |
|
Gets details of a single Backup. |
|
Lists Backups in a given project and location. |
|
Updates the parameters of a single Backup. |