public sealed class RestoreConfig.Types.ClusterResourceRestoreScope : IMessage<RestoreConfig.Types.ClusterResourceRestoreScope>, IEquatable<RestoreConfig.Types.ClusterResourceRestoreScope>, IDeepCloneable<RestoreConfig.Types.ClusterResourceRestoreScope>, IBufferMessage, IMessage
Reference documentation and code samples for the Backup for GKE v1 API class RestoreConfig.Types.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.
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.
public RepeatedField<RestoreConfig.Types.GroupKind> ExcludedGroupKinds { get; }
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.
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.
public RepeatedField<RestoreConfig.Types.GroupKind> SelectedGroupKinds { get; }
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-28 UTC."],[[["\u003cp\u003eThe \u003ccode\u003eClusterResourceRestoreScope\u003c/code\u003e class in the Google Cloud GKE Backup v1 API defines the scope of cluster-scoped resources to be restored.\u003c/p\u003e\n"],["\u003cp\u003eIt provides options to restore all valid cluster-scoped resources, no cluster-scoped resources, or a specific list of cluster-scoped resource group kinds.\u003c/p\u003e\n"],["\u003cp\u003eCertain resource types, such as \u003ccode\u003egkebackup.gke.io/BackupJob\u003c/code\u003e and \u003ccode\u003eNode\u003c/code\u003e, are excluded by default during restore, while others like \u003ccode\u003eNamespace\u003c/code\u003e and \u003ccode\u003ePersistentVolume\u003c/code\u003e are driven by separate configurations.\u003c/p\u003e\n"],["\u003cp\u003eThe class offers mutually exclusive options for defining the scope, including restoring all, excluding specific types, or selecting only specific types, allowing for granular control over the restoration process.\u003c/p\u003e\n"],["\u003cp\u003eThere are multiple versions available for the class, ranging from version \u003ccode\u003e1.0.0-beta01\u003c/code\u003e to the most recent \u003ccode\u003e2.6.0\u003c/code\u003e.\u003c/p\u003e\n"]]],[],null,["# Backup for GKE v1 API - Class RestoreConfig.Types.ClusterResourceRestoreScope (2.8.0)\n\nVersion latestkeyboard_arrow_down\n\n- [2.8.0 (latest)](/dotnet/docs/reference/Google.Cloud.GkeBackup.V1/latest/Google.Cloud.GkeBackup.V1.RestoreConfig.Types.ClusterResourceRestoreScope)\n- [2.7.0](/dotnet/docs/reference/Google.Cloud.GkeBackup.V1/2.7.0/Google.Cloud.GkeBackup.V1.RestoreConfig.Types.ClusterResourceRestoreScope)\n- [2.6.0](/dotnet/docs/reference/Google.Cloud.GkeBackup.V1/2.6.0/Google.Cloud.GkeBackup.V1.RestoreConfig.Types.ClusterResourceRestoreScope)\n- [2.5.0](/dotnet/docs/reference/Google.Cloud.GkeBackup.V1/2.5.0/Google.Cloud.GkeBackup.V1.RestoreConfig.Types.ClusterResourceRestoreScope)\n- [2.4.0](/dotnet/docs/reference/Google.Cloud.GkeBackup.V1/2.4.0/Google.Cloud.GkeBackup.V1.RestoreConfig.Types.ClusterResourceRestoreScope)\n- [2.3.0](/dotnet/docs/reference/Google.Cloud.GkeBackup.V1/2.3.0/Google.Cloud.GkeBackup.V1.RestoreConfig.Types.ClusterResourceRestoreScope)\n- [2.2.0](/dotnet/docs/reference/Google.Cloud.GkeBackup.V1/2.2.0/Google.Cloud.GkeBackup.V1.RestoreConfig.Types.ClusterResourceRestoreScope)\n- [2.1.0](/dotnet/docs/reference/Google.Cloud.GkeBackup.V1/2.1.0/Google.Cloud.GkeBackup.V1.RestoreConfig.Types.ClusterResourceRestoreScope)\n- [2.0.0](/dotnet/docs/reference/Google.Cloud.GkeBackup.V1/2.0.0/Google.Cloud.GkeBackup.V1.RestoreConfig.Types.ClusterResourceRestoreScope)\n- [1.0.0-beta01](/dotnet/docs/reference/Google.Cloud.GkeBackup.V1/1.0.0-beta01/Google.Cloud.GkeBackup.V1.RestoreConfig.Types.ClusterResourceRestoreScope) \n\n public sealed class RestoreConfig.Types.ClusterResourceRestoreScope : IMessage\u003cRestoreConfig.Types.ClusterResourceRestoreScope\u003e, IEquatable\u003cRestoreConfig.Types.ClusterResourceRestoreScope\u003e, IDeepCloneable\u003cRestoreConfig.Types.ClusterResourceRestoreScope\u003e, IBufferMessage, IMessage\n\nReference documentation and code samples for the Backup for GKE v1 API class RestoreConfig.Types.ClusterResourceRestoreScope.\n\nDefines the scope of cluster-scoped resources to restore.\n\nSome group kinds are not reasonable choices for a restore, and will cause\nan error if selected here. Any scope selection that would restore\n\"all valid\" resources automatically excludes these group kinds.\n\n- Node\n- ComponentStatus\n- gkebackup.gke.io/BackupJob\n- gkebackup.gke.io/RestoreJob\n- metrics.k8s.io/NodeMetrics\n- migration.k8s.io/StorageState\n- migration.k8s.io/StorageVersionMigration\n- snapshot.storage.k8s.io/VolumeSnapshotContent\n- storage.k8s.io/CSINode\n- storage.k8s.io/VolumeAttachment\n\nSome group kinds are driven by restore configuration elsewhere,\nand will cause an error if selected here.\n\n- Namespace\n- PersistentVolume \n\nInheritance\n-----------\n\n[object](https://learn.microsoft.com/dotnet/api/system.object) \\\u003e RestoreConfig.Types.ClusterResourceRestoreScope \n\nImplements\n----------\n\n[IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage-1.html)[RestoreConfig](/dotnet/docs/reference/Google.Cloud.GkeBackup.V1/latest/Google.Cloud.GkeBackup.V1.RestoreConfig)[Types](/dotnet/docs/reference/Google.Cloud.GkeBackup.V1/latest/Google.Cloud.GkeBackup.V1.RestoreConfig.Types)[ClusterResourceRestoreScope](/dotnet/docs/reference/Google.Cloud.GkeBackup.V1/latest/Google.Cloud.GkeBackup.V1.RestoreConfig.Types.ClusterResourceRestoreScope), [IEquatable](https://learn.microsoft.com/dotnet/api/system.iequatable-1)[RestoreConfig](/dotnet/docs/reference/Google.Cloud.GkeBackup.V1/latest/Google.Cloud.GkeBackup.V1.RestoreConfig)[Types](/dotnet/docs/reference/Google.Cloud.GkeBackup.V1/latest/Google.Cloud.GkeBackup.V1.RestoreConfig.Types)[ClusterResourceRestoreScope](/dotnet/docs/reference/Google.Cloud.GkeBackup.V1/latest/Google.Cloud.GkeBackup.V1.RestoreConfig.Types.ClusterResourceRestoreScope), [IDeepCloneable](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IDeepCloneable-1.html)[RestoreConfig](/dotnet/docs/reference/Google.Cloud.GkeBackup.V1/latest/Google.Cloud.GkeBackup.V1.RestoreConfig)[Types](/dotnet/docs/reference/Google.Cloud.GkeBackup.V1/latest/Google.Cloud.GkeBackup.V1.RestoreConfig.Types)[ClusterResourceRestoreScope](/dotnet/docs/reference/Google.Cloud.GkeBackup.V1/latest/Google.Cloud.GkeBackup.V1.RestoreConfig.Types.ClusterResourceRestoreScope), [IBufferMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IBufferMessage.html), [IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage.html) \n\nInherited Members\n-----------------\n\n[object.GetHashCode()](https://learn.microsoft.com/dotnet/api/system.object.gethashcode) \n[object.GetType()](https://learn.microsoft.com/dotnet/api/system.object.gettype) \n[object.ToString()](https://learn.microsoft.com/dotnet/api/system.object.tostring)\n\nNamespace\n---------\n\n[Google.Cloud.GkeBackup.V1](/dotnet/docs/reference/Google.Cloud.GkeBackup.V1/latest/Google.Cloud.GkeBackup.V1)\n\nAssembly\n--------\n\nGoogle.Cloud.GkeBackup.V1.dll\n\nConstructors\n------------\n\n### ClusterResourceRestoreScope()\n\n public ClusterResourceRestoreScope()\n\n### ClusterResourceRestoreScope(ClusterResourceRestoreScope)\n\n public ClusterResourceRestoreScope(RestoreConfig.Types.ClusterResourceRestoreScope other)\n\nProperties\n----------\n\n### AllGroupKinds\n\n public bool AllGroupKinds { get; set; }\n\nOptional. If True, all valid cluster-scoped resources will be restored.\nMutually exclusive to any other field in the message.\n\n### ExcludedGroupKinds\n\n public RepeatedField\u003cRestoreConfig.Types.GroupKind\u003e ExcludedGroupKinds { get; }\n\nOptional. A list of cluster-scoped resource group kinds to NOT restore\nfrom the backup. If specified, all valid cluster-scoped resources will be\nrestored except for those specified in the list.\nMutually exclusive to any other field in the message.\n\n### NoGroupKinds\n\n public bool NoGroupKinds { get; set; }\n\nOptional. If True, no cluster-scoped resources will be restored.\nThis has the same restore scope as if the message is not defined.\nMutually exclusive to any other field in the message.\n\n### SelectedGroupKinds\n\n public RepeatedField\u003cRestoreConfig.Types.GroupKind\u003e SelectedGroupKinds { get; }\n\nOptional. A list of cluster-scoped resource group kinds to restore from\nthe backup. If specified, only the selected resources will be restored.\nMutually exclusive to any other field in the message."]]
