RestorePlanRestoreConfig class
Constructors
-
RestorePlanRestoreConfig({Input<bool?>? allNamespaces, Input<String?>? clusterResourceConflictPolicy, Input<RestorePlanRestoreConfigClusterResourceRestoreScope?>? clusterResourceRestoreScope, Input<RestorePlanRestoreConfigExcludedNamespaces?>? excludedNamespaces, Input<String?>? namespacedResourceRestoreMode, Input<bool?>? noNamespaces, Input<RestorePlanRestoreConfigRestoreOrder?>? restoreOrder, Input<RestorePlanRestoreConfigSelectedApplications?>? selectedApplications, Input<RestorePlanRestoreConfigSelectedNamespaces?>? selectedNamespaces, Input<List<RestorePlanRestoreConfigTransformationRule>?>? transformationRules, Input<String?>? volumeDataRestorePolicy, Input<List<RestorePlanRestoreConfigVolumeDataRestorePolicyBinding>?>? volumeDataRestorePolicyBindings})
-
Creates a new RestorePlanRestoreConfig.
allNamespaces If True, restore all namespaced resources in the Backup.
clusterResourceConflictPolicy Defines the behavior for handling the situation where cluster-scoped resources
clusterResourceRestoreScope Identifies the cluster-scoped resources to restore from the Backup.
excludedNamespaces A list of selected namespaces excluded from restoration.
namespacedResourceRestoreMode Defines the behavior for handling the situation where sets of namespaced resources
noNamespaces Do not restore any namespaced resources if set to "True".
restoreOrder It contains custom ordering to use on a Restore.
selectedApplications A list of selected ProtectedApplications to restore.
selectedNamespaces A list of selected namespaces to restore from the Backup.
transformationRules A list of transformation rules to be applied against Kubernetes
volumeDataRestorePolicy Specifies the mechanism to be used to restore volume data.
volumeDataRestorePolicyBindings A table that binds volumes by their scope to a restore policy. Bindings
const
-
RestorePlanRestoreConfig.fromMap(Map<String, dynamic> map)
-
factory
Properties
-
allNamespaces
→ Input<bool?>?
-
If True, restore all namespaced resources in the Backup.
Setting this field to False will result in an error.
final
-
clusterResourceConflictPolicy
→ Input<String?>?
-
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 clusterResourceRestoreScope is anyting other than noGroupKinds.
See https://cloud.google.com/kubernetes-engine/docs/add-on/backup-for-gke/reference/rest/v1/RestoreConfig#clusterresourceconflictpolicy
for more information on each policy option.
Possible values are: USE_EXISTING_VERSION, USE_BACKUP_VERSION.
final
-
clusterResourceRestoreScope
→ Input<RestorePlanRestoreConfigClusterResourceRestoreScope?>?
-
Identifies the cluster-scoped resources to restore from the Backup.
Structure is documented below.
final
-
excludedNamespaces
→ Input<RestorePlanRestoreConfigExcludedNamespaces?>?
-
A list of selected namespaces excluded from restoration.
All namespaces except those in this list will be restored.
Structure is documented below.
final
-
hashCode
→ int
-
The hash code for this object.
no setterinherited
-
namespacedResourceRestoreMode
→ Input<String?>?
-
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
if the namespacedResourceRestoreScope is anything other than noNamespaces.
See https://cloud.google.com/kubernetes-engine/docs/add-on/backup-for-gke/reference/rest/v1/RestoreConfig#namespacedresourcerestoremode
for more information on each mode.
Possible values are: DELETE_AND_RESTORE, FAIL_ON_CONFLICT, MERGE_SKIP_ON_CONFLICT, MERGE_REPLACE_VOLUME_ON_CONFLICT, MERGE_REPLACE_ON_CONFLICT.
final
-
noNamespaces
→ Input<bool?>?
-
Do not restore any namespaced resources if set to "True".
Specifying this field to "False" is not allowed.
final
-
restoreOrder
→ Input<RestorePlanRestoreConfigRestoreOrder?>?
-
It contains custom ordering to use on a Restore.
Structure is documented below.
final
-
runtimeType
→ Type
-
A representation of the runtime type of the object.
no setterinherited
-
selectedApplications
→ Input<RestorePlanRestoreConfigSelectedApplications?>?
-
A list of selected ProtectedApplications to restore.
The listed ProtectedApplications and all the resources
to which they refer will be restored.
Structure is documented below.
final
-
selectedNamespaces
→ Input<RestorePlanRestoreConfigSelectedNamespaces?>?
-
A list of selected namespaces to restore from the Backup.
The listed Namespaces and all resources contained in them will be restored.
Structure is documented below.
final
-
transformationRules
→ Input<List<RestorePlanRestoreConfigTransformationRule>?>?
-
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.
Structure is documented below.
final
-
volumeDataRestorePolicy
→ Input<String?>?
-
Specifies the mechanism to be used to restore volume data.
This should be set to a value other than
NAMESPACED_RESOURCE_RESTORE_MODE_UNSPECIFIED
if the namespacedResourceRestoreScope is anything other than noNamespaces.
If not specified, it will be treated as NO_VOLUME_DATA_RESTORATION.
See https://cloud.google.com/kubernetes-engine/docs/add-on/backup-for-gke/reference/rest/v1/RestoreConfig#VolumeDataRestorePolicy
for more information on each policy option.
Possible values are: RESTORE_VOLUME_DATA_FROM_BACKUP, REUSE_VOLUME_HANDLE_FROM_BACKUP, NO_VOLUME_DATA_RESTORATION.
final
-
volumeDataRestorePolicyBindings
→ Input<List<RestorePlanRestoreConfigVolumeDataRestorePolicyBinding>?>?
-
A table that binds volumes by their scope to a restore policy. Bindings
must have a unique scope. Any volumes not scoped in the bindings are
subject to the policy defined in volume_data_restore_policy.
Structure is documented below.
final
