Class RestoreConfig (0.4.0)

RestoreConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Configuration of a restore. Next id: 9

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Attributes

Name	Description
`volume_data_restore_policy`	`google.cloud.gke_backup_v1.types.RestoreConfig.VolumeDataRestorePolicy` Specifies the mechanism to be used to restore volume data. Default: VOLUME_DATA_RESTORE_POLICY_UNSPECIFIED (will be treated as NO_VOLUME_DATA_RESTORATION).
`cluster_resource_conflict_policy`	`google.cloud.gke_backup_v1.types.RestoreConfig.ClusterResourceConflictPolicy` 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 is not empty.
`namespaced_resource_restore_mode`	`google.cloud.gke_backup_v1.types.RestoreConfig.NamespacedResourceRestoreMode` 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.
`cluster_resource_restore_scope`	`google.cloud.gke_backup_v1.types.RestoreConfig.ClusterResourceRestoreScope` Identifies the cluster-scoped resources to restore from the Backup. Not specifying it means NO cluster resource will be restored.
`all_namespaces`	`bool` Restore all namespaced resources in the Backup if set to "True". Specifying this field to "False" is an error. This field is a member of `oneof`_ `namespaced_resource_restore_scope`.
`selected_namespaces`	`google.cloud.gke_backup_v1.types.Namespaces` A list of selected Namespaces to restore from the Backup. The listed Namespaces and all resources contained in them will be restored. This field is a member of `oneof`_ `namespaced_resource_restore_scope`.
`selected_applications`	`google.cloud.gke_backup_v1.types.NamespacedNames` A list of selected ProtectedApplications to restore. The listed ProtectedApplications and all the resources to which they refer will be restored. This field is a member of `oneof`_ `namespaced_resource_restore_scope`.
`substitution_rules`	`MutableSequence[google.cloud.gke_backup_v1.types.RestoreConfig.SubstitutionRule]` 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.

Classes

ClusterResourceConflictPolicy

ClusterResourceConflictPolicy(value)

Defines the behavior for handling the situation where cluster-scoped resources being restored already exist in the target cluster.

ClusterResourceRestoreScope

ClusterResourceRestoreScope(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Identifies the cluster-scoped resources to restore from the Backup.

GroupKind

GroupKind(mapping=None, *, ignore_unknown_fields=False, **kwargs)

This is a direct map to the Kubernetes GroupKind type GroupKind <https://godoc.org/k8s.io/apimachinery/pkg/runtime/schema#GroupKind>__ and is used for identifying specific "types" of resources to restore.

NamespacedResourceRestoreMode

NamespacedResourceRestoreMode(value)

Defines the behavior for handling the situation where sets of namespaced resources being restored already exist in the target cluster.

SubstitutionRule

SubstitutionRule(mapping=None, *, ignore_unknown_fields=False, **kwargs)

A transformation rule to be applied against Kubernetes resources as they are selected for restoration from a Backup. A rule contains both filtering logic (which resources are subject to substitution) and substitution logic.

VolumeDataRestorePolicy

VolumeDataRestorePolicy(value)

Defines how volume data should be restored