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.



2798
2799
2800
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 2798

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) 


2681
2682
2683
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 2681

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) 


2688
2689
2690
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 2688

def cluster
  @cluster
end

#complete_time ⇒ String

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

Returns:

  • (String) 


2693
2694
2695
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 2693

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) 


2698
2699
2700
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 2698

def create_time
  @create_time
end

#description ⇒ String

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

Returns:

  • (String) 


2703
2704
2705
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 2703

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) 


2714
2715
2716
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 2714

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:



2723
2724
2725
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 2723

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


2728
2729
2730
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 2728

def labels
  @labels
end

#name ⇒ String

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

Returns:

  • (String) 


2734
2735
2736
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 2734

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) 


2739
2740
2741
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 2739

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) 


2745
2746
2747
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 2745

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) 


2750
2751
2752
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 2750

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:



2755
2756
2757
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 2755

def restore_config
  @restore_config
end

#state ⇒ String

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

Returns:

  • (String) 


2760
2761
2762
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 2760

def state
  @state
end

#state_reason ⇒ String

Output only. Human-readable description of why the Restore is in its 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) 


2767
2768
2769
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 2767

def state_reason
  @state_reason
end

#troubleshooting_info ⇒ Google::Apis::GkebackupV1::TroubleshootingInfo

Stores information about troubleshooting doc for debugging a particular state of an operation (eg - backup/restore). This will be used by the end user to debug their operation failure scenario easily. Corresponds to the JSON property troubleshootingInfo

Returns:



2774
2775
2776
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 2774

def troubleshooting_info
  @troubleshooting_info
end

#uid ⇒ String

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

Returns:

  • (String) 


2780
2781
2782
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 2780

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) 


2785
2786
2787
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 2785

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:



2791
2792
2793
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 2791

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) 


2796
2797
2798
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 2796

def volumes_restored_count
  @volumes_restored_count
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 2803

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