Google Cloud Gke Backup V1 Client - Class VolumeRestore (0.7.2)

Version latest

• 0.7.2 (latest)
• 0.7.1
• 0.6.0
• 0.5.3
• 0.4.0
• 0.3.1
• 0.2.0
• 0.1.7

Reference documentation and code samples for the Google Cloud Gke Backup V1 Client class VolumeRestore.

Represents the operation of restoring a volume from a VolumeBackup.

Generated from protobuf message google.cloud.gkebackup.v1.VolumeRestore

Namespace

Google \ Cloud \ GkeBackup \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ 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.
↳ create_time	Google\Protobuf\Timestamp Output only. The timestamp when this VolumeRestore resource was created.
↳ update_time	Google\Protobuf\Timestamp Output only. The timestamp when this VolumeRestore resource was last updated.
↳ volume_backup	string Output only. The full name of the VolumeBackup from which the volume will be restored. Format: projects/*/locations/*/backupPlans/*/backups/*/volumeBackups/*.
↳ target_pvc	Google\Cloud\GkeBackup\V1\NamespacedName Output only. The reference to the target Kubernetes PVC to be restored.
↳ volume_handle	string Output only. A storage system-specific opaque handler to the underlying volume created for the target PVC from the volume backup.
↳ volume_type	int Output only. The type of volume provisioned
↳ complete_time	Google\Protobuf\Timestamp Output only. The timestamp when the associated underlying volume restoration completed.
↳ state	int Output only. The current state of this VolumeRestore.
↳ state_message	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.

getName

Output only. Full name of the VolumeRestore resource.

Format: projects/*/locations/*/restorePlans/*/restores/*/volumeRestores/*

Returns
Type	Description
string

setName

Output only. Full name of the VolumeRestore resource.

Format: projects/*/locations/*/restorePlans/*/restores/*/volumeRestores/*

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getUid

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

Returns
Type	Description
string

setUid

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

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getCreateTime

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

Returns
Type	Description
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

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

Parameter
Name	Description
var	Google\Protobuf\Timestamp

Returns
Type	Description
$this

getUpdateTime

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

Returns
Type	Description
Google\Protobuf\Timestamp|null

hasUpdateTime

clearUpdateTime

setUpdateTime

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

Parameter
Name	Description
var	Google\Protobuf\Timestamp

Returns
Type	Description
$this

getVolumeBackup

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

Returns
Type	Description
string

setVolumeBackup

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

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getTargetPvc

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

Returns
Type	Description
Google\Cloud\GkeBackup\V1\NamespacedName|null

hasTargetPvc

clearTargetPvc

setTargetPvc

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

Parameter
Name	Description
var	Google\Cloud\GkeBackup\V1\NamespacedName

Returns
Type	Description
$this

getVolumeHandle

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

Returns
Type	Description
string

setVolumeHandle

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

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getVolumeType

Output only. The type of volume provisioned

Returns
Type	Description
int

setVolumeType

Output only. The type of volume provisioned

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getCompleteTime

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

Returns
Type	Description
Google\Protobuf\Timestamp|null

hasCompleteTime

clearCompleteTime

setCompleteTime

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

Parameter
Name	Description
var	Google\Protobuf\Timestamp

Returns
Type	Description
$this

getState

Output only. The current state of this VolumeRestore.

Returns
Type	Description
int

setState

Output only. The current state of this VolumeRestore.

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getStateMessage

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

Returns
Type	Description
string

setStateMessage

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

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getEtag

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.

Returns
Type	Description
string

setEtag

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.

Parameter
Name	Description
var	string

Returns
Type	Description
$this