Google Cloud Gke Backup V1 Client - Class RestoreConfig (0.4.0)

Reference documentation and code samples for the Google Cloud Gke Backup V1 Client class RestoreConfig.

Configuration of a restore.

Next id: 12

Generated from protobuf message google.cloud.gkebackup.v1.RestoreConfig

Namespace

Google \ Cloud \ GkeBackup \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ volume_data_restore_policy int

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 int

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 int

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\GkeBackup\V1\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.

↳ selected_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.

↳ selected_applications 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.

↳ no_namespaces bool

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

↳ excluded_namespaces Google\Cloud\GkeBackup\V1\Namespaces

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

↳ substitution_rules array<Google\Cloud\GkeBackup\V1\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.

↳ transformation_rules array<Google\Cloud\GkeBackup\V1\RestoreConfig\TransformationRule>

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.

getVolumeDataRestorePolicy

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
TypeDescription
int

setVolumeDataRestorePolicy

Specifies the mechanism to be used to restore volume data.

Default: VOLUME_DATA_RESTORE_POLICY_UNSPECIFIED (will be treated as NO_VOLUME_DATA_RESTORATION).

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getClusterResourceConflictPolicy

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
TypeDescription
int

setClusterResourceConflictPolicy

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.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getNamespacedResourceRestoreMode

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
TypeDescription
int

setNamespacedResourceRestoreMode

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.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getClusterResourceRestoreScope

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

Not specifying it means NO cluster resource will be restored.

Returns
TypeDescription
Google\Cloud\GkeBackup\V1\RestoreConfig\ClusterResourceRestoreScope|null

hasClusterResourceRestoreScope

clearClusterResourceRestoreScope

setClusterResourceRestoreScope

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

Not specifying it means NO cluster resource will be restored.

Parameter
NameDescription
var Google\Cloud\GkeBackup\V1\RestoreConfig\ClusterResourceRestoreScope
Returns
TypeDescription
$this

getAllNamespaces

Restore all namespaced resources in the Backup if set to "True".

Specifying this field to "False" is an error.

Returns
TypeDescription
bool

hasAllNamespaces

setAllNamespaces

Restore all namespaced resources in the Backup if set to "True".

Specifying this field to "False" is an error.

Parameter
NameDescription
var bool
Returns
TypeDescription
$this

getSelectedNamespaces

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

Returns
TypeDescription
Google\Cloud\GkeBackup\V1\Namespaces|null

hasSelectedNamespaces

setSelectedNamespaces

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

Parameter
NameDescription
var Google\Cloud\GkeBackup\V1\Namespaces
Returns
TypeDescription
$this

getSelectedApplications

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

Returns
TypeDescription
Google\Cloud\GkeBackup\V1\NamespacedNames|null

hasSelectedApplications

setSelectedApplications

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

Parameter
NameDescription
var Google\Cloud\GkeBackup\V1\NamespacedNames
Returns
TypeDescription
$this

getNoNamespaces

Do not restore any namespaced resources if set to "True".

Specifying this field to "False" is not allowed.

Returns
TypeDescription
bool

hasNoNamespaces

setNoNamespaces

Do not restore any namespaced resources if set to "True".

Specifying this field to "False" is not allowed.

Parameter
NameDescription
var bool
Returns
TypeDescription
$this

getExcludedNamespaces

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

Returns
TypeDescription
Google\Cloud\GkeBackup\V1\Namespaces|null

hasExcludedNamespaces

setExcludedNamespaces

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

Parameter
NameDescription
var Google\Cloud\GkeBackup\V1\Namespaces
Returns
TypeDescription
$this

getSubstitutionRules

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
TypeDescription
Google\Protobuf\Internal\RepeatedField

setSubstitutionRules

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.

Parameter
NameDescription
var array<Google\Cloud\GkeBackup\V1\RestoreConfig\SubstitutionRule>
Returns
TypeDescription
$this

getTransformationRules

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
TypeDescription
Google\Protobuf\Internal\RepeatedField

setTransformationRules

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.

Parameter
NameDescription
var array<Google\Cloud\GkeBackup\V1\RestoreConfig\TransformationRule>
Returns
TypeDescription
$this

getNamespacedResourceRestoreScope

Returns
TypeDescription
string