Backup for GKE v1 API - Class RestoreConfig.Types.ClusterResourceRestoreScope (2.4.0)

Version 2.4.0

• 2.6.0 (latest)
• 2.5.0
• 2.4.0
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.0
• 1.0.0-beta01

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.

• 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

Inheritance

object > RestoreConfig.Types.ClusterResourceRestoreScope

Implements

IMessageRestoreConfigTypesClusterResourceRestoreScope, IEquatableRestoreConfigTypesClusterResourceRestoreScope, IDeepCloneableRestoreConfigTypesClusterResourceRestoreScope, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.GkeBackup.V1

Assembly

Google.Cloud.GkeBackup.V1.dll

Constructors

ClusterResourceRestoreScope()

public ClusterResourceRestoreScope()

ClusterResourceRestoreScope(ClusterResourceRestoreScope)

public ClusterResourceRestoreScope(RestoreConfig.Types.ClusterResourceRestoreScope other)

Parameter
Name	Description
other	RestoreConfigTypesClusterResourceRestoreScope

Properties

AllGroupKinds

public bool AllGroupKinds { get; set; }

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

Property Value
Type	Description
bool

ExcludedGroupKinds

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.

Property Value
Type	Description
RepeatedFieldRestoreConfigTypesGroupKind

NoGroupKinds

public bool NoGroupKinds { get; set; }

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.

Property Value
Type	Description
bool

SelectedGroupKinds

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.

Property Value
Type	Description
RepeatedFieldRestoreConfigTypesGroupKind