Class: Google::Apis::GkebackupV1::RestorePlan

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/gkebackup_v1/classes.rb,
lib/google/apis/gkebackup_v1/representations.rb,
lib/google/apis/gkebackup_v1/representations.rb

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ RestorePlan

Returns a new instance of RestorePlan.



2121
2122
2123
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 2121

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#backup_plan ⇒ 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/*. Corresponds to the JSON property backupPlan

Returns:

  • (String) 


2049
2050
2051
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 2049

def backup_plan
  @backup_plan
end

#cluster ⇒ 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/* Corresponds to the JSON property cluster

Returns:

  • (String) 


2057
2058
2059
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 2057

def cluster
  @cluster
end

#create_time ⇒ String

Output only. The timestamp when this RestorePlan resource was created. Corresponds to the JSON property createTime

Returns:

  • (String) 


2062
2063
2064
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 2062

def create_time
  @create_time
end

#description ⇒ String

Optional. User specified descriptive string for this RestorePlan. Corresponds to the JSON property description

Returns:

  • (String) 


2067
2068
2069
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 2067

def description
  @description
end

#etag ⇒ 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. Corresponds to the JSON property etag

Returns:

  • (String) 


2079
2080
2081
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 2079

def etag
  @etag
end

#labels ⇒ Hash<String,String>

Optional. A set of custom labels supplied by user. Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>) 


2084
2085
2086
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 2084

def labels
  @labels
end

#name ⇒ String

Output only. The full name of the RestorePlan resource. Format: projects/*/ locations/*/restorePlans/*. Corresponds to the JSON property name

Returns:

  • (String) 


2090
2091
2092
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 2090

def name
  @name
end

#restore_config ⇒ Google::Apis::GkebackupV1::RestoreConfig

Configuration of a restore. Corresponds to the JSON property restoreConfig

Returns:



2095
2096
2097
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 2095

def restore_config
  @restore_config
end

#state ⇒ String

Output only. State of the RestorePlan. This State field reflects the various stages a RestorePlan can be in during the Create operation. Corresponds to the JSON property state

Returns:

  • (String) 


2101
2102
2103
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 2101

def state
  @state
end

#state_reason ⇒ String

Output only. Human-readable description of why RestorePlan is in the current state. This field is only meant for human readability and should not be used programmatically as this field is not guaranteed to be consistent. Corresponds to the JSON property stateReason

Returns:

  • (String) 


2108
2109
2110
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 2108

def state_reason
  @state_reason
end

#uid ⇒ String

Output only. Server generated global unique identifier of UUID format. Corresponds to the JSON property uid

Returns:

  • (String) 


2114
2115
2116
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 2114

def uid
  @uid
end

#update_time ⇒ String

Output only. The timestamp when this RestorePlan resource was last updated. Corresponds to the JSON property updateTime

Returns:

  • (String) 


2119
2120
2121
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 2119

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 2126

def update!(**args)
  @backup_plan = args[:backup_plan] if args.key?(:backup_plan)
  @cluster = args[:cluster] if args.key?(:cluster)
  @create_time = args[:create_time] if args.key?(:create_time)
  @description = args[:description] if args.key?(:description)
  @etag = args[:etag] if args.key?(:etag)
  @labels = args[:labels] if args.key?(:labels)
  @name = args[:name] if args.key?(:name)
  @restore_config = args[:restore_config] if args.key?(:restore_config)
  @state = args[:state] if args.key?(:state)
  @state_reason = args[:state_reason] if args.key?(:state_reason)
  @uid = args[:uid] if args.key?(:uid)
  @update_time = args[:update_time] if args.key?(:update_time)
end