Reference documentation and code samples for the Google Cloud Gke Backup V1 Client class Restore.
Represents both a request to Restore some portion of a Backup into a target GKE cluster and a record of the restore operation itself.
Next id: 18
Generated from protobuf message google.cloud.gkebackup.v1.Restore
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Output only. The full name of the Restore resource. Format: projects//locations//restorePlans//restores/ |
↳ uid |
string
Output only. Server generated global unique identifier of UUID format. |
↳ create_time |
Google\Protobuf\Timestamp
Output only. The timestamp when this Restore resource was created. |
↳ update_time |
Google\Protobuf\Timestamp
Output only. The timestamp when this Restore resource was last updated. |
↳ description |
string
User specified descriptive string for this Restore. |
↳ backup |
string
Required. Immutable. A reference to the Backup used as the source from which this Restore will restore. Note that this Backup must be a sub-resource of the RestorePlan's backup_plan. Format: projects//locations//backupPlans//backups/. |
↳ cluster |
string
Output only. The target cluster into which this Restore will restore data. Valid formats: - projects//locations//clusters/* - projects//zones//clusters/* Inherited from parent RestorePlan's cluster value. |
↳ restore_config |
Google\Cloud\GkeBackup\V1\RestoreConfig
Output only. Configuration of the Restore. Inherited from parent RestorePlan's restore_config. |
↳ labels |
array|Google\Protobuf\Internal\MapField
A set of custom labels supplied by user. |
↳ state |
int
Output only. The current state of the Restore. |
↳ state_reason |
string
Output only. Human-readable description of why the Restore is in its current state. |
↳ complete_time |
Google\Protobuf\Timestamp
Output only. Timestamp of when the restore operation completed. |
↳ resources_restored_count |
int
Output only. Number of resources restored during the restore execution. |
↳ resources_excluded_count |
int
Output only. Number of resources excluded during the restore execution. |
↳ resources_failed_count |
int
Output only. Number of resources that failed to be restored during the restore execution. |
↳ volumes_restored_count |
int
Output only. Number of volumes restored during the restore execution. |
↳ etag |
string
Output only. |
getName
Output only. The full name of the Restore resource.
Format: projects//locations//restorePlans//restores/
| Returns | |
|---|---|
| Type | Description |
string | |
setName
Output only. The full name of the Restore resource.
Format: projects//locations//restorePlans//restores/
| 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 Restore resource was created.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasCreateTime
clearCreateTime
setCreateTime
Output only. The timestamp when this Restore resource was created.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getUpdateTime
Output only. The timestamp when this Restore resource was last updated.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. The timestamp when this Restore resource was last updated.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDescription
User specified descriptive string for this Restore.
| Returns | |
|---|---|
| Type | Description |
string | |
setDescription
User specified descriptive string for this Restore.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getBackup
Required. Immutable. A reference to the Backup used as the source from which this Restore will restore. Note that this Backup must be a sub-resource of the RestorePlan's backup_plan.
Format: projects//locations//backupPlans//backups/.
| Returns | |
|---|---|
| Type | Description |
string | |
setBackup
Required. Immutable. A reference to the Backup used as the source from which this Restore will restore. Note that this Backup must be a sub-resource of the RestorePlan's backup_plan.
Format: projects//locations//backupPlans//backups/.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getCluster
Output only. The target cluster into which this Restore will restore data.
Valid formats:
- projects//locations//clusters/*
- projects//zones//clusters/* Inherited from parent RestorePlan's cluster value.
| Returns | |
|---|---|
| Type | Description |
string | |
setCluster
Output only. The target cluster into which this Restore will restore data.
Valid formats:
- projects//locations//clusters/*
- projects//zones//clusters/* Inherited from parent RestorePlan's cluster value.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getRestoreConfig
Output only. Configuration of the Restore. Inherited from parent RestorePlan's restore_config.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\GkeBackup\V1\RestoreConfig|null | |
hasRestoreConfig
clearRestoreConfig
setRestoreConfig
Output only. Configuration of the Restore. Inherited from parent RestorePlan's restore_config.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\GkeBackup\V1\RestoreConfig
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getLabels
A set of custom labels supplied by user.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField | |
setLabels
A set of custom labels supplied by user.
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getState
Output only. The current state of the Restore.
| Returns | |
|---|---|
| Type | Description |
int | |
setState
Output only. The current state of the Restore.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getStateReason
Output only. Human-readable description of why the Restore is in its current state.
| Returns | |
|---|---|
| Type | Description |
string | |
setStateReason
Output only. Human-readable description of why the Restore is in its current state.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getCompleteTime
Output only. Timestamp of when the restore operation completed.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasCompleteTime
clearCompleteTime
setCompleteTime
Output only. Timestamp of when the restore operation completed.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getResourcesRestoredCount
Output only. Number of resources restored during the restore execution.
| Returns | |
|---|---|
| Type | Description |
int | |
setResourcesRestoredCount
Output only. Number of resources restored during the restore execution.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getResourcesExcludedCount
Output only. Number of resources excluded during the restore execution.
| Returns | |
|---|---|
| Type | Description |
int | |
setResourcesExcludedCount
Output only. Number of resources excluded during the restore execution.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getResourcesFailedCount
Output only. Number of resources that failed to be restored during the restore execution.
| Returns | |
|---|---|
| Type | Description |
int | |
setResourcesFailedCount
Output only. Number of resources that failed to be restored during the restore execution.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getVolumesRestoredCount
Output only. Number of volumes restored during the restore execution.
| Returns | |
|---|---|
| Type | Description |
int | |
setVolumesRestoredCount
Output only. Number of volumes restored during the restore execution.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getEtag
Output only. etag is used for optimistic concurrency control as a way to help
prevent simultaneous updates of a restore from overwriting each other.
It is strongly suggested that systems make use of the etag in the
read-modify-write cycle to perform restore updates in order to avoid
race conditions: An etag is returned in the response to GetRestore,
and systems are expected to put that etag in the request to
UpdateRestore or DeleteRestore to ensure that their change will be
applied to the same version of the resource.
| Returns | |
|---|---|
| Type | Description |
string | |
setEtag
Output only. etag is used for optimistic concurrency control as a way to help
prevent simultaneous updates of a restore from overwriting each other.
It is strongly suggested that systems make use of the etag in the
read-modify-write cycle to perform restore updates in order to avoid
race conditions: An etag is returned in the response to GetRestore,
and systems are expected to put that etag in the request to
UpdateRestore or DeleteRestore to ensure that their change will be
applied to the same version of the resource.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |