Google Cloud Backup Dr V1beta Client - Class RestoreTemplate (0.17.0)

Reference documentation and code samples for the Google Cloud Backup Dr V1beta Client class RestoreTemplate.

A RestoreTemplate encapsulates DR readiness configurations for validating backups.

Generated from protobuf message google.cloud.backupdr.v1beta.RestoreTemplate

Namespace

Google \ Cloud \ BackupDR \ V1beta

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ name string

Identifier. The resource name of the RestoreTemplate.

↳ description string

Optional. User-provided description of the restore template.

↳ create_time Google\Protobuf\Timestamp

Output only. The time when the restore template was created.

↳ update_time Google\Protobuf\Timestamp

Output only. The time when the restore template was last updated.

↳ resource_type string

Required. Immutable. The specific type of the workload being restored. The format is "{service_name}/{resource_kind}", for example, "compute.googleapis.com/Instance".

↳ labels array|Google\Protobuf\Internal\MapField

Optional. User-defined labels.

↳ backup_selection_config BackupSelectionConfig

Required. Backup selection configuration.

↳ pre_restore_config PreRestoreConfig

Optional. Pre-restore configuration.

↳ post_restore_config PostRestoreConfig

Optional. Post-restore configuration.

↳ verification_config VerificationConfig

Optional. Verification configuration.

↳ restore_properties Google\Protobuf\Struct

Required. Defines target environments where the resource will be restored. The target resource name in restore_properties supports the {EXECUTION_ID} token to dynamically generate unique resource names for each execution. During restore execution, every occurrence of {EXECUTION_ID} in the target resource name is replaced with the 8-character RestoreTemplateExecution ID (for example, "restored-resource-{EXECUTION_ID}" or "restored-{EXECUTION_ID}-resource" resolves to "restored-resource-5d437b06" or "restored-5d437b06-resource").

↳ state int

Output only. The state of the restore template.

↳ execution_summary ExecutionSummary

Output only. Summary of the last execution.

↳ etag string

Optional. Etag for concurrency control.

getName

Identifier. The resource name of the RestoreTemplate.

Returns
Type Description
string

setName

Identifier. The resource name of the RestoreTemplate.

Parameter
Name Description
var string
Returns
Type Description
$this

getDescription

Optional. User-provided description of the restore template.

Returns
Type Description
string

setDescription

Optional. User-provided description of the restore template.

Parameter
Name Description
var string
Returns
Type Description
$this

getCreateTime

Output only. The time when the restore template was created.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. The time when the restore template was created.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getUpdateTime

Output only. The time when the restore template was last updated.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. The time when the restore template was last updated.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getResourceType

Required. Immutable. The specific type of the workload being restored.

The format is "{service_name}/{resource_kind}", for example, "compute.googleapis.com/Instance".

Returns
Type Description
string

setResourceType

Required. Immutable. The specific type of the workload being restored.

The format is "{service_name}/{resource_kind}", for example, "compute.googleapis.com/Instance".

Parameter
Name Description
var string
Returns
Type Description
$this

getLabels

Optional. User-defined labels.

Returns
Type Description
Google\Protobuf\Internal\MapField

setLabels

Optional. User-defined labels.

Parameter
Name Description
var array|Google\Protobuf\Internal\MapField
Returns
Type Description
$this

getBackupSelectionConfig

Required. Backup selection configuration.

Returns
Type Description
BackupSelectionConfig|null

hasBackupSelectionConfig

clearBackupSelectionConfig

setBackupSelectionConfig

Required. Backup selection configuration.

Parameter
Name Description
var BackupSelectionConfig
Returns
Type Description
$this

getPreRestoreConfig

Optional. Pre-restore configuration.

Returns
Type Description
PreRestoreConfig|null

hasPreRestoreConfig

clearPreRestoreConfig

setPreRestoreConfig

Optional. Pre-restore configuration.

Parameter
Name Description
var PreRestoreConfig
Returns
Type Description
$this

getPostRestoreConfig

Optional. Post-restore configuration.

Returns
Type Description
PostRestoreConfig|null

hasPostRestoreConfig

clearPostRestoreConfig

setPostRestoreConfig

Optional. Post-restore configuration.

Parameter
Name Description
var PostRestoreConfig
Returns
Type Description
$this

getVerificationConfig

Optional. Verification configuration.

Returns
Type Description
VerificationConfig|null

hasVerificationConfig

clearVerificationConfig

setVerificationConfig

Optional. Verification configuration.

Parameter
Name Description
var VerificationConfig
Returns
Type Description
$this

getRestoreProperties

Required. Defines target environments where the resource will be restored.

The target resource name in restore_properties supports the {EXECUTION_ID} token to dynamically generate unique resource names for each execution. During restore execution, every occurrence of {EXECUTION_ID} in the target resource name is replaced with the 8-character RestoreTemplateExecution ID (for example, "restored-resource-{EXECUTION_ID}" or "restored-{EXECUTION_ID}-resource" resolves to "restored-resource-5d437b06" or "restored-5d437b06-resource").

Returns
Type Description
Google\Protobuf\Struct|null

hasRestoreProperties

clearRestoreProperties

setRestoreProperties

Required. Defines target environments where the resource will be restored.

The target resource name in restore_properties supports the {EXECUTION_ID} token to dynamically generate unique resource names for each execution. During restore execution, every occurrence of {EXECUTION_ID} in the target resource name is replaced with the 8-character RestoreTemplateExecution ID (for example, "restored-resource-{EXECUTION_ID}" or "restored-{EXECUTION_ID}-resource" resolves to "restored-resource-5d437b06" or "restored-5d437b06-resource").

Parameter
Name Description
var Google\Protobuf\Struct
Returns
Type Description
$this

getState

Output only. The state of the restore template.

Returns
Type Description
int Enum of type State.

setState

Output only. The state of the restore template.

Parameter
Name Description
var int

Enum of type State.

Returns
Type Description
$this

getExecutionSummary

Output only. Summary of the last execution.

Returns
Type Description
ExecutionSummary|null

hasExecutionSummary

clearExecutionSummary

setExecutionSummary

Output only. Summary of the last execution.

Parameter
Name Description
var ExecutionSummary
Returns
Type Description
$this

getEtag

Optional. Etag for concurrency control.

Returns
Type Description
string

setEtag

Optional. Etag for concurrency control.

Parameter
Name Description
var string
Returns
Type Description
$this