Backup for GKE V1 API - Class Google::Cloud::GkeBackup::V1::RestoreConfig (v0.9.0)

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

Returns

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

#all_namespaces=

def all_namespaces=(value) -> ::Boolean

Parameter

value (::Boolean) — Restore all namespaced resources in the Backup if set to "True". Specifying this field to "False" is an error.

Returns

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

#cluster_resource_conflict_policy

def cluster_resource_conflict_policy() -> ::Google::Cloud::GkeBackup::V1::RestoreConfig::ClusterResourceConflictPolicy

Returns

(::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

Parameter

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.

Returns

(::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

Returns

(::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

Parameter

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.

Returns

(::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

Returns

(::Google::Cloud::GkeBackup::V1::Namespaces) — A list of selected namespaces excluded from restoration. All namespaces except those in this list will be restored.

#excluded_namespaces=

def excluded_namespaces=(value) -> ::Google::Cloud::GkeBackup::V1::Namespaces

Parameter

value (::Google::Cloud::GkeBackup::V1::Namespaces) — A list of selected namespaces excluded from restoration. All namespaces except those in this list will be restored.

Returns

(::Google::Cloud::GkeBackup::V1::Namespaces) — A list of selected namespaces excluded from restoration. All namespaces except those in this list will be restored.

#namespaced_resource_restore_mode

def namespaced_resource_restore_mode() -> ::Google::Cloud::GkeBackup::V1::RestoreConfig::NamespacedResourceRestoreMode

Returns

(::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

Parameter

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.

Returns

(::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

Returns

(::Boolean) — Do not restore any namespaced resources if set to "True". Specifying this field to "False" is not allowed.

#no_namespaces=

def no_namespaces=(value) -> ::Boolean

Parameter

value (::Boolean) — Do not restore any namespaced resources if set to "True". Specifying this field to "False" is not allowed.

Returns

(::Boolean) — Do not restore any namespaced resources if set to "True". Specifying this field to "False" is not allowed.

#selected_applications

def selected_applications() -> ::Google::Cloud::GkeBackup::V1::NamespacedNames

Returns

(::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.

#selected_applications=

def selected_applications=(value) -> ::Google::Cloud::GkeBackup::V1::NamespacedNames

Parameter

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.

Returns

(::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.

#selected_namespaces

def selected_namespaces() -> ::Google::Cloud::GkeBackup::V1::Namespaces

Returns

(::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.

#selected_namespaces=

def selected_namespaces=(value) -> ::Google::Cloud::GkeBackup::V1::Namespaces

Parameter

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.

Returns

(::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.

#substitution_rules

def substitution_rules() -> ::Array<::Google::Cloud::GkeBackup::V1::RestoreConfig::SubstitutionRule>

Returns

(::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>

Parameter

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.

Returns

(::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>

Returns

(::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>

Parameter

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.

Returns

(::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

Returns

(::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

Parameter

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).

Returns

(::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).