Backup and DR Service V1 API - Class Google::Cloud::BackupDR::V1::RestoreVerificationPlan (v1.13.0)

Reference documentation and code samples for the Backup and DR Service V1 API class Google::Cloud::BackupDR::V1::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.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#create_time

def create_time() -> ::Google::Protobuf::Timestamp
Returns

#description

def description() -> ::String
Returns
  • (::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.

#description=

def description=(value) -> ::String
Parameter
  • value (::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.

Returns
  • (::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.

#failure_cleanup_rule

def failure_cleanup_rule() -> ::Google::Cloud::BackupDR::V1::RestoreVerificationCleanupRule
Returns

#failure_cleanup_rule=

def failure_cleanup_rule=(value) -> ::Google::Cloud::BackupDR::V1::RestoreVerificationCleanupRule
Parameter
Returns

#labels

def labels() -> ::Google::Protobuf::Map{::String => ::String}
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — Optional. User-defined labels.

#labels=

def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
  • value (::Google::Protobuf::Map{::String => ::String}) — Optional. User-defined labels.
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — Optional. User-defined labels.

#name

def name() -> ::String
Returns
  • (::String) — Output only. Identifier. The resource name of the RestoreVerificationPlan.

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

#schedule

def schedule() -> ::String
Returns
  • (::String) — Required. Describes the schedule on which the restore verification will be executed.

    The schedule is specified as a Crontab string.

#schedule=

def schedule=(value) -> ::String
Parameter
  • value (::String) — Required. Describes the schedule on which the restore verification will be executed.

    The schedule is specified as a Crontab string.

Returns
  • (::String) — Required. Describes the schedule on which the restore verification will be executed.

    The schedule is specified as a Crontab string.

#state

def state() -> ::Google::Cloud::BackupDR::V1::RestoreVerificationPlan::State
Returns

#success_cleanup_rule

def success_cleanup_rule() -> ::Google::Cloud::BackupDR::V1::RestoreVerificationCleanupRule
Returns

#success_cleanup_rule=

def success_cleanup_rule=(value) -> ::Google::Cloud::BackupDR::V1::RestoreVerificationCleanupRule
Parameter
Returns

#time_zone

def time_zone() -> ::String
Returns
  • (::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.

#time_zone=

def time_zone=(value) -> ::String
Parameter
  • value (::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.
Returns
  • (::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.

#update_time

def update_time() -> ::Google::Protobuf::Timestamp
Returns