Package com.google.cloud.gkebackup.v1

Class RestoreConfig

  • All Implemented Interfaces:
    RestoreConfigOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class RestoreConfig
extends com.google.protobuf.GeneratedMessageV3
implements RestoreConfigOrBuilder
     Configuration of a restore.
 Next id: 12
    Protobuf type google.cloud.gkebackup.v1.RestoreConfig
    See Also:
    Serialized Form

    • Field Detail

      • VOLUME_DATA_RESTORE_POLICY_FIELD_NUMBER

        public static final int VOLUME_DATA_RESTORE_POLICY_FIELD_NUMBER
        See Also:
        Constant Field Values

      • CLUSTER_RESOURCE_CONFLICT_POLICY_FIELD_NUMBER

        public static final int CLUSTER_RESOURCE_CONFLICT_POLICY_FIELD_NUMBER
        See Also:
        Constant Field Values

      • NAMESPACED_RESOURCE_RESTORE_MODE_FIELD_NUMBER

        public static final int NAMESPACED_RESOURCE_RESTORE_MODE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • CLUSTER_RESOURCE_RESTORE_SCOPE_FIELD_NUMBER

        public static final int CLUSTER_RESOURCE_RESTORE_SCOPE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • ALL_NAMESPACES_FIELD_NUMBER

        public static final int ALL_NAMESPACES_FIELD_NUMBER
        See Also:
        Constant Field Values

      • SELECTED_NAMESPACES_FIELD_NUMBER

        public static final int SELECTED_NAMESPACES_FIELD_NUMBER
        See Also:
        Constant Field Values

      • SELECTED_APPLICATIONS_FIELD_NUMBER

        public static final int SELECTED_APPLICATIONS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • NO_NAMESPACES_FIELD_NUMBER

        public static final int NO_NAMESPACES_FIELD_NUMBER
        See Also:
        Constant Field Values

      • EXCLUDED_NAMESPACES_FIELD_NUMBER

        public static final int EXCLUDED_NAMESPACES_FIELD_NUMBER
        See Also:
        Constant Field Values

      • SUBSTITUTION_RULES_FIELD_NUMBER

        public static final int SUBSTITUTION_RULES_FIELD_NUMBER
        See Also:
        Constant Field Values

      • TRANSFORMATION_RULES_FIELD_NUMBER

        public static final int TRANSFORMATION_RULES_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • 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;
        Specified by:
        getVolumeDataRestorePolicyValue in interface RestoreConfigOrBuilder
        Returns:
        The enum numeric value on the wire for volumeDataRestorePolicy.

      • 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;
        Specified by:
        getVolumeDataRestorePolicy in interface RestoreConfigOrBuilder
        Returns:
        The volumeDataRestorePolicy.

      • 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][google.cloud.gkebackup.v1.RestoreConfig.cluster_resource_restore_scope]
 is not empty.
        .google.cloud.gkebackup.v1.RestoreConfig.ClusterResourceConflictPolicy cluster_resource_conflict_policy = 2;
        Specified by:
        getClusterResourceConflictPolicyValue in interface RestoreConfigOrBuilder
        Returns:
        The enum numeric value on the wire for clusterResourceConflictPolicy.

      • 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][google.cloud.gkebackup.v1.RestoreConfig.cluster_resource_restore_scope]
 is not empty.
        .google.cloud.gkebackup.v1.RestoreConfig.ClusterResourceConflictPolicy cluster_resource_conflict_policy = 2;
        Specified by:
        getClusterResourceConflictPolicy in interface RestoreConfigOrBuilder
        Returns:
        The clusterResourceConflictPolicy.

      • 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;
        Specified by:
        getNamespacedResourceRestoreModeValue in interface RestoreConfigOrBuilder
        Returns:
        The enum numeric value on the wire for namespacedResourceRestoreMode.

      • 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;
        Specified by:
        getNamespacedResourceRestoreMode in interface RestoreConfigOrBuilder
        Returns:
        The namespacedResourceRestoreMode.

      • 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;
        Specified by:
        hasClusterResourceRestoreScope in interface RestoreConfigOrBuilder
        Returns:
        Whether the clusterResourceRestoreScope field is set.

      • 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;
        Specified by:
        getClusterResourceRestoreScope in interface RestoreConfigOrBuilder
        Returns:
        The clusterResourceRestoreScope.

      • 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;
        Specified by:
        hasAllNamespaces in interface RestoreConfigOrBuilder
        Returns:
        Whether the allNamespaces field is set.

      • 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;
        Specified by:
        getAllNamespaces in interface RestoreConfigOrBuilder
        Returns:
        The allNamespaces.

      • 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;
        Specified by:
        hasSelectedNamespaces in interface RestoreConfigOrBuilder
        Returns:
        Whether the selectedNamespaces field is set.

      • 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;
        Specified by:
        getSelectedNamespaces in interface RestoreConfigOrBuilder
        Returns:
        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;
        Specified by:
        getSelectedNamespacesOrBuilder in interface RestoreConfigOrBuilder

      • 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;
        Specified by:
        hasSelectedApplications in interface RestoreConfigOrBuilder
        Returns:
        Whether the selectedApplications field is set.

      • 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;
        Specified by:
        getSelectedApplications in interface RestoreConfigOrBuilder
        Returns:
        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;
        Specified by:
        getSelectedApplicationsOrBuilder in interface RestoreConfigOrBuilder

      • 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;
        Specified by:
        hasNoNamespaces in interface RestoreConfigOrBuilder
        Returns:
        Whether the noNamespaces field is set.

      • 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;
        Specified by:
        getNoNamespaces in interface RestoreConfigOrBuilder
        Returns:
        The noNamespaces.

      • 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;
        Specified by:
        hasExcludedNamespaces in interface RestoreConfigOrBuilder
        Returns:
        Whether the excludedNamespaces field is set.

      • 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;
        Specified by:
        getExcludedNamespaces in interface RestoreConfigOrBuilder
        Returns:
        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;
        Specified by:
        getExcludedNamespacesOrBuilder in interface RestoreConfigOrBuilder

      • 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;
        Specified by:
        getSubstitutionRulesList in interface RestoreConfigOrBuilder

      • 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;
        Specified by:
        getSubstitutionRulesOrBuilderList in interface RestoreConfigOrBuilder

      • 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;
        Specified by:
        getSubstitutionRulesCount in interface RestoreConfigOrBuilder

      • getSubstitutionRules

        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;
        Specified by:
        getSubstitutionRules in interface RestoreConfigOrBuilder

      • getSubstitutionRulesOrBuilder

        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;
        Specified by:
        getSubstitutionRulesOrBuilder in interface RestoreConfigOrBuilder

      • getTransformationRulesList

        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;
        Specified by:
        getTransformationRulesList in interface RestoreConfigOrBuilder

      • getTransformationRulesOrBuilderList

        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;
        Specified by:
        getTransformationRulesOrBuilderList in interface RestoreConfigOrBuilder

      • getTransformationRulesCount

        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;
        Specified by:
        getTransformationRulesCount in interface RestoreConfigOrBuilder

      • getTransformationRules

        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;
        Specified by:
        getTransformationRules in interface RestoreConfigOrBuilder

      • getTransformationRulesOrBuilder

        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;
        Specified by:
        getTransformationRulesOrBuilder in interface RestoreConfigOrBuilder

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static RestoreConfig parseFrom​(ByteBuffer data)
                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static RestoreConfig parseFrom​(ByteBuffer data,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static RestoreConfig parseFrom​(com.google.protobuf.ByteString data)
                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static RestoreConfig parseFrom​(com.google.protobuf.ByteString data,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static RestoreConfig parseFrom​(byte[] data)
                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static RestoreConfig parseFrom​(byte[] data,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static RestoreConfig parseFrom​(com.google.protobuf.CodedInputStream input,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws IOException
        Throws:
        IOException

      • newBuilderForType

        public RestoreConfig.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public RestoreConfig.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected RestoreConfig.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstance

        public static RestoreConfig getDefaultInstance()

      • parser

        public static com.google.protobuf.Parser<RestoreConfig> parser()

      • getParserForType

        public com.google.protobuf.Parser<RestoreConfig> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public RestoreConfig getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder