Backup for GKE v1 API - Class RestoreConfig (2.3.0)

public sealed class RestoreConfig : IMessage<RestoreConfig>, IEquatable<RestoreConfig>, IDeepCloneable<RestoreConfig>, IBufferMessage, IMessage

Reference documentation and code samples for the Backup for GKE v1 API class RestoreConfig.

Configuration of a restore. Next id: 12

Inheritance

object > RestoreConfig

Namespace

Google.Cloud.GkeBackup.V1

Assembly

Google.Cloud.GkeBackup.V1.dll

Constructors

RestoreConfig()

public RestoreConfig()

RestoreConfig(RestoreConfig)

public RestoreConfig(RestoreConfig other)
Parameter
NameDescription
otherRestoreConfig

Properties

AllNamespaces

public bool AllNamespaces { get; set; }

Restore all namespaced resources in the Backup if set to "True". Specifying this field to "False" is an error.

Property Value
TypeDescription
bool

ClusterResourceConflictPolicy

public RestoreConfig.Types.ClusterResourceConflictPolicy ClusterResourceConflictPolicy { get; set; }

Defines the behavior for handling the situation where cluster-scoped resources being restored already exist in the target cluster. This MUST be set to a value other than CLUSTER_RESOURCE_CONFLICT_POLICY_UNSPECIFIED if [cluster_resource_restore_scope][google.cloud.gkebackup.v1.RestoreConfig.cluster_resource_restore_scope] is not empty.

Property Value
TypeDescription
RestoreConfigTypesClusterResourceConflictPolicy

ClusterResourceRestoreScope

public RestoreConfig.Types.ClusterResourceRestoreScope ClusterResourceRestoreScope { get; set; }

Identifies the cluster-scoped resources to restore from the Backup. Not specifying it means NO cluster resource will be restored.

Property Value
TypeDescription
RestoreConfigTypesClusterResourceRestoreScope

ExcludedNamespaces

public Namespaces ExcludedNamespaces { get; set; }

A list of selected namespaces excluded from restoration. All namespaces except those in this list will be restored.

Property Value
TypeDescription
Namespaces

HasAllNamespaces

public bool HasAllNamespaces { get; }

Gets whether the "all_namespaces" field is set

Property Value
TypeDescription
bool

HasNoNamespaces

public bool HasNoNamespaces { get; }

Gets whether the "no_namespaces" field is set

Property Value
TypeDescription
bool

NamespacedResourceRestoreMode

public RestoreConfig.Types.NamespacedResourceRestoreMode NamespacedResourceRestoreMode { get; set; }

Defines the behavior for handling the situation where sets of namespaced resources being restored already exist in the target cluster. This MUST be set to a value other than NAMESPACED_RESOURCE_RESTORE_MODE_UNSPECIFIED.

Property Value
TypeDescription
RestoreConfigTypesNamespacedResourceRestoreMode

NamespacedResourceRestoreScopeCase

public RestoreConfig.NamespacedResourceRestoreScopeOneofCase NamespacedResourceRestoreScopeCase { get; }
Property Value
TypeDescription
RestoreConfigNamespacedResourceRestoreScopeOneofCase

NoNamespaces

public bool NoNamespaces { get; set; }

Do not restore any namespaced resources if set to "True". Specifying this field to "False" is not allowed.

Property Value
TypeDescription
bool

SelectedApplications

public NamespacedNames SelectedApplications { get; set; }

A list of selected ProtectedApplications to restore. The listed ProtectedApplications and all the resources to which they refer will be restored.

Property Value
TypeDescription
NamespacedNames

SelectedNamespaces

public Namespaces SelectedNamespaces { get; set; }

A list of selected Namespaces to restore from the Backup. The listed Namespaces and all resources contained in them will be restored.

Property Value
TypeDescription
Namespaces

SubstitutionRules

public RepeatedField<RestoreConfig.Types.SubstitutionRule> SubstitutionRules { get; }

A list of transformation rules to be applied against Kubernetes resources as they are selected for restoration from a Backup. Rules are executed in order defined - this order matters, as changes made by a rule may impact the filtering logic of subsequent rules. An empty list means no substitution will occur.

Property Value
TypeDescription
RepeatedFieldRestoreConfigTypesSubstitutionRule

TransformationRules

public RepeatedField<RestoreConfig.Types.TransformationRule> TransformationRules { get; }

A list of transformation rules to be applied against Kubernetes resources as they are selected for restoration from a Backup. Rules are executed in order defined - this order matters, as changes made by a rule may impact the filtering logic of subsequent rules. An empty list means no transformation will occur.

Property Value
TypeDescription
RepeatedFieldRestoreConfigTypesTransformationRule

VolumeDataRestorePolicy

public RestoreConfig.Types.VolumeDataRestorePolicy VolumeDataRestorePolicy { get; set; }

Specifies the mechanism to be used to restore volume data. Default: VOLUME_DATA_RESTORE_POLICY_UNSPECIFIED (will be treated as NO_VOLUME_DATA_RESTORATION).

Property Value
TypeDescription
RestoreConfigTypesVolumeDataRestorePolicy