Backup for GKE V1 API - Class Google::Cloud::GkeBackup::V1::RestoreConfig::ClusterResourceRestoreScope (v0.8.0)

Reference documentation and code samples for the Backup for GKE V1 API class Google::Cloud::GkeBackup::V1::RestoreConfig::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

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#all_group_kinds

def all_group_kinds() -> ::Boolean
Returns
  • (::Boolean) — If True, all valid cluster-scoped resources will be restored. Mutually exclusive to any other field in the message.

#all_group_kinds=

def all_group_kinds=(value) -> ::Boolean
Parameter
  • value (::Boolean) — If True, all valid cluster-scoped resources will be restored. Mutually exclusive to any other field in the message.
Returns
  • (::Boolean) — If True, all valid cluster-scoped resources will be restored. Mutually exclusive to any other field in the message.

#excluded_group_kinds

def excluded_group_kinds() -> ::Array<::Google::Cloud::GkeBackup::V1::RestoreConfig::GroupKind>
Returns
  • (::Array<::Google::Cloud::GkeBackup::V1::RestoreConfig::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.

#excluded_group_kinds=

def excluded_group_kinds=(value) -> ::Array<::Google::Cloud::GkeBackup::V1::RestoreConfig::GroupKind>
Parameter
  • value (::Array<::Google::Cloud::GkeBackup::V1::RestoreConfig::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.
Returns
  • (::Array<::Google::Cloud::GkeBackup::V1::RestoreConfig::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.

#no_group_kinds

def no_group_kinds() -> ::Boolean
Returns
  • (::Boolean) — 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.

#no_group_kinds=

def no_group_kinds=(value) -> ::Boolean
Parameter
  • value (::Boolean) — 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.
Returns
  • (::Boolean) — 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.

#selected_group_kinds

def selected_group_kinds() -> ::Array<::Google::Cloud::GkeBackup::V1::RestoreConfig::GroupKind>
Returns

#selected_group_kinds=

def selected_group_kinds=(value) -> ::Array<::Google::Cloud::GkeBackup::V1::RestoreConfig::GroupKind>
Parameter
Returns