Class RestoreConfig.Builder (0.44.0) 

public static final class RestoreConfig.Builder extends GeneratedMessageV3.Builder<RestoreConfig.Builder> implements RestoreConfigOrBuilder

Configuration of a restore.

Protobuf type google.cloud.gkebackup.v1.RestoreConfig

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > RestoreConfig.Builder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addAllSubstitutionRules(Iterable<? extends RestoreConfig.SubstitutionRule> values)

public RestoreConfig.Builder addAllSubstitutionRules(Iterable<? extends RestoreConfig.SubstitutionRule> values)

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
values Iterable<? extends com.google.cloud.gkebackup.v1.RestoreConfig.SubstitutionRule>
Returns
Type Description
RestoreConfig.Builder

addAllTransformationRules(Iterable<? extends RestoreConfig.TransformationRule> values)

public RestoreConfig.Builder addAllTransformationRules(Iterable<? extends RestoreConfig.TransformationRule> values)

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
values Iterable<? extends com.google.cloud.gkebackup.v1.RestoreConfig.TransformationRule>
Returns
Type Description
RestoreConfig.Builder

addAllVolumeDataRestorePolicyBindings(Iterable<? extends RestoreConfig.VolumeDataRestorePolicyBinding> values)

public RestoreConfig.Builder addAllVolumeDataRestorePolicyBindings(Iterable<? extends RestoreConfig.VolumeDataRestorePolicyBinding> values)

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
values Iterable<? extends com.google.cloud.gkebackup.v1.RestoreConfig.VolumeDataRestorePolicyBinding>
Returns
Type Description
RestoreConfig.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public RestoreConfig.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
RestoreConfig.Builder
Overrides

addSubstitutionRules(RestoreConfig.SubstitutionRule value)

public RestoreConfig.Builder addSubstitutionRules(RestoreConfig.SubstitutionRule value)

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
value RestoreConfig.SubstitutionRule
Returns
Type Description
RestoreConfig.Builder

addSubstitutionRules(RestoreConfig.SubstitutionRule.Builder builderForValue)

public RestoreConfig.Builder addSubstitutionRules(RestoreConfig.SubstitutionRule.Builder builderForValue)

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
builderForValue RestoreConfig.SubstitutionRule.Builder
Returns
Type Description
RestoreConfig.Builder

addSubstitutionRules(int index, RestoreConfig.SubstitutionRule value)

public RestoreConfig.Builder addSubstitutionRules(int index, RestoreConfig.SubstitutionRule value)

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];

Parameters
Name Description
index int
value RestoreConfig.SubstitutionRule
Returns
Type Description
RestoreConfig.Builder

addSubstitutionRules(int index, RestoreConfig.SubstitutionRule.Builder builderForValue)

public RestoreConfig.Builder addSubstitutionRules(int index, RestoreConfig.SubstitutionRule.Builder builderForValue)

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];

Parameters
Name Description
index int
builderForValue RestoreConfig.SubstitutionRule.Builder
Returns
Type Description
RestoreConfig.Builder

addSubstitutionRulesBuilder()

public RestoreConfig.SubstitutionRule.Builder addSubstitutionRulesBuilder()

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
RestoreConfig.SubstitutionRule.Builder

addSubstitutionRulesBuilder(int index)

public RestoreConfig.SubstitutionRule.Builder addSubstitutionRulesBuilder(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.Builder

addTransformationRules(RestoreConfig.TransformationRule value)

public RestoreConfig.Builder addTransformationRules(RestoreConfig.TransformationRule value)

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
value RestoreConfig.TransformationRule
Returns
Type Description
RestoreConfig.Builder

addTransformationRules(RestoreConfig.TransformationRule.Builder builderForValue)

public RestoreConfig.Builder addTransformationRules(RestoreConfig.TransformationRule.Builder builderForValue)

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
builderForValue RestoreConfig.TransformationRule.Builder
Returns
Type Description
RestoreConfig.Builder

addTransformationRules(int index, RestoreConfig.TransformationRule value)

public RestoreConfig.Builder addTransformationRules(int index, RestoreConfig.TransformationRule value)

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];

Parameters
Name Description
index int
value RestoreConfig.TransformationRule
Returns
Type Description
RestoreConfig.Builder

addTransformationRules(int index, RestoreConfig.TransformationRule.Builder builderForValue)

public RestoreConfig.Builder addTransformationRules(int index, RestoreConfig.TransformationRule.Builder builderForValue)

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];

Parameters
Name Description
index int
builderForValue RestoreConfig.TransformationRule.Builder
Returns
Type Description
RestoreConfig.Builder

