volume_backups

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

Overview

Name	volume_backups
Type	Resource
Id	google.gkebackup.volume_backups

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
name	string	Output only. The full name of the VolumeBackup resource. Format: projects/*/locations/*/backupPlans/*/backups/*/volumeBackups/*.
completeTime	string (google-datetime)	Output only. The timestamp when the associated underlying volume backup operation completed.
createTime	string (google-datetime)	Output only. The timestamp when this VolumeBackup resource was created.
diskSizeBytes	string (int64)	Output only. The minimum size of the disk to which this VolumeBackup can be restored.
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.
format	string	Output only. The format used for the volume backup.
satisfiesPzi	boolean	Output only. [Output Only] Reserved for future use.
satisfiesPzs	boolean	Output only. [Output Only] Reserved for future use.
sourcePvc	object	A reference to a namespaced resource in Kubernetes. (id: NamespacedName)
state	string	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.
storageBytes	string (int64)	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.
uid	string	Output only. Server generated global unique identifier of UUID format.
updateTime	string (google-datetime)	Output only. The timestamp when this VolumeBackup resource was last updated.
volumeBackupHandle	string	Output only. A storage system-specific opaque handle to the underlying volume backup.

list

Successful response

Name	Datatype	Description
name	string	Output only. The full name of the VolumeBackup resource. Format: projects/*/locations/*/backupPlans/*/backups/*/volumeBackups/*.
completeTime	string (google-datetime)	Output only. The timestamp when the associated underlying volume backup operation completed.
createTime	string (google-datetime)	Output only. The timestamp when this VolumeBackup resource was created.
diskSizeBytes	string (int64)	Output only. The minimum size of the disk to which this VolumeBackup can be restored.
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.
format	string	Output only. The format used for the volume backup.
satisfiesPzi	boolean	Output only. [Output Only] Reserved for future use.
satisfiesPzs	boolean	Output only. [Output Only] Reserved for future use.
sourcePvc	object	A reference to a namespaced resource in Kubernetes. (id: NamespacedName)
state	string	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.
storageBytes	string (int64)	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.
uid	string	Output only. Server generated global unique identifier of UUID format.
updateTime	string (google-datetime)	Output only. The timestamp when this VolumeBackup resource was last updated.
volumeBackupHandle	string	Output only. A storage system-specific opaque handle to the underlying volume backup.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, backupPlansId, backupsId, volumeBackupsId		Retrieve the details of a single VolumeBackup.
list	select	projectsId, locationsId, backupPlansId, backupsId	pageSize, pageToken, filter, orderBy	Lists the VolumeBackups for a given Backup.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
backupPlansId	string
backupsId	string
locationsId	string
projectsId	string
volumeBackupsId	string
filter	string
orderBy	string
pageSize	integer (int32)
pageToken	string

SELECT examples

get

Retrieve the details of a single VolumeBackup.

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

list

Lists the VolumeBackups for a given Backup.

SELECT
name,
completeTime,
createTime,
diskSizeBytes,
etag,
format,
satisfiesPzi,
satisfiesPzs,
sourcePvc,
state,
stateMessage,
storageBytes,
uid,
updateTime,
volumeBackupHandle
FROM google.gkebackup.volume_backups
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND backupPlansId = '{{ backupPlansId }}' -- required
AND backupsId = '{{ backupsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND filter = '{{ filter }}'
AND orderBy = '{{ orderBy }}';