Backup and DR Service v1 API - Class RestoreVerificationPlan (2.11.0)

public sealed class RestoreVerificationPlan : IMessage<RestoreVerificationPlan>, IEquatable<RestoreVerificationPlan>, IDeepCloneable<RestoreVerificationPlan>, IBufferMessage, IMessage

Reference documentation and code samples for the Backup and DR Service v1 API 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.

Inheritance

object > RestoreVerificationPlan

Namespace

Google.Cloud.BackupDR.V1

Assembly

Google.Cloud.BackupDR.V1.dll

Constructors

RestoreVerificationPlan()

public RestoreVerificationPlan()

RestoreVerificationPlan(RestoreVerificationPlan)

public RestoreVerificationPlan(RestoreVerificationPlan other)
Parameter
Name Description
other RestoreVerificationPlan

Properties

CreateTime

public Timestamp CreateTime { get; set; }

Output only. When the RestoreVerificationPlan was created.

Property Value
Type Description
Timestamp

Description

public string Description { get; set; }

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.

Property Value
Type Description
string

FailureCleanupRule

public RestoreVerificationCleanupRule FailureCleanupRule { get; set; }

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

Property Value
Type Description
RestoreVerificationCleanupRule

Labels

public MapField<string, string> Labels { get; }

Optional. User-defined labels.

Property Value
Type Description
MapFieldstringstring

Name

public string Name { get; set; }

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

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

Property Value
Type Description
string

RestoreVerificationPlanName

public RestoreVerificationPlanName RestoreVerificationPlanName { get; set; }

RestoreVerificationPlanName-typed view over the Name resource name property.

Property Value
Type Description
RestoreVerificationPlanName

Schedule

public string Schedule { get; set; }

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

The schedule is specified as a Crontab string.

Property Value
Type Description
string

State

public RestoreVerificationPlan.Types.State State { get; set; }

Output only. The State for the RestoreVerificationPlan.

Property Value
Type Description
RestoreVerificationPlanTypesState

SuccessCleanupRule

public RestoreVerificationCleanupRule SuccessCleanupRule { get; set; }

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

Property Value
Type Description
RestoreVerificationCleanupRule

TimeZone

public string TimeZone { get; set; }

Optional. Specifies the time zone to be used in interpreting [schedule][google.cloud.backupdr.v1.RestoreVerificationPlan.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.

Property Value
Type Description
string

UpdateTime

public Timestamp UpdateTime { get; set; }

Output only. When the RestoreVerificationPlan was last updated.

Property Value
Type Description
Timestamp