addTransformationRulesBuilder()

public RestoreConfig.TransformationRule.Builder addTransformationRulesBuilder()

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
RestoreConfig.TransformationRule.Builder

addTransformationRulesBuilder(int index)

public RestoreConfig.TransformationRule.Builder addTransformationRulesBuilder(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.Builder

addVolumeDataRestorePolicyBindings(RestoreConfig.VolumeDataRestorePolicyBinding value)

public RestoreConfig.Builder addVolumeDataRestorePolicyBindings(RestoreConfig.VolumeDataRestorePolicyBinding value)

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
value RestoreConfig.VolumeDataRestorePolicyBinding
Returns
Type Description
RestoreConfig.Builder

addVolumeDataRestorePolicyBindings(RestoreConfig.VolumeDataRestorePolicyBinding.Builder builderForValue)

public RestoreConfig.Builder addVolumeDataRestorePolicyBindings(RestoreConfig.VolumeDataRestorePolicyBinding.Builder builderForValue)

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
builderForValue RestoreConfig.VolumeDataRestorePolicyBinding.Builder
Returns
Type Description
RestoreConfig.Builder

addVolumeDataRestorePolicyBindings(int index, RestoreConfig.VolumeDataRestorePolicyBinding value)

public RestoreConfig.Builder addVolumeDataRestorePolicyBindings(int index, RestoreConfig.VolumeDataRestorePolicyBinding value)

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];

Parameters
Name Description
index int
value RestoreConfig.VolumeDataRestorePolicyBinding
Returns
Type Description
RestoreConfig.Builder

addVolumeDataRestorePolicyBindings(int index, RestoreConfig.VolumeDataRestorePolicyBinding.Builder builderForValue)

public RestoreConfig.Builder addVolumeDataRestorePolicyBindings(int index, RestoreConfig.VolumeDataRestorePolicyBinding.Builder builderForValue)

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];

Parameters
Name Description
index int
builderForValue RestoreConfig.VolumeDataRestorePolicyBinding.Builder
Returns
Type Description
RestoreConfig.Builder

addVolumeDataRestorePolicyBindingsBuilder()

public RestoreConfig.VolumeDataRestorePolicyBinding.Builder addVolumeDataRestorePolicyBindingsBuilder()

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
RestoreConfig.VolumeDataRestorePolicyBinding.Builder

addVolumeDataRestorePolicyBindingsBuilder(int index)

