Class: Google::Apis::GkebackupV1::Restore

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

Represents both a request to Restore some portion of a Backup into a target GKE cluster and a record of the restore operation itself.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Restore

Returns a new instance of Restore.



1714
1715
1716
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 1714

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

Instance Attribute Details

#backup ⇒ String

Required. Immutable. A reference to the Backup used as the source from which this Restore will restore. Note that this Backup must be a sub-resource of the RestorePlan's backup_plan. Format: projects/*/locations/*/backupPlans/*/ backups/*. Corresponds to the JSON property backup

Returns:

  • (String) 


1620
1621
1622
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 1620

def backup
  @backup
end

#cluster ⇒ String

Output only. The target cluster into which this Restore will restore data. Valid formats: - projects/*/locations/*/clusters/* - projects/*/zones/*/ clusters/* Inherited from parent RestorePlan's cluster value. Corresponds to the JSON property cluster

Returns:

  • (String) 


1627
1628
1629
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 1627

def cluster
  @cluster
end

#complete_time ⇒ String

Output only. Timestamp of when the restore operation completed. Corresponds to the JSON property completeTime

Returns:

  • (String) 


1632
1633
1634
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 1632

def complete_time
  @complete_time
end

#create_time ⇒ String

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

Returns:

  • (String) 


1637
1638
1639
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 1637

def create_time
  @create_time
end

#description ⇒ String

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

Returns:

  • (String) 


1642
1643
1644
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 1642

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 GetRestore, and systems are expected to put that etag in the request to UpdateRestore or DeleteRestore to ensure that their change will be applied to the same version of the resource. Corresponds to the JSON property etag

Returns:

  • (String) 


1653
1654
1655
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 1653

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>) 


1658
1659
1660
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 1658

def labels
  @labels
end

#name ⇒ String

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

Returns:

  • (String) 


1664
1665
1666
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 1664

def name
  @name
end

#resources_excluded_count ⇒ Fixnum

Output only. Number of resources excluded during the restore execution. Corresponds to the JSON property resourcesExcludedCount

Returns:

  • (Fixnum) 


1669
1670
1671
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 1669

def resources_excluded_count
  @resources_excluded_count
end

#resources_failed_count ⇒ Fixnum

Output only. Number of resources that failed to be restored during the restore execution. Corresponds to the JSON property resourcesFailedCount

Returns:

  • (Fixnum) 


1675
1676
1677
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 1675

def resources_failed_count
  @resources_failed_count
end

#resources_restored_count ⇒ Fixnum

Output only. Number of resources restored during the restore execution. Corresponds to the JSON property resourcesRestoredCount

Returns:

  • (Fixnum) 


1680
1681
1682
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 1680

def resources_restored_count
  @resources_restored_count
end

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

Configuration of a restore. Corresponds to the JSON property restoreConfig

Returns:



1685
1686
1687
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 1685

def restore_config
  @restore_config
end

#state ⇒ String

Output only. The current state of the Restore. Corresponds to the JSON property state

Returns:

  • (String) 


1690
1691
1692
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 1690

def state
  @state
end

#state_reason ⇒ String

Output only. Human-readable description of why the Restore is in its current state. Corresponds to the JSON property stateReason

Returns:

  • (String) 


1696
1697
1698
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 1696

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) 


1702
1703
1704
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 1702

def uid
  @uid
end

#update_time ⇒ String

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

Returns:

  • (String) 


1707
1708
1709
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 1707

def update_time
  @update_time
end

#volumes_restored_count ⇒ Fixnum

Output only. Number of volumes restored during the restore execution. Corresponds to the JSON property volumesRestoredCount

Returns:

  • (Fixnum) 


1712
1713
1714
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 1712

def volumes_restored_count
  @volumes_restored_count
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 1719

def update!(**args)
  @backup = args[:backup] if args.key?(:backup)
  @cluster = args[:cluster] if args.key?(:cluster)
  @complete_time = args[:complete_time] if args.key?(:complete_time)
  @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)
  @resources_excluded_count = args[:resources_excluded_count] if args.key?(:resources_excluded_count)
  @resources_failed_count = args[:resources_failed_count] if args.key?(:resources_failed_count)
  @resources_restored_count = args[:resources_restored_count] if args.key?(:resources_restored_count)
  @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)
  @volumes_restored_count = args[:volumes_restored_count] if args.key?(:volumes_restored_count)
end