Reference documentation and code samples for the Google Cloud Backup Dr V1 Client class RestoreTemplateExecution.
A RestoreTemplateExecution represents a single historical or active
execution run.
Generated from protobuf message google.cloud.backupdr.v1.RestoreTemplateExecution
Namespace
Google \ Cloud \ BackupDR \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Identifier. Resource name of the execution. |
↳ resource_type |
string
Output only. The workload resource type being restored. The format is "{service_name}/{resource_kind}", for example, "compute.googleapis.com/Instance". |
↳ create_time |
Google\Protobuf\Timestamp
Output only. Create time of the execution. |
↳ update_time |
Google\Protobuf\Timestamp
Output only. Update time of the execution. |
↳ type |
int
Output only. The type of the execution. |
↳ phase |
int
Output only. The current active phase. |
↳ state |
int
Output only. State of the execution. |
↳ prepare_phase_info |
PreparePhaseInfo
Output only. Info for the prepare phase. |
↳ pre_restore_phase_info |
PreRestorePhaseInfo
Output only. Info for the pre-restore phase. |
↳ restore_phase_info |
RestorePhaseInfo
Output only. Info for the restore phase. |
↳ post_restore_phase_info |
PostRestorePhaseInfo
Output only. Info for the post-restore phase. |
↳ verification_phase_info |
VerificationPhaseInfo
Output only. Info for the verification phase. |
↳ cleanup_phase_info |
CleanupPhaseInfo
Output only. Info for the cleanup phase. |
getName
Identifier. Resource name of the execution.
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
Identifier. Resource name of the execution.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getResourceType
Output only. The workload resource type being restored.
The format is "{service_name}/{resource_kind}", for example, "compute.googleapis.com/Instance".
| Returns | |
|---|---|
| Type | Description |
string |
|
setResourceType
Output only. The workload resource type being restored.
The format is "{service_name}/{resource_kind}", for example, "compute.googleapis.com/Instance".
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCreateTime
Output only. Create time of the execution.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasCreateTime
clearCreateTime
setCreateTime
Output only. Create time of the execution.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getUpdateTime
Output only. Update time of the execution.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. Update time of the execution.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getType
Output only. The type of the execution.
| Returns | |
|---|---|
| Type | Description |
int |
Enum of type ExecutionType. |
setType
Output only. The type of the execution.
| Parameter | |
|---|---|
| Name | Description |
var |
int
Enum of type ExecutionType. |
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPhase
Output only. The current active phase.
| Returns | |
|---|---|
| Type | Description |
int |
Enum of type ExecutionPhase. |
setPhase
Output only. The current active phase.
| Parameter | |
|---|---|
| Name | Description |
var |
int
Enum of type ExecutionPhase. |
| Returns | |
|---|---|
| Type | Description |
$this |
|
getState
Output only. State of the execution.
| Returns | |
|---|---|
| Type | Description |
int |
Enum of type ExecutionState. |
setState
Output only. State of the execution.
| Parameter | |
|---|---|
| Name | Description |
var |
int
Enum of type ExecutionState. |
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPreparePhaseInfo
Output only. Info for the prepare phase.
| Returns | |
|---|---|
| Type | Description |
PreparePhaseInfo|null |
|
hasPreparePhaseInfo
clearPreparePhaseInfo
setPreparePhaseInfo
Output only. Info for the prepare phase.
| Parameter | |
|---|---|
| Name | Description |
var |
PreparePhaseInfo
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPreRestorePhaseInfo
Output only. Info for the pre-restore phase.
| Returns | |
|---|---|
| Type | Description |
PreRestorePhaseInfo|null |
|
hasPreRestorePhaseInfo
clearPreRestorePhaseInfo
setPreRestorePhaseInfo
Output only. Info for the pre-restore phase.
| Parameter | |
|---|---|
| Name | Description |
var |
PreRestorePhaseInfo
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getRestorePhaseInfo
Output only. Info for the restore phase.
| Returns | |
|---|---|
| Type | Description |
RestorePhaseInfo|null |
|
hasRestorePhaseInfo
clearRestorePhaseInfo
setRestorePhaseInfo
Output only. Info for the restore phase.
| Parameter | |
|---|---|
| Name | Description |
var |
RestorePhaseInfo
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPostRestorePhaseInfo
Output only. Info for the post-restore phase.
| Returns | |
|---|---|
| Type | Description |
PostRestorePhaseInfo|null |
|
hasPostRestorePhaseInfo
clearPostRestorePhaseInfo
setPostRestorePhaseInfo
Output only. Info for the post-restore phase.
| Parameter | |
|---|---|
| Name | Description |
var |
PostRestorePhaseInfo
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getVerificationPhaseInfo
Output only. Info for the verification phase.
| Returns | |
|---|---|
| Type | Description |
VerificationPhaseInfo|null |
|
hasVerificationPhaseInfo
clearVerificationPhaseInfo
setVerificationPhaseInfo
Output only. Info for the verification phase.
| Parameter | |
|---|---|
| Name | Description |
var |
VerificationPhaseInfo
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCleanupPhaseInfo
Output only. Info for the cleanup phase.
| Returns | |
|---|---|
| Type | Description |
CleanupPhaseInfo|null |
|
hasCleanupPhaseInfo
clearCleanupPhaseInfo
setCleanupPhaseInfo
Output only. Info for the cleanup phase.
| Parameter | |
|---|---|
| Name | Description |
var |
CleanupPhaseInfo
|
| Returns | |
|---|---|
| Type | Description |
$this |
|