Class: Google::Apis::GkebackupV1::RestoreConfig

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

Configuration of a restore.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ RestoreConfig

Returns a new instance of RestoreConfig.



1990
1991
1992
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 1990

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

Instance Attribute Details

#all_namespaces ⇒ Boolean Also known as: all_namespaces?

Restore all namespaced resources in the Backup if set to "True". Specifying this field to "False" is an error. Corresponds to the JSON property allNamespaces

Returns:

  • (Boolean) 


1899
1900
1901
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 1899

def all_namespaces
  @all_namespaces
end

#cluster_resource_conflict_policy ⇒ String

Optional. Defines the behavior for handling the situation where cluster-scoped resources being restored already exist in the target cluster. This MUST be set to a value other than CLUSTER_RESOURCE_CONFLICT_POLICY_UNSPECIFIED if cluster_resource_restore_scope is not empty. Corresponds to the JSON property clusterResourceConflictPolicy

Returns:

  • (String) 


1908
1909
1910
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 1908

def cluster_resource_conflict_policy
  @cluster_resource_conflict_policy
end

#cluster_resource_restore_scope ⇒ Google::Apis::GkebackupV1::ClusterResourceRestoreScope

Defines the scope of cluster-scoped resources to restore. Some group kinds are not reasonable choices for a restore, and will cause an error if selected here. Any scope selection that would restore "all valid" resources automatically excludes these group kinds. - gkebackup.gke.io/BackupJob - gkebackup.gke.io/ RestoreJob - metrics.k8s.io/NodeMetrics - migration.k8s.io/StorageState - migration.k8s.io/StorageVersionMigration - Node - snapshot.storage.k8s.io/ VolumeSnapshotContent - storage.k8s.io/CSINode Some group kinds are driven by restore configuration elsewhere, and will cause an error if selected here. - Namespace - PersistentVolume Corresponds to the JSON property clusterResourceRestoreScope

Returns:



1921
1922
1923
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 1921

def cluster_resource_restore_scope
  @cluster_resource_restore_scope
end

#excluded_namespaces ⇒ Google::Apis::GkebackupV1::Namespaces

A list of Kubernetes Namespaces. Corresponds to the JSON property excludedNamespaces

Returns:



1926
1927
1928
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 1926

def excluded_namespaces
  @excluded_namespaces
end

#namespaced_resource_restore_mode ⇒ String

Optional. Defines the behavior for handling the situation where sets of namespaced resources being restored already exist in the target cluster. This MUST be set to a value other than NAMESPACED_RESOURCE_RESTORE_MODE_UNSPECIFIED. Corresponds to the JSON property namespacedResourceRestoreMode

Returns:

  • (String) 


1933
1934
1935
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 1933

def namespaced_resource_restore_mode
  @namespaced_resource_restore_mode
end

#no_namespaces ⇒ Boolean Also known as: no_namespaces?

Do not restore any namespaced resources if set to "True". Specifying this field to "False" is not allowed. Corresponds to the JSON property noNamespaces

Returns:

  • (Boolean) 


1939
1940
1941
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 1939

def no_namespaces
  @no_namespaces
end

#restore_order ⇒ Google::Apis::GkebackupV1::RestoreOrder

Allows customers to specify dependencies between resources that Backup for GKE can use to compute a resasonable restore order. Corresponds to the JSON property restoreOrder

Returns:



1946
1947
1948
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 1946

def restore_order
  @restore_order
end

#selected_applications ⇒ Google::Apis::GkebackupV1::NamespacedNames

A list of namespaced Kubernetes resources. Corresponds to the JSON property selectedApplications

Returns:



1951
1952
1953
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 1951

def selected_applications
  @selected_applications
end

#selected_namespaces ⇒ Google::Apis::GkebackupV1::Namespaces

A list of Kubernetes Namespaces. Corresponds to the JSON property selectedNamespaces

Returns:



1956
1957
1958
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 1956

def selected_namespaces
  @selected_namespaces
end

#substitution_rules ⇒ Array<Google::Apis::GkebackupV1::SubstitutionRule>

Optional. A list of transformation rules to be applied against Kubernetes resources as they are selected for restoration from a Backup. Rules are executed in order defined - this order matters, as changes made by a rule may impact the filtering logic of subsequent rules. An empty list means no substitution will occur. Corresponds to the JSON property substitutionRules

Returns:



1965
1966
1967
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 1965

def substitution_rules
  @substitution_rules
end

#transformation_rules ⇒ Array<Google::Apis::GkebackupV1::TransformationRule>

Optional. A list of transformation rules to be applied against Kubernetes resources as they are selected for restoration from a Backup. Rules are executed in order defined - this order matters, as changes made by a rule may impact the filtering logic of subsequent rules. An empty list means no transformation will occur. Corresponds to the JSON property transformationRules

Returns:



1974
1975
1976
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 1974

def transformation_rules
  @transformation_rules
end

#volume_data_restore_policy ⇒ String

Optional. Specifies the mechanism to be used to restore volume data. Default: VOLUME_DATA_RESTORE_POLICY_UNSPECIFIED (will be treated as NO_VOLUME_DATA_RESTORATION). Corresponds to the JSON property volumeDataRestorePolicy

Returns:

  • (String) 


1981
1982
1983
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 1981

def volume_data_restore_policy
  @volume_data_restore_policy
end

#volume_data_restore_policy_bindings ⇒ Array<Google::Apis::GkebackupV1::VolumeDataRestorePolicyBinding>

Optional. A table that binds volumes by their scope to a restore policy. Bindings must have a unique scope. Any volumes not scoped in the bindings are subject to the policy defined in volume_data_restore_policy. Corresponds to the JSON property volumeDataRestorePolicyBindings

Returns:



1988
1989
1990
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 1988

def volume_data_restore_policy_bindings
  @volume_data_restore_policy_bindings
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 1995

def update!(**args)
  @all_namespaces = args[:all_namespaces] if args.key?(:all_namespaces)
  @cluster_resource_conflict_policy = args[:cluster_resource_conflict_policy] if args.key?(:cluster_resource_conflict_policy)
  @cluster_resource_restore_scope = args[:cluster_resource_restore_scope] if args.key?(:cluster_resource_restore_scope)
  @excluded_namespaces = args[:excluded_namespaces] if args.key?(:excluded_namespaces)
  @namespaced_resource_restore_mode = args[:namespaced_resource_restore_mode] if args.key?(:namespaced_resource_restore_mode)
  @no_namespaces = args[:no_namespaces] if args.key?(:no_namespaces)
  @restore_order = args[:restore_order] if args.key?(:restore_order)
  @selected_applications = args[:selected_applications] if args.key?(:selected_applications)
  @selected_namespaces = args[:selected_namespaces] if args.key?(:selected_namespaces)
  @substitution_rules = args[:substitution_rules] if args.key?(:substitution_rules)
  @transformation_rules = args[:transformation_rules] if args.key?(:transformation_rules)
  @volume_data_restore_policy = args[:volume_data_restore_policy] if args.key?(:volume_data_restore_policy)
  @volume_data_restore_policy_bindings = args[:volume_data_restore_policy_bindings] if args.key?(:volume_data_restore_policy_bindings)
end