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. - Node - ComponentStatus - gkebackup.gke.io/ BackupJob - gkebackup.gke.io/RestoreJob - metrics.k8s.io/NodeMetrics - migration.k8s.io/StorageState - migration.k8s.io/StorageVersionMigration - snapshot.storage.k8s.io/VolumeSnapshotContent - storage.k8s.io/CSINode - storage.k8s.io/VolumeAttachment 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.



1037
1038
1039
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 1037

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

Instance Attribute Details

#all_group_kinds ⇒ Boolean Also known as: all_group_kinds?

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


1011
1012
1013
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 1011

def all_group_kinds
  @all_group_kinds
end

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

Optional. 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:



1020
1021
1022
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 1020

def excluded_group_kinds
  @excluded_group_kinds
end

#no_group_kinds ⇒ Boolean Also known as: no_group_kinds?

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


1027
1028
1029
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 1027

def no_group_kinds
  @no_group_kinds
end

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

Optional. 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:



1035
1036
1037
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 1035

def selected_group_kinds
  @selected_group_kinds
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1042
1043
1044
1045
1046
1047
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 1042

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