public RestoreConfig.VolumeDataRestorePolicyBinding.Builder addVolumeDataRestorePolicyBindingsBuilder(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.Builder

build()

public RestoreConfig build()
Returns
Type Description
RestoreConfig

buildPartial()

public RestoreConfig buildPartial()
Returns
Type Description
RestoreConfig

clear()

public RestoreConfig.Builder clear()
Returns
Type Description
RestoreConfig.Builder
Overrides

clearAllNamespaces()

public RestoreConfig.Builder clearAllNamespaces()

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
RestoreConfig.Builder

This builder for chaining.

clearClusterResourceConflictPolicy()

public RestoreConfig.Builder clearClusterResourceConflictPolicy()

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

This builder for chaining.

clearClusterResourceRestoreScope()

public RestoreConfig.Builder clearClusterResourceRestoreScope()

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

clearExcludedNamespaces()

public RestoreConfig.Builder clearExcludedNamespaces()

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
RestoreConfig.Builder

clearField(Descriptors.FieldDescriptor field)

public RestoreConfig.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
RestoreConfig.Builder
Overrides

clearNamespacedResourceRestoreMode()

public RestoreConfig.Builder clearNamespacedResourceRestoreMode()

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

This builder for chaining.

clearNamespacedResourceRestoreScope()

public RestoreConfig.Builder clearNamespacedResourceRestoreScope()
Returns
Type Description
RestoreConfig.Builder

clearNoNamespaces()

public RestoreConfig.Builder clearNoNamespaces()

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
RestoreConfig.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public RestoreConfig.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
RestoreConfig.Builder
Overrides

clearRestoreOrder()

public RestoreConfig.Builder clearRestoreOrder()

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

clearSelectedApplications()

public RestoreConfig.Builder clearSelectedApplications()

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
RestoreConfig.Builder

clearSelectedNamespaces()

public RestoreConfig.Builder clearSelectedNamespaces()

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
RestoreConfig.Builder

clearSubstitutionRules()

public RestoreConfig.Builder clearSubstitutionRules()

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
RestoreConfig.Builder

clearTransformationRules()

public RestoreConfig.Builder clearTransformationRules()

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
RestoreConfig.Builder

clearVolumeDataRestorePolicy()

public RestoreConfig.Builder clearVolumeDataRestorePolicy()

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

This builder for chaining.

clearVolumeDataRestorePolicyBindings()

public RestoreConfig.Builder clearVolumeDataRestorePolicyBindings()

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
RestoreConfig.Builder

clone()

public RestoreConfig.Builder clone()
Returns
Type Description
RestoreConfig.Builder
Overrides

getAllNamespaces()

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

getClusterResourceRestoreScopeBuilder()

public RestoreConfig.ClusterResourceRestoreScope.Builder getClusterResourceRestoreScopeBuilder()

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

getClusterResourceRestoreScopeOrBuilder()

public 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

getDefaultInstanceForType()

public RestoreConfig getDefaultInstanceForType()
Returns
Type Description
RestoreConfig

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getExcludedNamespaces()

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

getExcludedNamespacesBuilder()

public Namespaces.Builder getExcludedNamespacesBuilder()

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

getExcludedNamespacesOrBuilder()

public 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 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 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 RestoreConfig.NamespacedResourceRestoreScopeCase getNamespacedResourceRestoreScopeCase()
Returns
Type Description
RestoreConfig.NamespacedResourceRestoreScopeCase

getNoNamespaces()

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

getRestoreOrderBuilder()

public RestoreConfig.RestoreOrder.Builder getRestoreOrderBuilder()

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

getRestoreOrderOrBuilder()

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

getSelectedApplicationsBuilder()

public NamespacedNames.Builder getSelectedApplicationsBuilder()

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

getSelectedApplicationsOrBuilder()

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

getSelectedNamespacesBuilder()

public Namespaces.Builder getSelectedNamespacesBuilder()

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

getSelectedNamespacesOrBuilder()

public 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 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

getSubstitutionRulesBuilder(int index)

public RestoreConfig.SubstitutionRule.Builder getSubstitutionRulesBuilder(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.Builder

getSubstitutionRulesBuilderList()

public List<RestoreConfig.SubstitutionRule.Builder> getSubstitutionRulesBuilderList()

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<Builder>

getSubstitutionRulesCount()

public 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 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 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 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 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

getTransformationRulesBuilder(int index)

public RestoreConfig.TransformationRule.Builder getTransformationRulesBuilder(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.Builder

getTransformationRulesBuilderList()

public List<RestoreConfig.TransformationRule.Builder> getTransformationRulesBuilderList()

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<Builder>

getTransformationRulesCount()

public 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 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 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 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 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 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

getVolumeDataRestorePolicyBindingsBuilder(int index)

public RestoreConfig.VolumeDataRestorePolicyBinding.Builder getVolumeDataRestorePolicyBindingsBuilder(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.Builder

getVolumeDataRestorePolicyBindingsBuilderList()

public List<RestoreConfig.VolumeDataRestorePolicyBinding.Builder> getVolumeDataRestorePolicyBindingsBuilderList()

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<Builder>

getVolumeDataRestorePolicyBindingsCount()

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

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeClusterResourceRestoreScope(RestoreConfig.ClusterResourceRestoreScope value)

public RestoreConfig.Builder mergeClusterResourceRestoreScope(RestoreConfig.ClusterResourceRestoreScope value)

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];

Parameter
Name Description
value RestoreConfig.ClusterResourceRestoreScope
Returns
Type Description
RestoreConfig.Builder

mergeExcludedNamespaces(Namespaces value)

public RestoreConfig.Builder mergeExcludedNamespaces(Namespaces value)

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;

Parameter
Name Description
value Namespaces
Returns
Type Description
RestoreConfig.Builder

mergeFrom(RestoreConfig other)

public RestoreConfig.Builder mergeFrom(RestoreConfig other)
Parameter
Name Description
other RestoreConfig
Returns
Type Description
RestoreConfig.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public RestoreConfig.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RestoreConfig.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public RestoreConfig.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
RestoreConfig.Builder
Overrides

mergeRestoreOrder(RestoreConfig.RestoreOrder value)

public RestoreConfig.Builder mergeRestoreOrder(RestoreConfig.RestoreOrder value)

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

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

Parameter
Name Description
value RestoreConfig.RestoreOrder
Returns
Type Description
RestoreConfig.Builder

mergeSelectedApplications(NamespacedNames value)

public RestoreConfig.Builder mergeSelectedApplications(NamespacedNames value)

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;

Parameter
Name Description
value NamespacedNames
Returns
Type Description
RestoreConfig.Builder

mergeSelectedNamespaces(Namespaces value)

public RestoreConfig.Builder mergeSelectedNamespaces(Namespaces value)

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;

Parameter
Name Description
value Namespaces
Returns
Type Description
RestoreConfig.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final RestoreConfig.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
RestoreConfig.Builder
Overrides

removeSubstitutionRules(int index)

public RestoreConfig.Builder removeSubstitutionRules(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.Builder

removeTransformationRules(int index)

public RestoreConfig.Builder removeTransformationRules(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.Builder

removeVolumeDataRestorePolicyBindings(int index)

public RestoreConfig.Builder removeVolumeDataRestorePolicyBindings(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.Builder

setAllNamespaces(boolean value)

public RestoreConfig.Builder setAllNamespaces(boolean value)

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

bool all_namespaces = 5;

Parameter
Name Description
value boolean

The allNamespaces to set.
Returns
Type Description
RestoreConfig.Builder

This builder for chaining.

setClusterResourceConflictPolicy(RestoreConfig.ClusterResourceConflictPolicy value)

public RestoreConfig.Builder setClusterResourceConflictPolicy(RestoreConfig.ClusterResourceConflictPolicy value)

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];

Parameter
Name Description
value RestoreConfig.ClusterResourceConflictPolicy

The clusterResourceConflictPolicy to set.
Returns
Type Description
RestoreConfig.Builder

This builder for chaining.

setClusterResourceConflictPolicyValue(int value)

public RestoreConfig.Builder setClusterResourceConflictPolicyValue(int value)

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];

Parameter
Name Description
value int

The enum numeric value on the wire for clusterResourceConflictPolicy to set.
Returns
Type Description
RestoreConfig.Builder

This builder for chaining.

setClusterResourceRestoreScope(RestoreConfig.ClusterResourceRestoreScope value)

public RestoreConfig.Builder setClusterResourceRestoreScope(RestoreConfig.ClusterResourceRestoreScope value)

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];

Parameter
Name Description
value RestoreConfig.ClusterResourceRestoreScope
Returns
Type Description
RestoreConfig.Builder

setClusterResourceRestoreScope(RestoreConfig.ClusterResourceRestoreScope.Builder builderForValue)

public RestoreConfig.Builder setClusterResourceRestoreScope(RestoreConfig.ClusterResourceRestoreScope.Builder builderForValue)

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];

Parameter
Name Description
builderForValue RestoreConfig.ClusterResourceRestoreScope.Builder
Returns
Type Description
RestoreConfig.Builder

setExcludedNamespaces(Namespaces value)

public RestoreConfig.Builder setExcludedNamespaces(Namespaces value)

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;

Parameter
Name Description
value Namespaces
Returns
Type Description
RestoreConfig.Builder

setExcludedNamespaces(Namespaces.Builder builderForValue)

public RestoreConfig.Builder setExcludedNamespaces(Namespaces.Builder builderForValue)

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;

Parameter
Name Description
builderForValue Namespaces.Builder
Returns
Type Description
RestoreConfig.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public RestoreConfig.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
RestoreConfig.Builder
Overrides

setNamespacedResourceRestoreMode(RestoreConfig.NamespacedResourceRestoreMode value)

public RestoreConfig.Builder setNamespacedResourceRestoreMode(RestoreConfig.NamespacedResourceRestoreMode value)

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];

Parameter
Name Description
value RestoreConfig.NamespacedResourceRestoreMode

The namespacedResourceRestoreMode to set.
Returns
Type Description
RestoreConfig.Builder

This builder for chaining.

setNamespacedResourceRestoreModeValue(int value)

public RestoreConfig.Builder setNamespacedResourceRestoreModeValue(int value)

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];

Parameter
Name Description
value int

The enum numeric value on the wire for namespacedResourceRestoreMode to set.
Returns
Type Description
RestoreConfig.Builder

This builder for chaining.

setNoNamespaces(boolean value)

public RestoreConfig.Builder setNoNamespaces(boolean value)

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

bool no_namespaces = 9;

Parameter
Name Description
value boolean

The noNamespaces to set.
Returns
Type Description
RestoreConfig.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public RestoreConfig.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
RestoreConfig.Builder
Overrides

setRestoreOrder(RestoreConfig.RestoreOrder value)

public RestoreConfig.Builder setRestoreOrder(RestoreConfig.RestoreOrder value)

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

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

Parameter
Name Description
value RestoreConfig.RestoreOrder
Returns
Type Description
RestoreConfig.Builder

setRestoreOrder(RestoreConfig.RestoreOrder.Builder builderForValue)

public RestoreConfig.Builder setRestoreOrder(RestoreConfig.RestoreOrder.Builder builderForValue)

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

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

Parameter
Name Description
builderForValue RestoreConfig.RestoreOrder.Builder
Returns
Type Description
RestoreConfig.Builder

setSelectedApplications(NamespacedNames value)

public RestoreConfig.Builder setSelectedApplications(NamespacedNames value)

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;

