Class: Google::Apis::GkebackupV1::ClusterResourceRestoreScope

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

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ ClusterResourceRestoreScope

Returns a new instance of ClusterResourceRestoreScope.



646
647
648
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 646

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

Instance Attribute Details

#all_group_kinds ⇒ Boolean Also known as: all_group_kinds?

If True, all valid cluster-scoped resources will be restored. Mutually exclusive to any other field in the message. Corresponds to the JSON property allGroupKinds

Returns:

  • (Boolean) 


620
621
622
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 620

def all_group_kinds
  @all_group_kinds
end

#excluded_group_kinds ⇒ Array<Google::Apis::GkebackupV1::GroupKind>

A list of cluster-scoped resource group kinds to NOT restore from the backup. If specified, all valid cluster-scoped resources will be restored except for those specified in the list. Mutually exclusive to any other field in the message. Corresponds to the JSON property excludedGroupKinds

Returns:



629
630
631
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 629

def excluded_group_kinds
  @excluded_group_kinds
end

#no_group_kinds ⇒ Boolean Also known as: no_group_kinds?

If True, no cluster-scoped resources will be restored. This has the same restore scope as if the message is not defined. Mutually exclusive to any other field in the message. Corresponds to the JSON property noGroupKinds

Returns:

  • (Boolean) 


636
637
638
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 636

def no_group_kinds
  @no_group_kinds
end

#selected_group_kinds ⇒ Array<Google::Apis::GkebackupV1::GroupKind>

A list of cluster-scoped resource group kinds to restore from the backup. If specified, only the selected resources will be restored. Mutually exclusive to any other field in the message. Corresponds to the JSON property selectedGroupKinds

Returns:



644
645
646
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 644

def selected_group_kinds
  @selected_group_kinds
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



651
652
653
654
655
656
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 651

def update!(**args)
  @all_group_kinds = args[:all_group_kinds] if args.key?(:all_group_kinds)
  @excluded_group_kinds = args[:excluded_group_kinds] if args.key?(:excluded_group_kinds)
  @no_group_kinds = args[:no_group_kinds] if args.key?(:no_group_kinds)
  @selected_group_kinds = args[:selected_group_kinds] if args.key?(:selected_group_kinds)
end