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

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

A RestoreVerificationPlan specifies the scheduling and clean-up template for automated restore verification. It contains a schedule to dictate when the verifications should run, and a RestoreVerificationCleanupRule for post-verification resource deletion.

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

Namespace

Google \ Cloud \ BackupDR \ V1beta

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ name string

Output only. Identifier. The resource name of the RestoreVerificationPlan. Format: projects/{project}/locations/{location}/restoreVerificationPlans/{restoreVerificationPlan}

↳ description string

Optional. The description of the RestoreVerificationPlan resource. The description allows for additional details about RestoreVerificationPlan and its use cases to be provided. An example description is the following: "This is a restore verification plan that performs a daily verification and cleans up the resources immediately after." The description must be at most 2048 characters.

↳ create_time Google\Protobuf\Timestamp

Output only. When the RestoreVerificationPlan was created.

↳ update_time Google\Protobuf\Timestamp

Output only. When the RestoreVerificationPlan was last updated.

↳ labels array|Google\Protobuf\Internal\MapField

Optional. User-defined labels.

↳ state int

Output only. The State for the RestoreVerificationPlan.

↳ schedule string

Required. Describes the schedule on which the restore verification will be executed. The schedule is specified as a Crontab string.

↳ time_zone string

Optional. Specifies the time zone to be used in interpreting schedule. The value of this field must be a time zone name from the tz database, like "America/New_York" or "UTC". Defaults to UTC if not specified.

↳ success_cleanup_rule RestoreVerificationCleanupRule

Optional. The cleanup rule to apply if the restore verification succeeds.

↳ failure_cleanup_rule RestoreVerificationCleanupRule

Optional. The cleanup rule to apply if the restore verification fails.

getName

Output only. Identifier. The resource name of the RestoreVerificationPlan.

Format: projects/{project}/locations/{location}/restoreVerificationPlans/{restoreVerificationPlan}

Returns
Type Description
string

setName

Output only. Identifier. The resource name of the RestoreVerificationPlan.

Format: projects/{project}/locations/{location}/restoreVerificationPlans/{restoreVerificationPlan}

Parameter
Name Description
var string
Returns
Type Description
$this

getDescription

Optional. The description of the RestoreVerificationPlan resource.

The description allows for additional details about RestoreVerificationPlan and its use cases to be provided. An example description is the following: "This is a restore verification plan that performs a daily verification and cleans up the resources immediately after." The description must be at most 2048 characters.

Returns
Type Description
string

setDescription

Optional. The description of the RestoreVerificationPlan resource.

The description allows for additional details about RestoreVerificationPlan and its use cases to be provided. An example description is the following: "This is a restore verification plan that performs a daily verification and cleans up the resources immediately after." The description must be at most 2048 characters.

Parameter
Name Description
var string
Returns
Type Description
$this

getCreateTime

Output only. When the RestoreVerificationPlan was created.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. When the RestoreVerificationPlan was created.

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

getUpdateTime

Output only. When the RestoreVerificationPlan was last updated.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. When the RestoreVerificationPlan was last updated.

Parameter
Name Description
var Google\Protobuf\Timestamp
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

getState

Output only. The State for the RestoreVerificationPlan.

Returns
Type Description
int Enum of type State.

setState

Output only. The State for the RestoreVerificationPlan.

Parameter
Name Description
var int

Enum of type State.

Returns
Type Description
$this

getSchedule

Required. Describes the schedule on which the restore verification will be executed.

The schedule is specified as a Crontab string.

Returns
Type Description
string

setSchedule

Required. Describes the schedule on which the restore verification will be executed.

The schedule is specified as a Crontab string.

Parameter
Name Description
var string
Returns
Type Description
$this

getTimeZone

Optional. Specifies the time zone to be used in interpreting schedule.

The value of this field must be a time zone name from the tz database, like "America/New_York" or "UTC". Defaults to UTC if not specified.

Returns
Type Description
string

setTimeZone

Optional. Specifies the time zone to be used in interpreting schedule.

The value of this field must be a time zone name from the tz database, like "America/New_York" or "UTC". Defaults to UTC if not specified.

Parameter
Name Description
var string
Returns
Type Description
$this

getSuccessCleanupRule

Optional. The cleanup rule to apply if the restore verification succeeds.

Returns
Type Description
RestoreVerificationCleanupRule|null

hasSuccessCleanupRule

clearSuccessCleanupRule

setSuccessCleanupRule

Optional. The cleanup rule to apply if the restore verification succeeds.

Parameter
Name Description
var RestoreVerificationCleanupRule
Returns
Type Description
$this

getFailureCleanupRule

Optional. The cleanup rule to apply if the restore verification fails.

Returns
Type Description
RestoreVerificationCleanupRule|null

hasFailureCleanupRule

clearFailureCleanupRule

setFailureCleanupRule

Optional. The cleanup rule to apply if the restore verification fails.

Parameter
Name Description
var RestoreVerificationCleanupRule
Returns
Type Description
$this