public final class RestoreConfig extends GeneratedMessageV3 implements RestoreConfigOrBuilder
Configuration of a restore.
Next id: 9
Protobuf type google.cloud.gkebackup.v1.RestoreConfig
Static Fields
ALL_NAMESPACES_FIELD_NUMBER
public static final int ALL_NAMESPACES_FIELD_NUMBER
Field Value
CLUSTER_RESOURCE_CONFLICT_POLICY_FIELD_NUMBER
public static final int CLUSTER_RESOURCE_CONFLICT_POLICY_FIELD_NUMBER
Field Value
CLUSTER_RESOURCE_RESTORE_SCOPE_FIELD_NUMBER
public static final int CLUSTER_RESOURCE_RESTORE_SCOPE_FIELD_NUMBER
Field Value
NAMESPACED_RESOURCE_RESTORE_MODE_FIELD_NUMBER
public static final int NAMESPACED_RESOURCE_RESTORE_MODE_FIELD_NUMBER
Field Value
SELECTED_APPLICATIONS_FIELD_NUMBER
public static final int SELECTED_APPLICATIONS_FIELD_NUMBER
Field Value
SELECTED_NAMESPACES_FIELD_NUMBER
public static final int SELECTED_NAMESPACES_FIELD_NUMBER
Field Value
SUBSTITUTION_RULES_FIELD_NUMBER
public static final int SUBSTITUTION_RULES_FIELD_NUMBER
Field Value
VOLUME_DATA_RESTORE_POLICY_FIELD_NUMBER
public static final int VOLUME_DATA_RESTORE_POLICY_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static RestoreConfig getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static RestoreConfig.Builder newBuilder()
Returns
newBuilder(RestoreConfig prototype)
public static RestoreConfig.Builder newBuilder(RestoreConfig prototype)
Parameter
Returns
public static RestoreConfig parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static RestoreConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static RestoreConfig parseFrom(byte[] data)
Parameter
Name | Description |
data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static RestoreConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static RestoreConfig parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static RestoreConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static RestoreConfig parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static RestoreConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static RestoreConfig parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static RestoreConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static RestoreConfig parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static RestoreConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<RestoreConfig> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
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;
Returns
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;
Returns
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;
Returns
getDefaultInstanceForType()
public RestoreConfig getDefaultInstanceForType()
Returns
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;
Returns
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()
Returns
getParserForType()
public Parser<RestoreConfig> getParserForType()
Returns
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
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
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
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
getSerializedSize()
public int getSerializedSize()
Returns
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
Returns
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
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;
Returns
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
Returns
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> | |
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
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;
Returns
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.
|
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
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public RestoreConfig.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected RestoreConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public RestoreConfig.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions