Skip to main content

volume_backups

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

Overview

Namevolume_backups
TypeResource
Idgoogle.gkebackup.volume_backups

Fields

NameDatatypeDescription
namestringOutput only. The full name of the VolumeBackup resource. Format: projects/*/locations/*/backupPlans/*/backups/*/volumeBackups/*.
completeTimestringOutput only. The timestamp when the associated underlying volume backup operation completed.
createTimestringOutput only. The timestamp when this VolumeBackup resource was created.
diskSizeBytesstringOutput only. The minimum size of the disk to which this VolumeBackup can be restored.
etagstringOutput 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.
formatstringOutput only. The format used for the volume backup.
sourcePvcobjectA reference to a namespaced resource in Kubernetes.
statestringOutput only. The current state of this VolumeBackup.
stateMessagestringOutput only. A human readable message explaining why the VolumeBackup is in its current state.
storageBytesstringOutput 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.
uidstringOutput only. Server generated global unique identifier of UUID format.
updateTimestringOutput only. The timestamp when this VolumeBackup resource was last updated.
volumeBackupHandlestringOutput only. A storage system-specific opaque handle to the underlying volume backup.

Methods

NameAccessible byRequired ParamsDescription
getSELECTbackupPlansId, backupsId, locationsId, projectsId, volumeBackupsIdRetrieve the details of a single VolumeBackup.
listSELECTbackupPlansId, backupsId, locationsId, projectsIdLists the VolumeBackups for a given Backup.

SELECT examples

Lists the VolumeBackups for a given Backup.

SELECT
name,
completeTime,
createTime,
diskSizeBytes,
etag,
format,
sourcePvc,
state,
stateMessage,
storageBytes,
uid,
updateTime,
volumeBackupHandle
FROM google.gkebackup.volume_backups
WHERE backupPlansId = '{{ backupPlansId }}'
AND backupsId = '{{ backupsId }}'
AND locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}';