Class RestoreConfig (0.42.0)

public final class RestoreConfig extends GeneratedMessageV3 implements RestoreConfigOrBuilder

Configuration of a restore.

Protobuf type google.cloud.gkebackup.v1.RestoreConfig

Static Fields

ALL_NAMESPACES_FIELD_NUMBER

public static final int ALL_NAMESPACES_FIELD_NUMBER
Field Value
Type Description
int

CLUSTER_RESOURCE_CONFLICT_POLICY_FIELD_NUMBER

public static final int CLUSTER_RESOURCE_CONFLICT_POLICY_FIELD_NUMBER
Field Value
Type Description
int

CLUSTER_RESOURCE_RESTORE_SCOPE_FIELD_NUMBER

public static final int CLUSTER_RESOURCE_RESTORE_SCOPE_FIELD_NUMBER
Field Value
Type Description
int

EXCLUDED_NAMESPACES_FIELD_NUMBER

public static final int EXCLUDED_NAMESPACES_FIELD_NUMBER
Field Value
Type Description
int

NAMESPACED_RESOURCE_RESTORE_MODE_FIELD_NUMBER

public static final int NAMESPACED_RESOURCE_RESTORE_MODE_FIELD_NUMBER
Field Value
Type Description
int

NO_NAMESPACES_FIELD_NUMBER

public static final int NO_NAMESPACES_FIELD_NUMBER
Field Value
Type Description
int

SELECTED_APPLICATIONS_FIELD_NUMBER

public static final int SELECTED_APPLICATIONS_FIELD_NUMBER
Field Value
Type Description
int

SELECTED_NAMESPACES_FIELD_NUMBER

public static final int SELECTED_NAMESPACES_FIELD_NUMBER
Field Value
Type Description
int

SUBSTITUTION_RULES_FIELD_NUMBER

public static final int SUBSTITUTION_RULES_FIELD_NUMBER
Field Value
Type Description
int

TRANSFORMATION_RULES_FIELD_NUMBER

public static final int TRANSFORMATION_RULES_FIELD_NUMBER
Field Value
Type Description
int

VOLUME_DATA_RESTORE_POLICY_FIELD_NUMBER

public static final int VOLUME_DATA_RESTORE_POLICY_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static RestoreConfig getDefaultInstance()
Returns
Type Description
RestoreConfig

getDescriptor()

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

newBuilder()

public static RestoreConfig.Builder newBuilder()
Returns
Type Description
RestoreConfig.Builder

newBuilder(RestoreConfig prototype)

public static RestoreConfig.Builder newBuilder(RestoreConfig prototype)
Parameter
Name Description
prototype RestoreConfig
Returns
Type Description
RestoreConfig.Builder

parseDelimitedFrom(InputStream input)

public static RestoreConfig parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
RestoreConfig
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RestoreConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RestoreConfig
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static RestoreConfig parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
RestoreConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static RestoreConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RestoreConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static RestoreConfig parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
RestoreConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static RestoreConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RestoreConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static RestoreConfig parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
RestoreConfig
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static RestoreConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RestoreConfig
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static RestoreConfig parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
RestoreConfig
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RestoreConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RestoreConfig
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static RestoreConfig parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
RestoreConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static RestoreConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RestoreConfig
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<RestoreConfig> parser()
Returns
Type Description
Parser<RestoreConfig>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
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.

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

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.

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.

getParserForType()

public Parser<RestoreConfig> getParserForType()
Returns
Type Description
Parser<RestoreConfig>
Overrides

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.

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.

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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

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

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.

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.

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected RestoreConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
RestoreConfig.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

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

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException