Interface RestoreConfigOrBuilder (0.52.0) 

public interface RestoreConfigOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAllNamespaces()

public abstract boolean getAllNamespaces()

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

bool all_namespaces = 5;

Returns
Type Description
boolean

The allNamespaces.

getClusterResourceConflictPolicy()

public abstract RestoreConfig.ClusterResourceConflictPolicy getClusterResourceConflictPolicy()

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 cluster_resource_conflict_policy = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
RestoreConfig.ClusterResourceConflictPolicy

The clusterResourceConflictPolicy.

getClusterResourceConflictPolicyValue()

public abstract int getClusterResourceConflictPolicyValue()

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 cluster_resource_conflict_policy = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for clusterResourceConflictPolicy.

getClusterResourceRestoreScope()

public abstract RestoreConfig.ClusterResourceRestoreScope getClusterResourceRestoreScope()

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 cluster_resource_restore_scope = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
RestoreConfig.ClusterResourceRestoreScope

The clusterResourceRestoreScope.

getClusterResourceRestoreScopeOrBuilder()

public abstract RestoreConfig.ClusterResourceRestoreScopeOrBuilder getClusterResourceRestoreScopeOrBuilder()

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 cluster_resource_restore_scope = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
RestoreConfig.ClusterResourceRestoreScopeOrBuilder

getExcludedNamespaces()

public abstract Namespaces getExcludedNamespaces()

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

.google.cloud.gkebackup.v1.Namespaces excluded_namespaces = 10;

Returns
Type Description
Namespaces

The excludedNamespaces.

getExcludedNamespacesOrBuilder()

public abstract NamespacesOrBuilder getExcludedNamespacesOrBuilder()

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

.google.cloud.gkebackup.v1.Namespaces excluded_namespaces = 10;

Returns
Type Description
NamespacesOrBuilder

getNamespacedResourceRestoreMode()

public abstract RestoreConfig.NamespacedResourceRestoreMode getNamespacedResourceRestoreMode()

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 namespaced_resource_restore_mode = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
RestoreConfig.NamespacedResourceRestoreMode

The namespacedResourceRestoreMode.

getNamespacedResourceRestoreModeValue()

public abstract int getNamespacedResourceRestoreModeValue()

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 namespaced_resource_restore_mode = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for namespacedResourceRestoreMode.

getNamespacedResourceRestoreScopeCase()

public abstract RestoreConfig.NamespacedResourceRestoreScopeCase getNamespacedResourceRestoreScopeCase()
Returns
Type Description
RestoreConfig.NamespacedResourceRestoreScopeCase

getNoNamespaces()

public abstract boolean getNoNamespaces()

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

bool no_namespaces = 9;

Returns
Type Description
boolean

The noNamespaces.

getRestoreOrder()

public abstract RestoreConfig.RestoreOrder getRestoreOrder()

Optional. RestoreOrder contains custom ordering to use on a Restore.

.google.cloud.gkebackup.v1.RestoreConfig.RestoreOrder restore_order = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
RestoreConfig.RestoreOrder

The restoreOrder.

getRestoreOrderOrBuilder()

public abstract RestoreConfig.RestoreOrderOrBuilder getRestoreOrderOrBuilder()

Optional. RestoreOrder contains custom ordering to use on a Restore.

.google.cloud.gkebackup.v1.RestoreConfig.RestoreOrder restore_order = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
RestoreConfig.RestoreOrderOrBuilder

getSelectedApplications()

public abstract NamespacedNames getSelectedApplications()

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

.google.cloud.gkebackup.v1.NamespacedNames selected_applications = 7;

Returns
Type Description
NamespacedNames

The selectedApplications.

getSelectedApplicationsOrBuilder()

public abstract NamespacedNamesOrBuilder getSelectedApplicationsOrBuilder()

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

.google.cloud.gkebackup.v1.NamespacedNames selected_applications = 7;

Returns
Type Description
NamespacedNamesOrBuilder

getSelectedNamespaces()

public abstract Namespaces getSelectedNamespaces()

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

.google.cloud.gkebackup.v1.Namespaces selected_namespaces = 6;

Returns
Type Description
Namespaces

The selectedNamespaces.

getSelectedNamespacesOrBuilder()

public abstract NamespacesOrBuilder getSelectedNamespacesOrBuilder()

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

.google.cloud.gkebackup.v1.Namespaces selected_namespaces = 6;

Returns
Type Description
NamespacesOrBuilder

getSubstitutionRules(int index)

public abstract RestoreConfig.SubstitutionRule getSubstitutionRules(int index)

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.

repeated .google.cloud.gkebackup.v1.RestoreConfig.SubstitutionRule substitution_rules = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
RestoreConfig.SubstitutionRule

getSubstitutionRulesCount()

public abstract int getSubstitutionRulesCount()

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.

repeated .google.cloud.gkebackup.v1.RestoreConfig.SubstitutionRule substitution_rules = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getSubstitutionRulesList()

public abstract List<RestoreConfig.SubstitutionRule> getSubstitutionRulesList()

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.

repeated .google.cloud.gkebackup.v1.RestoreConfig.SubstitutionRule substitution_rules = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<SubstitutionRule>

getSubstitutionRulesOrBuilder(int index)

public abstract RestoreConfig.SubstitutionRuleOrBuilder getSubstitutionRulesOrBuilder(int index)

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.

repeated .google.cloud.gkebackup.v1.RestoreConfig.SubstitutionRule substitution_rules = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
RestoreConfig.SubstitutionRuleOrBuilder

getSubstitutionRulesOrBuilderList()

public abstract List<? extends RestoreConfig.SubstitutionRuleOrBuilder> getSubstitutionRulesOrBuilderList()

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.

