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. Next id: 11

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ RestorePlan

Returns a new instance of RestorePlan.



1608
1609
1610
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 1608

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) 


1549
1550
1551
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 1549

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) 


1557
1558
1559
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 1557

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) 


1562
1563
1564
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 1562

def create_time
  @create_time
end

#description ⇒ String

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

Returns:

  • (String) 


1567
1568
1569
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 1567

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) 


1579
1580
1581
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 1579

def etag
  @etag
end

#labels ⇒ Hash<String,String>

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

Returns:

  • (Hash<String,String>) 


1584
1585
1586
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 1584

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) 


1590
1591
1592
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 1590

def name
  @name
end

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

Configuration of a restore. Next id: 9 Corresponds to the JSON property restoreConfig

Returns:



1595
1596
1597
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 1595

def restore_config
  @restore_config
end

#uid ⇒ String

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

Returns:

  • (String) 


1601
1602
1603
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 1601

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) 


1606
1607
1608
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 1606

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 1613

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)
  @uid = args[:uid] if args.key?(:uid)
  @update_time = args[:update_time] if args.key?(:update_time)
end