Reference documentation and code samples for the Backup for GKE V1 API class Google::Cloud::GkeBackup::V1::RestoreConfig.
Configuration of a restore.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#all_namespaces
def all_namespaces() -> ::Boolean-
(::Boolean) — Restore all namespaced resources in the Backup if set to "True".
Specifying this field to "False" is an error.
Note: The following fields are mutually exclusive:
all_namespaces,selected_namespaces,selected_applications,no_namespaces,excluded_namespaces. If a field in that set is populated, all other fields in the set will automatically be cleared.
#all_namespaces=
def all_namespaces=(value) -> ::Boolean-
value (::Boolean) — Restore all namespaced resources in the Backup if set to "True".
Specifying this field to "False" is an error.
Note: The following fields are mutually exclusive:
all_namespaces,selected_namespaces,selected_applications,no_namespaces,excluded_namespaces. If a field in that set is populated, all other fields in the set will automatically be cleared.
-
(::Boolean) — Restore all namespaced resources in the Backup if set to "True".
Specifying this field to "False" is an error.
Note: The following fields are mutually exclusive:
all_namespaces,selected_namespaces,selected_applications,no_namespaces,excluded_namespaces. If a field in that set is populated, all other fields in the set will automatically be cleared.
#cluster_resource_conflict_policy
def cluster_resource_conflict_policy() -> ::Google::Cloud::GkeBackup::V1::RestoreConfig::ClusterResourceConflictPolicy- (::Google::Cloud::GkeBackup::V1::RestoreConfig::ClusterResourceConflictPolicy) — Optional. 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.
#cluster_resource_conflict_policy=
def cluster_resource_conflict_policy=(value) -> ::Google::Cloud::GkeBackup::V1::RestoreConfig::ClusterResourceConflictPolicy- value (::Google::Cloud::GkeBackup::V1::RestoreConfig::ClusterResourceConflictPolicy) — Optional. 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.
- (::Google::Cloud::GkeBackup::V1::RestoreConfig::ClusterResourceConflictPolicy) — Optional. 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.
#cluster_resource_restore_scope
def cluster_resource_restore_scope() -> ::Google::Cloud::GkeBackup::V1::RestoreConfig::ClusterResourceRestoreScope- (::Google::Cloud::GkeBackup::V1::RestoreConfig::ClusterResourceRestoreScope) — Optional. Identifies the cluster-scoped resources to restore from the Backup. Not specifying it means NO cluster resource will be restored.
#cluster_resource_restore_scope=
def cluster_resource_restore_scope=(value) -> ::Google::Cloud::GkeBackup::V1::RestoreConfig::ClusterResourceRestoreScope- value (::Google::Cloud::GkeBackup::V1::RestoreConfig::ClusterResourceRestoreScope) — Optional. Identifies the cluster-scoped resources to restore from the Backup. Not specifying it means NO cluster resource will be restored.
- (::Google::Cloud::GkeBackup::V1::RestoreConfig::ClusterResourceRestoreScope) — Optional. Identifies the cluster-scoped resources to restore from the Backup. Not specifying it means NO cluster resource will be restored.
#excluded_namespaces
def excluded_namespaces() -> ::Google::Cloud::GkeBackup::V1::Namespaces-
(::Google::Cloud::GkeBackup::V1::Namespaces) — A list of selected namespaces excluded from restoration. All
namespaces except those in this list will be restored.
Note: The following fields are mutually exclusive:
excluded_namespaces,all_namespaces,selected_namespaces,selected_applications,no_namespaces. If a field in that set is populated, all other fields in the set will automatically be cleared.
#excluded_namespaces=
def excluded_namespaces=(value) -> ::Google::Cloud::GkeBackup::V1::Namespaces-
value (::Google::Cloud::GkeBackup::V1::Namespaces) — A list of selected namespaces excluded from restoration. All
namespaces except those in this list will be restored.
Note: The following fields are mutually exclusive:
excluded_namespaces,all_namespaces,selected_namespaces,selected_applications,no_namespaces. If a field in that set is populated, all other fields in the set will automatically be cleared.
-
(::Google::Cloud::GkeBackup::V1::Namespaces) — A list of selected namespaces excluded from restoration. All
namespaces except those in this list will be restored.
Note: The following fields are mutually exclusive:
excluded_namespaces,all_namespaces,selected_namespaces,selected_applications,no_namespaces. If a field in that set is populated, all other fields in the set will automatically be cleared.
#namespaced_resource_restore_mode
def namespaced_resource_restore_mode() -> ::Google::Cloud::GkeBackup::V1::RestoreConfig::NamespacedResourceRestoreMode- (::Google::Cloud::GkeBackup::V1::RestoreConfig::NamespacedResourceRestoreMode) — Optional. 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.
#namespaced_resource_restore_mode=
def namespaced_resource_restore_mode=(value) -> ::Google::Cloud::GkeBackup::V1::RestoreConfig::NamespacedResourceRestoreMode- value (::Google::Cloud::GkeBackup::V1::RestoreConfig::NamespacedResourceRestoreMode) — Optional. 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.
- (::Google::Cloud::GkeBackup::V1::RestoreConfig::NamespacedResourceRestoreMode) — Optional. 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.
#no_namespaces
def no_namespaces() -> ::Boolean-
(::Boolean) — Do not restore any namespaced resources if set to "True".
Specifying this field to "False" is not allowed.
Note: The following fields are mutually exclusive:
no_namespaces,all_namespaces,selected_namespaces,selected_applications,excluded_namespaces. If a field in that set is populated, all other fields in the set will automatically be cleared.
#no_namespaces=
def no_namespaces=(value) -> ::Boolean-
value (::Boolean) — Do not restore any namespaced resources if set to "True".
Specifying this field to "False" is not allowed.
Note: The following fields are mutually exclusive:
no_namespaces,all_namespaces,selected_namespaces,selected_applications,excluded_namespaces. If a field in that set is populated, all other fields in the set will automatically be cleared.
-
(::Boolean) — Do not restore any namespaced resources if set to "True".
Specifying this field to "False" is not allowed.
Note: The following fields are mutually exclusive:
no_namespaces,all_namespaces,selected_namespaces,selected_applications,excluded_namespaces. If a field in that set is populated, all other fields in the set will automatically be cleared.
#restore_order
def restore_order() -> ::Google::Cloud::GkeBackup::V1::RestoreConfig::RestoreOrder- (::Google::Cloud::GkeBackup::V1::RestoreConfig::RestoreOrder) — Optional. RestoreOrder contains custom ordering to use on a Restore.
#restore_order=
def restore_order=(value) -> ::Google::Cloud::GkeBackup::V1::RestoreConfig::RestoreOrder- value (::Google::Cloud::GkeBackup::V1::RestoreConfig::RestoreOrder) — Optional. RestoreOrder contains custom ordering to use on a Restore.
- (::Google::Cloud::GkeBackup::V1::RestoreConfig::RestoreOrder) — Optional. RestoreOrder contains custom ordering to use on a Restore.
#selected_applications
def selected_applications() -> ::Google::Cloud::GkeBackup::V1::NamespacedNames-
(::Google::Cloud::GkeBackup::V1::NamespacedNames) — A list of selected ProtectedApplications to restore. The listed
ProtectedApplications and all the resources to which they refer will be
restored.
Note: The following fields are mutually exclusive:
selected_applications,all_namespaces,selected_namespaces,no_namespaces,excluded_namespaces. If a field in that set is populated, all other fields in the set will automatically be cleared.
#selected_applications=
def selected_applications=(value) -> ::Google::Cloud::GkeBackup::V1::NamespacedNames-
value (::Google::Cloud::GkeBackup::V1::NamespacedNames) — A list of selected ProtectedApplications to restore. The listed
ProtectedApplications and all the resources to which they refer will be
restored.
Note: The following fields are mutually exclusive:
selected_applications,all_namespaces,selected_namespaces,no_namespaces,excluded_namespaces. If a field in that set is populated, all other fields in the set will automatically be cleared.
-
(::Google::Cloud::GkeBackup::V1::NamespacedNames) — A list of selected ProtectedApplications to restore. The listed
ProtectedApplications and all the resources to which they refer will be
restored.
Note: The following fields are mutually exclusive:
selected_applications,all_namespaces,selected_namespaces,no_namespaces,excluded_namespaces. If a field in that set is populated, all other fields in the set will automatically be cleared.
#selected_namespaces
def selected_namespaces() -> ::Google::Cloud::GkeBackup::V1::Namespaces-
(::Google::Cloud::GkeBackup::V1::Namespaces) — A list of selected Namespaces to restore from the Backup. The listed
Namespaces and all resources contained in them will be restored.
Note: The following fields are mutually exclusive:
selected_namespaces,all_namespaces,selected_applications,no_namespaces,excluded_namespaces. If a field in that set is populated, all other fields in the set will automatically be cleared.
#selected_namespaces=
def selected_namespaces=(value) -> ::Google::Cloud::GkeBackup::V1::Namespaces-
value (::Google::Cloud::GkeBackup::V1::Namespaces) — A list of selected Namespaces to restore from the Backup. The listed
Namespaces and all resources contained in them will be restored.
Note: The following fields are mutually exclusive:
selected_namespaces,all_namespaces,selected_applications,no_namespaces,excluded_namespaces. If a field in that set is populated, all other fields in the set will automatically be cleared.
-
(::Google::Cloud::GkeBackup::V1::Namespaces) — A list of selected Namespaces to restore from the Backup. The listed
Namespaces and all resources contained in them will be restored.
Note: The following fields are mutually exclusive:
selected_namespaces,all_namespaces,selected_applications,no_namespaces,excluded_namespaces. If a field in that set is populated, all other fields in the set will automatically be cleared.
#substitution_rules
def substitution_rules() -> ::Array<::Google::Cloud::GkeBackup::V1::RestoreConfig::SubstitutionRule>- (::Array<::Google::Cloud::GkeBackup::V1::RestoreConfig::SubstitutionRule>) — Optional. 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.
#substitution_rules=
def substitution_rules=(value) -> ::Array<::Google::Cloud::GkeBackup::V1::RestoreConfig::SubstitutionRule>- value (::Array<::Google::Cloud::GkeBackup::V1::RestoreConfig::SubstitutionRule>) — Optional. 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.
- (::Array<::Google::Cloud::GkeBackup::V1::RestoreConfig::SubstitutionRule>) — Optional. 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.
#transformation_rules
def transformation_rules() -> ::Array<::Google::Cloud::GkeBackup::V1::RestoreConfig::TransformationRule>- (::Array<::Google::Cloud::GkeBackup::V1::RestoreConfig::TransformationRule>) — Optional. 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.
#transformation_rules=
def transformation_rules=(value) -> ::Array<::Google::Cloud::GkeBackup::V1::RestoreConfig::TransformationRule>- value (::Array<::Google::Cloud::GkeBackup::V1::RestoreConfig::TransformationRule>) — Optional. 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.
- (::Array<::Google::Cloud::GkeBackup::V1::RestoreConfig::TransformationRule>) — Optional. 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.
#volume_data_restore_policy
def volume_data_restore_policy() -> ::Google::Cloud::GkeBackup::V1::RestoreConfig::VolumeDataRestorePolicy- (::Google::Cloud::GkeBackup::V1::RestoreConfig::VolumeDataRestorePolicy) — Optional. Specifies the mechanism to be used to restore volume data. Default: VOLUME_DATA_RESTORE_POLICY_UNSPECIFIED (will be treated as NO_VOLUME_DATA_RESTORATION).
#volume_data_restore_policy=
def volume_data_restore_policy=(value) -> ::Google::Cloud::GkeBackup::V1::RestoreConfig::VolumeDataRestorePolicy- value (::Google::Cloud::GkeBackup::V1::RestoreConfig::VolumeDataRestorePolicy) — Optional. Specifies the mechanism to be used to restore volume data. Default: VOLUME_DATA_RESTORE_POLICY_UNSPECIFIED (will be treated as NO_VOLUME_DATA_RESTORATION).
- (::Google::Cloud::GkeBackup::V1::RestoreConfig::VolumeDataRestorePolicy) — Optional. Specifies the mechanism to be used to restore volume data. Default: VOLUME_DATA_RESTORE_POLICY_UNSPECIFIED (will be treated as NO_VOLUME_DATA_RESTORATION).
#volume_data_restore_policy_bindings
def volume_data_restore_policy_bindings() -> ::Array<::Google::Cloud::GkeBackup::V1::RestoreConfig::VolumeDataRestorePolicyBinding>- (::Array<::Google::Cloud::GkeBackup::V1::RestoreConfig::VolumeDataRestorePolicyBinding>) — Optional. 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.
#volume_data_restore_policy_bindings=
def volume_data_restore_policy_bindings=(value) -> ::Array<::Google::Cloud::GkeBackup::V1::RestoreConfig::VolumeDataRestorePolicyBinding>- value (::Array<::Google::Cloud::GkeBackup::V1::RestoreConfig::VolumeDataRestorePolicyBinding>) — Optional. 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.
- (::Array<::Google::Cloud::GkeBackup::V1::RestoreConfig::VolumeDataRestorePolicyBinding>) — Optional. 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.