repeated .google.cloud.gkebackup.v1.RestoreConfig.SubstitutionRule substitution_rules = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<? extends com.google.cloud.gkebackup.v1.RestoreConfig.SubstitutionRuleOrBuilder>

getTransformationRules(int index)

public abstract RestoreConfig.TransformationRule getTransformationRules(int index)

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.

repeated .google.cloud.gkebackup.v1.RestoreConfig.TransformationRule transformation_rules = 11 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
RestoreConfig.TransformationRule

getTransformationRulesCount()

public abstract int getTransformationRulesCount()

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.

repeated .google.cloud.gkebackup.v1.RestoreConfig.TransformationRule transformation_rules = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getTransformationRulesList()

public abstract List<RestoreConfig.TransformationRule> getTransformationRulesList()

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.

repeated .google.cloud.gkebackup.v1.RestoreConfig.TransformationRule transformation_rules = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<TransformationRule>

getTransformationRulesOrBuilder(int index)

public abstract RestoreConfig.TransformationRuleOrBuilder getTransformationRulesOrBuilder(int index)

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.

repeated .google.cloud.gkebackup.v1.RestoreConfig.TransformationRule transformation_rules = 11 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
RestoreConfig.TransformationRuleOrBuilder

getTransformationRulesOrBuilderList()

public abstract List<? extends RestoreConfig.TransformationRuleOrBuilder> getTransformationRulesOrBuilderList()

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.

repeated .google.cloud.gkebackup.v1.RestoreConfig.TransformationRule transformation_rules = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<? extends com.google.cloud.gkebackup.v1.RestoreConfig.TransformationRuleOrBuilder>

getVolumeDataRestorePolicy()

public abstract RestoreConfig.VolumeDataRestorePolicy getVolumeDataRestorePolicy()

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 volume_data_restore_policy = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
RestoreConfig.VolumeDataRestorePolicy

The volumeDataRestorePolicy.

getVolumeDataRestorePolicyBindings(int index)

public abstract RestoreConfig.VolumeDataRestorePolicyBinding getVolumeDataRestorePolicyBindings(int index)

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.

repeated .google.cloud.gkebackup.v1.RestoreConfig.VolumeDataRestorePolicyBinding volume_data_restore_policy_bindings = 12 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
RestoreConfig.VolumeDataRestorePolicyBinding

getVolumeDataRestorePolicyBindingsCount()

public abstract int getVolumeDataRestorePolicyBindingsCount()

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.

repeated .google.cloud.gkebackup.v1.RestoreConfig.VolumeDataRestorePolicyBinding volume_data_restore_policy_bindings = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getVolumeDataRestorePolicyBindingsList()

public abstract List<RestoreConfig.VolumeDataRestorePolicyBinding> getVolumeDataRestorePolicyBindingsList()

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.

repeated .google.cloud.gkebackup.v1.RestoreConfig.VolumeDataRestorePolicyBinding volume_data_restore_policy_bindings = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<VolumeDataRestorePolicyBinding>

getVolumeDataRestorePolicyBindingsOrBuilder(int index)

public abstract RestoreConfig.VolumeDataRestorePolicyBindingOrBuilder getVolumeDataRestorePolicyBindingsOrBuilder(int index)

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.

repeated .google.cloud.gkebackup.v1.RestoreConfig.VolumeDataRestorePolicyBinding volume_data_restore_policy_bindings = 12 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
RestoreConfig.VolumeDataRestorePolicyBindingOrBuilder

getVolumeDataRestorePolicyBindingsOrBuilderList()

public abstract List<? extends RestoreConfig.VolumeDataRestorePolicyBindingOrBuilder> getVolumeDataRestorePolicyBindingsOrBuilderList()

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.

repeated .google.cloud.gkebackup.v1.RestoreConfig.VolumeDataRestorePolicyBinding volume_data_restore_policy_bindings = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<? extends com.google.cloud.gkebackup.v1.RestoreConfig.VolumeDataRestorePolicyBindingOrBuilder>

getVolumeDataRestorePolicyValue()

public abstract int getVolumeDataRestorePolicyValue()

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 volume_data_restore_policy = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for volumeDataRestorePolicy.

hasAllNamespaces()

public abstract boolean hasAllNamespaces()

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

bool all_namespaces = 5;

Returns
Type Description
boolean

Whether the allNamespaces field is set.

hasClusterResourceRestoreScope()

public abstract boolean hasClusterResourceRestoreScope()

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 cluster_resource_restore_scope = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the clusterResourceRestoreScope field is set.

hasExcludedNamespaces()

public abstract boolean hasExcludedNamespaces()

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

.google.cloud.gkebackup.v1.Namespaces excluded_namespaces = 10;

Returns
Type Description
boolean

Whether the excludedNamespaces field is set.

hasNoNamespaces()

public abstract boolean hasNoNamespaces()

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

bool no_namespaces = 9;

Returns
Type Description
boolean

Whether the noNamespaces field is set.

hasRestoreOrder()

public abstract boolean hasRestoreOrder()

Optional. RestoreOrder contains custom ordering to use on a Restore.

.google.cloud.gkebackup.v1.RestoreConfig.RestoreOrder restore_order = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the restoreOrder field is set.

hasSelectedApplications()

public abstract boolean hasSelectedApplications()

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

.google.cloud.gkebackup.v1.NamespacedNames selected_applications = 7;

Returns
Type Description
boolean

Whether the selectedApplications field is set.

hasSelectedNamespaces()

public abstract boolean hasSelectedNamespaces()

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

.google.cloud.gkebackup.v1.Namespaces selected_namespaces = 6;

Returns
Type Description
boolean

Whether the selectedNamespaces field is set.