Backup for GKE V1 API - Class Google::Cloud::GkeBackup::V1::RestorePlan (v0.10.0)

Reference documentation and code samples for the Backup for GKE V1 API class Google::Cloud::GkeBackup::V1::RestorePlan.

The configuration of a potential series of Restore operations to be performed against Backups belong to a particular BackupPlan.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#backup_plan

def backup_plan() -> ::String
Returns
  • (::String) — Required. Immutable. A reference to the BackupPlan from which Backups may be used as the source for Restores created via this RestorePlan. Format: projects/*/locations/*/backupPlans/*.

#backup_plan=

def backup_plan=(value) -> ::String
Parameter
  • value (::String) — Required. Immutable. A reference to the BackupPlan from which Backups may be used as the source for Restores created via this RestorePlan. Format: projects/*/locations/*/backupPlans/*.
Returns
  • (::String) — Required. Immutable. A reference to the BackupPlan from which Backups may be used as the source for Restores created via this RestorePlan. Format: projects/*/locations/*/backupPlans/*.

#cluster

def cluster() -> ::String
Returns
  • (::String) —

    Required. Immutable. The target cluster into which Restores created via this RestorePlan will restore data. NOTE: the cluster's region must be the same as the RestorePlan. Valid formats:

    • projects/*/locations/*/clusters/*
    • projects/*/zones/*/clusters/*

#cluster=

def cluster=(value) -> ::String
Parameter
  • value (::String) —

    Required. Immutable. The target cluster into which Restores created via this RestorePlan will restore data. NOTE: the cluster's region must be the same as the RestorePlan. Valid formats:

    • projects/*/locations/*/clusters/*
    • projects/*/zones/*/clusters/*
Returns
  • (::String) —

    Required. Immutable. The target cluster into which Restores created via this RestorePlan will restore data. NOTE: the cluster's region must be the same as the RestorePlan. Valid formats:

    • projects/*/locations/*/clusters/*
    • projects/*/zones/*/clusters/*

#create_time

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

#description

def description() -> ::String
Returns
  • (::String) — Optional. User specified descriptive string for this RestorePlan.

#description=

def description=(value) -> ::String
Parameter
  • value (::String) — Optional. User specified descriptive string for this RestorePlan.
Returns
  • (::String) — Optional. User specified descriptive string for this RestorePlan.

#etag

def etag() -> ::String
Returns
  • (::String) — Output only. etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a restore from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform restore updates in order to avoid race conditions: An etag is returned in the response to GetRestorePlan, and systems are expected to put that etag in the request to UpdateRestorePlan or DeleteRestorePlan to ensure that their change will be applied to the same version of the resource.

#labels

def labels() -> ::Google::Protobuf::Map{::String => ::String}
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — Optional. A set of custom labels supplied by user.

#labels=

def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
  • value (::Google::Protobuf::Map{::String => ::String}) — Optional. A set of custom labels supplied by user.
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — Optional. A set of custom labels supplied by user.

#name

def name() -> ::String
Returns
  • (::String) — Output only. The full name of the RestorePlan resource. Format: projects/*/locations/*/restorePlans/*.

#restore_config

def restore_config() -> ::Google::Cloud::GkeBackup::V1::RestoreConfig
Returns

#restore_config=

def restore_config=(value) -> ::Google::Cloud::GkeBackup::V1::RestoreConfig
Parameter
Returns

#state

def state() -> ::Google::Cloud::GkeBackup::V1::RestorePlan::State
Returns

#state_reason

def state_reason() -> ::String
Returns
  • (::String) — Output only. Human-readable description of why RestorePlan is in the current state

#uid

def uid() -> ::String
Returns
  • (::String) — Output only. Server generated global unique identifier of UUID format.

#update_time

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