volume_restores

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

Overview

Name	volume_restores
Type	Resource
Id	google.gkebackup.volume_restores

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
name	string	Output only. Full name of the VolumeRestore resource. Format: projects/*/locations/*/restorePlans/*/restores/*/volumeRestores/*
completeTime	string (google-datetime)	Output only. The timestamp when the associated underlying volume restoration completed.
createTime	string (google-datetime)	Output only. The timestamp when this VolumeRestore resource was created.
etag	string	Output only. etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a volume restore from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform volume restore updates in order to avoid race conditions.
state	string	Output only. The current state of this VolumeRestore. (STATE_UNSPECIFIED, CREATING, RESTORING, SUCCEEDED, FAILED, DELETING)
stateMessage	string	Output only. A human readable message explaining why the VolumeRestore is in its current state.
targetPvc	object	A reference to a namespaced resource in Kubernetes. (id: NamespacedName)
uid	string	Output only. Server generated global unique identifier of UUID format.
updateTime	string (google-datetime)	Output only. The timestamp when this VolumeRestore resource was last updated.
volumeBackup	string	Output only. The full name of the VolumeBackup from which the volume will be restored. Format: projects/*/locations/*/backupPlans/*/backups/*/volumeBackups/*.
volumeHandle	string	Output only. A storage system-specific opaque handler to the underlying volume created for the target PVC from the volume backup.
volumeType	string	Output only. The type of volume provisioned (VOLUME_TYPE_UNSPECIFIED, GCE_PERSISTENT_DISK)

list

Name	Datatype	Description
name	string	Output only. Full name of the VolumeRestore resource. Format: projects/*/locations/*/restorePlans/*/restores/*/volumeRestores/*
completeTime	string (google-datetime)	Output only. The timestamp when the associated underlying volume restoration completed.
createTime	string (google-datetime)	Output only. The timestamp when this VolumeRestore resource was created.
etag	string	Output only. etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a volume restore from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform volume restore updates in order to avoid race conditions.
state	string	Output only. The current state of this VolumeRestore. (STATE_UNSPECIFIED, CREATING, RESTORING, SUCCEEDED, FAILED, DELETING)
stateMessage	string	Output only. A human readable message explaining why the VolumeRestore is in its current state.
targetPvc	object	A reference to a namespaced resource in Kubernetes. (id: NamespacedName)
uid	string	Output only. Server generated global unique identifier of UUID format.
updateTime	string (google-datetime)	Output only. The timestamp when this VolumeRestore resource was last updated.
volumeBackup	string	Output only. The full name of the VolumeBackup from which the volume will be restored. Format: projects/*/locations/*/backupPlans/*/backups/*/volumeBackups/*.
volumeHandle	string	Output only. A storage system-specific opaque handler to the underlying volume created for the target PVC from the volume backup.
volumeType	string	Output only. The type of volume provisioned (VOLUME_TYPE_UNSPECIFIED, GCE_PERSISTENT_DISK)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, restorePlansId, restoresId, volumeRestoresId		Retrieve the details of a single VolumeRestore.
list	select	projectsId, locationsId, restorePlansId, restoresId	filter, orderBy, pageSize, pageToken	Lists the VolumeRestores for a given Restore.

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
locationsId	string
projectsId	string
restorePlansId	string
restoresId	string
volumeRestoresId	string
filter	string
orderBy	string
pageSize	integer (int32)
pageToken	string

SELECT examples

get

Retrieve the details of a single VolumeRestore.

SELECT
name,
completeTime,
createTime,
etag,
state,
stateMessage,
targetPvc,
uid,
updateTime,
volumeBackup,
volumeHandle,
volumeType
FROM google.gkebackup.volume_restores
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND restorePlansId = '{{ restorePlansId }}' -- required
AND restoresId = '{{ restoresId }}' -- required
AND volumeRestoresId = '{{ volumeRestoresId }}' -- required
;

list

Lists the VolumeRestores for a given Restore.

SELECT
name,
completeTime,
createTime,
etag,
state,
stateMessage,
targetPvc,
uid,
updateTime,
volumeBackup,
volumeHandle,
volumeType
FROM google.gkebackup.volume_restores
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND restorePlansId = '{{ restorePlansId }}' -- required
AND restoresId = '{{ restoresId }}' -- required
AND filter = '{{ filter }}'
AND orderBy = '{{ orderBy }}'
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
;