REST Resource: projects.locations.backupPlans.backups.volumeBackups

Resource: VolumeBackup

Represents the backup of a specific persistent volume as a component of a Backup - both the record of the operation and a pointer to the underlying storage-specific artifacts.

JSON representation 
{
  "name": string,
  "uid": string,
  "createTime": string,
  "updateTime": string,
  "sourcePvc": {
    object (NamespacedName)
  },
  "volumeBackupHandle": string,
  "format": enum (VolumeBackupFormat),
  "storageBytes": string,
  "diskSizeBytes": string,
  "completeTime": string,
  "state": enum (State),
  "stateMessage": string,
  "etag": string,
  "satisfiesPzs": boolean,
  "satisfiesPzi": boolean
}
Fields
name

string

Output only. The full name of the VolumeBackup resource. Format: projects/*/locations/*/backupPlans/*/backups/*/volumeBackups/*.
uid

string

Output only. Server generated global unique identifier of UUID format.
createTime

string (Timestamp format)

Output only. The timestamp when this VolumeBackup resource was created.

Uses RFC 3339, where generated output will always be Z-normalized and use 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".
updateTime

string (Timestamp format)

Output only. The timestamp when this VolumeBackup resource was last updated.

Uses RFC 3339, where generated output will always be Z-normalized and use 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".
sourcePvc

object (NamespacedName)

Output only. A reference to the source Kubernetes PVC from which this VolumeBackup was created.
volumeBackupHandle

string

Output only. A storage system-specific opaque handle to the underlying volume backup.
format

enum (VolumeBackupFormat)

Output only. The format used for the volume backup.
storageBytes

string (int64 format)

Output only. The aggregate size of the underlying artifacts associated with this VolumeBackup in the backup storage. This may change over time when multiple backups of the same volume share the same backup storage location. In particular, this is likely to increase in size when the immediately preceding backup of the same volume is deleted.
diskSizeBytes

string (int64 format)

Output only. The minimum size of the disk to which this VolumeBackup can be restored.
completeTime

string (Timestamp format)

Output only. The timestamp when the associated underlying volume backup operation completed.

Uses RFC 3339, where generated output will always be Z-normalized and use 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".
state

enum (State)

Output only. The current state of this VolumeBackup.
stateMessage

string

Output only. A human readable message explaining why the VolumeBackup is in its current state. This field is only meant for human consumption and should not be used programmatically as this field is not guaranteed to be consistent.
etag

string

Output only. etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a volume backup from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform volume backup updates in order to avoid race conditions.
satisfiesPzs

boolean

Output only. [Output Only] Reserved for future use.
satisfiesPzi

boolean

Output only. [Output Only] Reserved for future use.

VolumeBackupFormat

Identifies the format used for the volume backup.

Enums
VOLUME_BACKUP_FORMAT_UNSPECIFIED Default value, not specified.
GCE_PERSISTENT_DISK Compute Engine Persistent Disk snapshot based volume backup.

State

The current state of a VolumeBackup

Enums
STATE_UNSPECIFIED This is an illegal state and should not be encountered.
CREATING A volume for the backup was identified and backup process is about to start.
SNAPSHOTTING The volume backup operation has begun and is in the initial "snapshot" phase of the process. Any defined ProtectedApplication "pre" hooks will be executed before entering this state and "post" hooks will be executed upon leaving this state.
UPLOADING The snapshot phase of the volume backup operation has completed and the snapshot is now being uploaded to backup storage.
SUCCEEDED The volume backup operation has completed successfully.
FAILED The volume backup operation has failed.
DELETING This VolumeBackup resource (and its associated artifacts) is in the process of being deleted.
CLEANED_UP The underlying artifacts of a volume backup (eg: persistent disk snapshots) are deleted.

Methods

get

 Retrieve the details of a single VolumeBackup.

getIamPolicy

 Gets the access control policy for a resource.

list

 Lists the VolumeBackups for a given Backup.

setIamPolicy

 Sets the access control policy on the specified resource.

testIamPermissions

 Returns permissions that a caller has on the specified resource.