public final class RestoreConfig extends GeneratedMessageV3 implements RestoreConfigOrBuilder
Configuration of a restore.
Next id: 12
Protobuf type google.cloud.gkebackup.v1.RestoreConfig
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
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 | |
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()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static RestoreConfig.Builder newBuilder()
newBuilder(RestoreConfig prototype)
public static RestoreConfig.Builder newBuilder(RestoreConfig prototype)
public static RestoreConfig parseDelimitedFrom(InputStream input)
public static RestoreConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static RestoreConfig parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static RestoreConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static RestoreConfig parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static RestoreConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static RestoreConfig parseFrom(CodedInputStream input)
public static RestoreConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static RestoreConfig parseFrom(InputStream input)
public static RestoreConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static RestoreConfig parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static RestoreConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<RestoreConfig> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
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()
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;
getClusterResourceConflictPolicyValue()
public int getClusterResourceConflictPolicyValue()
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;
| Returns |
|---|
| Type | Description |
int | The enum numeric value on the wire for clusterResourceConflictPolicy.
|
getClusterResourceRestoreScope()
public RestoreConfig.ClusterResourceRestoreScope getClusterResourceRestoreScope()
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;
getClusterResourceRestoreScopeOrBuilder()
public RestoreConfig.ClusterResourceRestoreScopeOrBuilder getClusterResourceRestoreScopeOrBuilder()
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;
getDefaultInstanceForType()
public RestoreConfig getDefaultInstanceForType()
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;
getNamespacedResourceRestoreMode()
public RestoreConfig.NamespacedResourceRestoreMode getNamespacedResourceRestoreMode()
Defines the behavior for handling the situation where sets of namespaced
resources being restored already exist in the target cluster. This MUST be
set to a value other than NAMESPACED_RESOURCE_RESTORE_MODE_UNSPECIFIED.
.google.cloud.gkebackup.v1.RestoreConfig.NamespacedResourceRestoreMode namespaced_resource_restore_mode = 3;
getNamespacedResourceRestoreModeValue()
public int getNamespacedResourceRestoreModeValue()
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;
| Returns |
|---|
| Type | Description |
int | The enum numeric value on the wire for namespacedResourceRestoreMode.
|
getNamespacedResourceRestoreScopeCase()
public RestoreConfig.NamespacedResourceRestoreScopeCase getNamespacedResourceRestoreScopeCase()
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()
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;
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;
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;
getSerializedSize()
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
int | |
Overrides
getSubstitutionRules(int index)
public RestoreConfig.SubstitutionRule getSubstitutionRules(int index)
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;
| Parameter |
|---|
| Name | Description |
index | int
|
getSubstitutionRulesCount()
public int getSubstitutionRulesCount()
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;
| Returns |
|---|
| Type | Description |
int | |
getSubstitutionRulesList()
public List<RestoreConfig.SubstitutionRule> getSubstitutionRulesList()
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;
getSubstitutionRulesOrBuilder(int index)
public RestoreConfig.SubstitutionRuleOrBuilder getSubstitutionRulesOrBuilder(int index)
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;
| Parameter |
|---|
| Name | Description |
index | int
|
getSubstitutionRulesOrBuilderList()
public List<? extends RestoreConfig.SubstitutionRuleOrBuilder> getSubstitutionRulesOrBuilderList()
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;
| Returns |
|---|
| Type | Description |
List<? extends com.google.cloud.gkebackup.v1.RestoreConfig.SubstitutionRuleOrBuilder> | |
public RestoreConfig.TransformationRule getTransformationRules(int index)
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;
| Parameter |
|---|
| Name | Description |
index | int
|
public int getTransformationRulesCount()
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;
| Returns |
|---|
| Type | Description |
int | |
public List<RestoreConfig.TransformationRule> getTransformationRulesList()
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;
public RestoreConfig.TransformationRuleOrBuilder getTransformationRulesOrBuilder(int index)
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;
| Parameter |
|---|
| Name | Description |
index | int
|
public List<? extends RestoreConfig.TransformationRuleOrBuilder> getTransformationRulesOrBuilderList()
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;
| Returns |
|---|
| Type | Description |
List<? extends com.google.cloud.gkebackup.v1.RestoreConfig.TransformationRuleOrBuilder> | |
getVolumeDataRestorePolicy()
public RestoreConfig.VolumeDataRestorePolicy getVolumeDataRestorePolicy()
Specifies the mechanism to be used to restore volume data.
Default: VOLUME_DATA_RESTORE_POLICY_UNSPECIFIED (will be treated as
NO_VOLUME_DATA_RESTORATION).
.google.cloud.gkebackup.v1.RestoreConfig.VolumeDataRestorePolicy volume_data_restore_policy = 1;
getVolumeDataRestorePolicyValue()
public int getVolumeDataRestorePolicyValue()
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;
| 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()
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;
| 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()
| Returns |
|---|
| Type | Description |
int | |
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public RestoreConfig.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected RestoreConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
toBuilder()
public RestoreConfig.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
