REST Resource: projects.locations.restorePlans.restores.volumeRestores

Resource: VolumeRestore

Represents the operation of restoring a volume from a VolumeBackup.

JSON representation
{
  "name": string,
  "uid": string,
  "createTime": string,
  "updateTime": string,
  "volumeBackup": string,
  "targetPvc": {
    object (NamespacedName)
  },
  "volumeHandle": string,
  "volumeType": enum (VolumeType),
  "completeTime": string,
  "state": enum (State),
  "stateMessage": string,
  "etag": string
}
Fields
name

string

Output only. Full name of the VolumeRestore resource. Format: projects/*/locations/*/restorePlans/*/restores/*/volumeRestores/*

uid

string

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

createTime

string (Timestamp format)

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

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

updateTime

string (Timestamp format)

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

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

volumeBackup

string

Output only. The full name of the VolumeBackup from which the volume will be restored. Format: projects/*/locations/*/backupPlans/*/backups/*/volumeBackups/*.

targetPvc

object (NamespacedName)

Output only. The reference to the target Kubernetes PVC to be restored.

volumeHandle

string

Output only. A storage system-specific opaque handler to the underlying volume created for the target PVC from the volume backup.

volumeType

enum (VolumeType)

Output only. The type of volume provisioned

completeTime

string (Timestamp format)

Output only. The timestamp when the associated underlying volume restoration completed.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

state

enum (State)

Output only. The current state of this VolumeRestore.

stateMessage

string

Output only. A human readable message explaining why the VolumeRestore is in its current state.

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.

VolumeType

Supported volume types.

Enums
VOLUME_TYPE_UNSPECIFIED Default
GCE_PERSISTENT_DISK Compute Engine Persistent Disk volume

State

The current state of a VolumeRestore

Enums
STATE_UNSPECIFIED This is an illegal state and should not be encountered.
CREATING A volume for the restore was identified and restore process is about to start.
RESTORING The volume is currently being restored.
SUCCEEDED The volume has been successfully restored.
FAILED The volume restoration process failed.
DELETING This VolumeRestore resource is in the process of being deleted.

Methods

get

Retrieve the details of a single VolumeRestore.

getIamPolicy

Gets the access control policy for a resource.

list

Lists the VolumeRestores for a given Restore.

setIamPolicy

Sets the access control policy on the specified resource.

testIamPermissions

Returns permissions that a caller has on the specified resource.