Parameter
Name Description
value NamespacedNames
Returns
Type Description
RestoreConfig.Builder

setSelectedApplications(NamespacedNames.Builder builderForValue)

public RestoreConfig.Builder setSelectedApplications(NamespacedNames.Builder builderForValue)

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;

Parameter
Name Description
builderForValue NamespacedNames.Builder
Returns
Type Description
RestoreConfig.Builder

setSelectedNamespaces(Namespaces value)

public RestoreConfig.Builder setSelectedNamespaces(Namespaces value)

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;

Parameter
Name Description
value Namespaces
Returns
Type Description
RestoreConfig.Builder

setSelectedNamespaces(Namespaces.Builder builderForValue)

public RestoreConfig.Builder setSelectedNamespaces(Namespaces.Builder builderForValue)

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;

Parameter
Name Description
builderForValue Namespaces.Builder
Returns
Type Description
RestoreConfig.Builder

setSubstitutionRules(int index, RestoreConfig.SubstitutionRule value)

public RestoreConfig.Builder setSubstitutionRules(int index, RestoreConfig.SubstitutionRule value)

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];

Parameters
Name Description
index int
value RestoreConfig.SubstitutionRule
Returns
Type Description
RestoreConfig.Builder

setSubstitutionRules(int index, RestoreConfig.SubstitutionRule.Builder builderForValue)

public RestoreConfig.Builder setSubstitutionRules(int index, RestoreConfig.SubstitutionRule.Builder builderForValue)

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];

Parameters
Name Description
index int
builderForValue RestoreConfig.SubstitutionRule.Builder
Returns
Type Description
RestoreConfig.Builder

setTransformationRules(int index, RestoreConfig.TransformationRule value)

public RestoreConfig.Builder setTransformationRules(int index, RestoreConfig.TransformationRule value)

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];

Parameters
Name Description
index int
value RestoreConfig.TransformationRule
Returns
Type Description
RestoreConfig.Builder

setTransformationRules(int index, RestoreConfig.TransformationRule.Builder builderForValue)

public RestoreConfig.Builder setTransformationRules(int index, RestoreConfig.TransformationRule.Builder builderForValue)

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];

Parameters
Name Description
index int
builderForValue RestoreConfig.TransformationRule.Builder
Returns
Type Description
RestoreConfig.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final RestoreConfig.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
RestoreConfig.Builder
Overrides

setVolumeDataRestorePolicy(RestoreConfig.VolumeDataRestorePolicy value)

public RestoreConfig.Builder setVolumeDataRestorePolicy(RestoreConfig.VolumeDataRestorePolicy value)

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];

Parameter
Name Description
value RestoreConfig.VolumeDataRestorePolicy

The volumeDataRestorePolicy to set.
Returns
Type Description
RestoreConfig.Builder

This builder for chaining.

setVolumeDataRestorePolicyBindings(int index, RestoreConfig.VolumeDataRestorePolicyBinding value)

public RestoreConfig.Builder setVolumeDataRestorePolicyBindings(int index, RestoreConfig.VolumeDataRestorePolicyBinding value)

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];

Parameters
Name Description
index int
value RestoreConfig.VolumeDataRestorePolicyBinding
Returns
Type Description
RestoreConfig.Builder

setVolumeDataRestorePolicyBindings(int index, RestoreConfig.VolumeDataRestorePolicyBinding.Builder builderForValue)

public RestoreConfig.Builder setVolumeDataRestorePolicyBindings(int index, RestoreConfig.VolumeDataRestorePolicyBinding.Builder builderForValue)

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];

Parameters
Name Description
index int
builderForValue RestoreConfig.VolumeDataRestorePolicyBinding.Builder
Returns
Type Description
RestoreConfig.Builder

setVolumeDataRestorePolicyValue(int value)

public RestoreConfig.Builder setVolumeDataRestorePolicyValue(int value)

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];

Parameter
Name Description
value int

The enum numeric value on the wire for volumeDataRestorePolicy to set.
Returns
Type Description
RestoreConfig.Builder

This builder for chaining.