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.



1864
1865
1866
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 1864

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) 


1755
1756
1757
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 1755

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) 


1762
1763
1764
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 1762

def cluster
  @cluster
end

#complete_time ⇒ String

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

Returns:

  • (String) 


1767
1768
1769
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 1767

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) 


1772
1773
1774
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 1772

def create_time
  @create_time
end

#description ⇒ String

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

Returns:

  • (String) 


1777
1778
1779
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 1777

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) 


1788
1789
1790
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 1788

def etag
  @etag
end

#filter ⇒ Google::Apis::GkebackupV1::Filter

Defines the filter for Restore. This filter can be used to further refine the resource selection of the Restore beyond the coarse-grained scope defined in the RestorePlan. exclusion_filters take precedence over inclusion_filters. If a resource matches both inclusion_filters and exclusion_filters, it will not be restored. Corresponds to the JSON property filter

Returns:



1797
1798
1799
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 1797

def filter
  @filter
end

#labels ⇒ Hash<String,String>

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

Returns:

  • (Hash<String,String>) 


1802
1803
1804
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 1802

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) 


1808
1809
1810
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 1808

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) 


1813
1814
1815
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 1813

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) 


1819
1820
1821
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 1819

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) 


1824
1825
1826
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 1824

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:



1829
1830
1831
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 1829

def restore_config
  @restore_config
end

#state ⇒ String

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

Returns:

  • (String) 


1834
1835
1836
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 1834

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) 


1840
1841
1842
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 1840

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) 


1846
1847
1848
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 1846

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) 


1851
1852
1853
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 1851

def update_time
  @update_time
end

#volume_data_restore_policy_overrides ⇒ Array<Google::Apis::GkebackupV1::VolumeDataRestorePolicyOverride>

Optional. Immutable. Overrides the volume data restore policies selected in the Restore Config for override-scoped resources. Corresponds to the JSON property volumeDataRestorePolicyOverrides

Returns:



1857
1858
1859
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 1857

def volume_data_restore_policy_overrides
  @volume_data_restore_policy_overrides
end

#volumes_restored_count ⇒ Fixnum

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

Returns:

  • (Fixnum) 


1862
1863
1864
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 1862

def volumes_restored_count
  @volumes_restored_count
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 1869

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