google-cloud-gke_backup-v1 0.a → 0.1.0

data/proto_docs/google/cloud/gkebackup/v1/restore.rb

@@ -0,0 +1,325 @@
+# frozen_string_literal: true
+
+# Copyright 2022 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module GkeBackup
+      module V1
+        # Represents both a request to Restore some portion of a Backup into
+        # a target GKE cluster and a record of the restore operation itself.
+        # Next id: 18
+        # @!attribute [r] name
+        #   @return [::String]
+        #     Output only. The full name of the Restore resource.
+        #     Format: projects/*/locations/*/restorePlans/*/restores/*
+        # @!attribute [r] uid
+        #   @return [::String]
+        #     Output only. Server generated global unique identifier of
+        #     [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier) format.
+        # @!attribute [r] create_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. The timestamp when this Restore resource was created.
+        # @!attribute [r] update_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. The timestamp when this Restore resource was last
+        #     updated.
+        # @!attribute [rw] description
+        #   @return [::String]
+        #     User specified descriptive string for this Restore.
+        # @!attribute [rw] backup
+        #   @return [::String]
+        #     Required. Immutable. A reference to the {::Google::Cloud::GkeBackup::V1::Backup Backup} used as the source from which this Restore
+        #     will restore. Note that this Backup must be a sub-resource of the
+        #     RestorePlan's {::Google::Cloud::GkeBackup::V1::RestorePlan#backup_plan backup_plan}.
+        #     Format: projects/*/locations/*/backupPlans/*/backups/*.
+        # @!attribute [r] cluster
+        #   @return [::String]
+        #     Output only. The target cluster into which this Restore will restore data.
+        #     Valid formats:
+        #
+        #       - projects/*/locations/*/clusters/*
+        #       - projects/*/zones/*/clusters/*
+        #
+        #     Inherited from parent RestorePlan's {::Google::Cloud::GkeBackup::V1::RestorePlan#cluster cluster} value.
+        # @!attribute [r] restore_config
+        #   @return [::Google::Cloud::GkeBackup::V1::RestoreConfig]
+        #     Output only. Configuration of the Restore.  Inherited from parent RestorePlan's
+        #     {::Google::Cloud::GkeBackup::V1::RestorePlan#restore_config restore_config}.
+        # @!attribute [rw] labels
+        #   @return [::Google::Protobuf::Map{::String => ::String}]
+        #     A set of custom labels supplied by user.
+        # @!attribute [r] state
+        #   @return [::Google::Cloud::GkeBackup::V1::Restore::State]
+        #     Output only. The current state of the Restore.
+        # @!attribute [r] state_reason
+        #   @return [::String]
+        #     Output only. Human-readable description of why the Restore is in its current state.
+        # @!attribute [r] complete_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. Timestamp of when the restore operation completed.
+        # @!attribute [r] resources_restored_count
+        #   @return [::Integer]
+        #     Output only. Number of resources restored during the restore execution.
+        # @!attribute [r] resources_excluded_count
+        #   @return [::Integer]
+        #     Output only. Number of resources excluded during the restore execution.
+        # @!attribute [r] resources_failed_count
+        #   @return [::Integer]
+        #     Output only. Number of resources that failed to be restored during the restore
+        #     execution.
+        # @!attribute [r] volumes_restored_count
+        #   @return [::Integer]
+        #     Output only. Number of volumes restored during the restore execution.
+        # @!attribute [r] etag
+        #   @return [::String]
+        #     Output only. `etag` is used for optimistic concurrency control as a way to help
+        #     prevent simultaneous updates of a restore from overwriting each other.
+        #     It is strongly suggested that systems make use of the `etag` in the
+        #     read-modify-write cycle to perform restore updates in order to avoid
+        #     race conditions: An `etag` is returned in the response to `GetRestore`,
+        #     and systems are expected to put that etag in the request to
+        #     `UpdateRestore` or `DeleteRestore` to ensure that their change will be
+        #     applied to the same version of the resource.
+        class Restore
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # @!attribute [rw] key
+          #   @return [::String]
+          # @!attribute [rw] value
+          #   @return [::String]
+          class LabelsEntry
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Possible values for state of the Restore.
+          module State
+            # The Restore resource is in the process of being created.
+            STATE_UNSPECIFIED = 0
+
+            # The Restore resource has been created and the associated RestoreJob
+            # Kubernetes resource has been injected into target cluster.
+            CREATING = 1
+
+            # The gkebackup agent in the cluster has begun executing the restore
+            # operation.
+            IN_PROGRESS = 2
+
+            # The restore operation has completed successfully. Restored workloads may
+            # not yet be operational.
+            SUCCEEDED = 3
+
+            # The restore operation has failed.
+            FAILED = 4
+
+            # This Restore resource is in the process of being deleted.
+            DELETING = 5
+          end
+        end
+
+        # Configuration of a restore.
+        # Next id: 9
+        # @!attribute [rw] volume_data_restore_policy
+        #   @return [::Google::Cloud::GkeBackup::V1::RestoreConfig::VolumeDataRestorePolicy]
+        #     Specifies the mechanism to be used to restore volume data.
+        #     Default: VOLUME_DATA_RESTORE_POLICY_UNSPECIFIED (will be treated as
+        #     NO_VOLUME_DATA_RESTORATION).
+        # @!attribute [rw] cluster_resource_conflict_policy
+        #   @return [::Google::Cloud::GkeBackup::V1::RestoreConfig::ClusterResourceConflictPolicy]
+        #     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
+        #     {::Google::Cloud::GkeBackup::V1::RestoreConfig#cluster_resource_restore_scope cluster_resource_restore_scope} is not empty.
+        # @!attribute [rw] namespaced_resource_restore_mode
+        #   @return [::Google::Cloud::GkeBackup::V1::RestoreConfig::NamespacedResourceRestoreMode]
+        #     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.
+        # @!attribute [rw] cluster_resource_restore_scope
+        #   @return [::Google::Cloud::GkeBackup::V1::RestoreConfig::ClusterResourceRestoreScope]
+        #     Identifies the cluster-scoped resources to restore from the Backup.
+        #     Not specifying it means NO cluster resource will be restored.
+        # @!attribute [rw] all_namespaces
+        #   @return [::Boolean]
+        #     Restore all namespaced resources in the Backup if set to "True".
+        #     Specifying this field to "False" is an error.
+        # @!attribute [rw] selected_namespaces
+        #   @return [::Google::Cloud::GkeBackup::V1::Namespaces]
+        #     A list of selected Namespaces to restore from the Backup. The listed
+        #     Namespaces and all resources contained in them will be restored.
+        # @!attribute [rw] selected_applications
+        #   @return [::Google::Cloud::GkeBackup::V1::NamespacedNames]
+        #     A list of selected ProtectedApplications to restore. The listed
+        #     ProtectedApplications and all the resources to which they refer will be
+        #     restored.
+        # @!attribute [rw] substitution_rules
+        #   @return [::Array<::Google::Cloud::GkeBackup::V1::RestoreConfig::SubstitutionRule>]
+        #     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.
+        class RestoreConfig
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # This is a direct map to the Kubernetes GroupKind type
+          # [GroupKind](https://godoc.org/k8s.io/apimachinery/pkg/runtime/schema#GroupKind)
+          # and is used for identifying specific "types" of resources to restore.
+          # @!attribute [rw] resource_group
+          #   @return [::String]
+          #     API group string of a Kubernetes resource, e.g.
+          #     "apiextensions.k8s.io", "storage.k8s.io", etc.
+          #     Note: use empty string for core API group
+          # @!attribute [rw] resource_kind
+          #   @return [::String]
+          #     Kind of a Kubernetes resource, e.g.
+          #     "CustomResourceDefinition", "StorageClass", etc.
+          class GroupKind
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Identifies the cluster-scoped resources to restore from the Backup.
+          # @!attribute [rw] selected_group_kinds
+          #   @return [::Array<::Google::Cloud::GkeBackup::V1::RestoreConfig::GroupKind>]
+          #     A list of "types" of cluster-scoped resources to be restored from the
+          #     Backup.  An empty list means that NO cluster-scoped resources will be
+          #     restored. Note that Namespaces and PersistentVolume restoration is
+          #     handled separately and is not governed by this field.
+          class ClusterResourceRestoreScope
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # A transformation rule to be applied against Kubernetes resources as they
+          # are selected for restoration from a Backup. A rule contains both filtering
+          # logic (which resources are subject to substitution) and substitution logic.
+          # @!attribute [rw] target_namespaces
+          #   @return [::Array<::String>]
+          #     (Filtering parameter) Any resource subject to substitution must be
+          #     contained within one of the listed Kubernetes Namespace in the Backup.
+          #     If this field is not provided, no namespace filtering will be performed
+          #     (all resources in all Namespaces, including all cluster-scoped resources,
+          #     will be candidates for substitution).
+          #     To mix cluster-scoped and namespaced resources in the same rule, use an
+          #     empty string ("") as one of the target namespaces.
+          # @!attribute [rw] target_group_kinds
+          #   @return [::Array<::Google::Cloud::GkeBackup::V1::RestoreConfig::GroupKind>]
+          #     (Filtering parameter) Any resource subject to substitution must belong to
+          #     one of the listed "types".
+          #     If this field is not provided, no type filtering will be performed (all
+          #     resources of all types matching previous filtering parameters will be
+          #     candidates for substitution).
+          # @!attribute [rw] target_json_path
+          #   @return [::String]
+          #     Required. This is a [JSONPath]
+          #     (https://kubernetes.io/docs/reference/kubectl/jsonpath/)
+          #     expression that matches specific fields of candidate
+          #     resources and it operates as both a filtering parameter (resources that
+          #     are not matched with this expression will not be candidates for
+          #     substitution) as well as a field identifier (identifies exactly which
+          #     fields out of the candidate resources will be modified).
+          # @!attribute [rw] original_value_pattern
+          #   @return [::String]
+          #     (Filtering parameter) This is a [regular expression]
+          #     (https://en.wikipedia.org/wiki/Regular_expression)
+          #     that is compared against the fields matched by the target_json_path
+          #     expression (and must also have passed the previous filters).
+          #     Substitution will not be performed against fields whose
+          #     value does not match this expression. If this field is NOT specified,
+          #     then ALL fields matched by the target_json_path expression will undergo
+          #     substitution. Note that an empty (e.g., "", rather than unspecified)
+          #     value for for this field will only match empty fields.
+          # @!attribute [rw] new_value
+          #   @return [::String]
+          #     This is the new value to set for any fields that pass the filtering and
+          #     selection criteria. To remove a value from a Kubernetes resource, either
+          #     leave this field unspecified, or set it to the empty string ("").
+          class SubstitutionRule
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Defines how volume data should be restored
+          module VolumeDataRestorePolicy
+            # Unspecified (illegal).
+            VOLUME_DATA_RESTORE_POLICY_UNSPECIFIED = 0
+
+            # For each PVC to be restored, will create a new underlying volume (and PV)
+            # from the corresponding VolumeBackup contained within the Backup.
+            RESTORE_VOLUME_DATA_FROM_BACKUP = 1
+
+            # For each PVC to be restored, attempt to reuse the original PV contained
+            # in the Backup (with its original underlying volume).  Note that option
+            # is likely only usable when restoring a workload to its original cluster.
+            REUSE_VOLUME_HANDLE_FROM_BACKUP = 2
+
+            # For each PVC to be restored, PVCs will be created without any particular
+            # action to restore data.  In this case, the normal Kubernetes provisioning
+            # logic would kick in, and this would likely result in either dynamically
+            # provisioning blank PVs or binding to statically provisioned PVs.
+            NO_VOLUME_DATA_RESTORATION = 3
+          end
+
+          # Defines the behavior for handling the situation where cluster-scoped
+          # resources being restored already exist in the target cluster.
+          module ClusterResourceConflictPolicy
+            # Unspecified. Only allowed if no cluster-scoped resources will be
+            # restored.
+            CLUSTER_RESOURCE_CONFLICT_POLICY_UNSPECIFIED = 0
+
+            # Do not attempt to restore the conflicting resource.
+            USE_EXISTING_VERSION = 1
+
+            # Delete the existing version before re-creating it from the Backup.
+            # Note that this is a dangerous option which could cause unintentional
+            # data loss if used inappropriately - for example, deleting a CRD will
+            # cause Kubernetes to delete all CRs of that type.
+            USE_BACKUP_VERSION = 2
+          end
+
+          # Defines the behavior for handling the situation where sets of namespaced
+          # resources being restored already exist in the target cluster.
+          module NamespacedResourceRestoreMode
+            # Unspecified (invalid).
+            NAMESPACED_RESOURCE_RESTORE_MODE_UNSPECIFIED = 0
+
+            # When conflicting top-level resources (either Namespaces or
+            # ProtectedApplications, depending upon the scope) are encountered, this
+            # will first trigger a delete of the conflicting resource AND ALL OF ITS
+            # REFERENCED RESOURCES (e.g., all resources in the Namespace or all
+            # resources referenced by the ProtectedApplication) before restoring the
+            # resources from the Backup. This mode should only be used when you are
+            # intending to revert some portion of a cluster to an earlier state.
+            DELETE_AND_RESTORE = 1
+
+            # If conflicting top-level resources (either Namespaces or
+            # ProtectedApplications, depending upon the scope) are encountered at the
+            # beginning of a restore process, the Restore will fail.  If a conflict
+            # occurs during the restore process itself (e.g., because an out of band
+            # process creates conflicting resources), a conflict will be reported.
+            FAIL_ON_CONFLICT = 2
+          end
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/cloud/gkebackup/v1/restore_plan.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+# Copyright 2022 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module GkeBackup
+      module V1
+        # The configuration of a potential series of Restore operations to be performed
+        # against Backups belong to a particular BackupPlan.
+        # Next id: 11
+        # @!attribute [r] name
+        #   @return [::String]
+        #     Output only. The full name of the RestorePlan resource.
+        #     Format: projects/*/locations/*/restorePlans/*.
+        # @!attribute [r] uid
+        #   @return [::String]
+        #     Output only. Server generated global unique identifier of
+        #     [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier) format.
+        # @!attribute [r] create_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. The timestamp when this RestorePlan resource was
+        #     created.
+        # @!attribute [r] update_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. The timestamp when this RestorePlan resource was last
+        #     updated.
+        # @!attribute [rw] description
+        #   @return [::String]
+        #     User specified descriptive string for this RestorePlan.
+        # @!attribute [rw] backup_plan
+        #   @return [::String]
+        #     Required. Immutable. A reference to the {::Google::Cloud::GkeBackup::V1::BackupPlan BackupPlan} from which Backups may be used as the
+        #     source for Restores created via this RestorePlan.
+        #     Format: projects/*/locations/*/backupPlans/*.
+        # @!attribute [rw] cluster
+        #   @return [::String]
+        #     Required. Immutable. The target cluster into which Restores created via this RestorePlan
+        #     will restore data. NOTE: the cluster's region must be the same as the
+        #     RestorePlan.
+        #     Valid formats:
+        #
+        #       - projects/*/locations/*/clusters/*
+        #       - projects/*/zones/*/clusters/*
+        # @!attribute [rw] restore_config
+        #   @return [::Google::Cloud::GkeBackup::V1::RestoreConfig]
+        #     Required. Configuration of Restores created via this RestorePlan.
+        # @!attribute [rw] labels
+        #   @return [::Google::Protobuf::Map{::String => ::String}]
+        #     A set of custom labels supplied by user.
+        # @!attribute [r] etag
+        #   @return [::String]
+        #     Output only. `etag` is used for optimistic concurrency control as a way to help
+        #     prevent simultaneous updates of a restore from overwriting each other.
+        #     It is strongly suggested that systems make use of the `etag` in the
+        #     read-modify-write cycle to perform restore updates in order to avoid
+        #     race conditions: An `etag` is returned in the response to `GetRestorePlan`,
+        #     and systems are expected to put that etag in the request to
+        #     `UpdateRestorePlan` or `DeleteRestorePlan` to ensure that their change
+        #     will be applied to the same version of the resource.
+        class RestorePlan
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # @!attribute [rw] key
+          #   @return [::String]
+          # @!attribute [rw] value
+          #   @return [::String]
+          class LabelsEntry
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/cloud/gkebackup/v1/volume.rb

@@ -0,0 +1,214 @@
+# frozen_string_literal: true
+
+# Copyright 2022 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module GkeBackup
+      module V1
+        # Represents the backup of a specific persistent volume as a component of a
+        # Backup - both the record of the operation and a pointer to the underlying
+        # storage-specific artifacts.
+        # Next id: 14
+        # @!attribute [r] name
+        #   @return [::String]
+        #     Output only. The full name of the VolumeBackup resource.
+        #     Format: projects/*/locations/*/backupPlans/*/backups/*/volumeBackups/*.
+        # @!attribute [r] uid
+        #   @return [::String]
+        #     Output only. Server generated global unique identifier of
+        #     [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier) format.
+        # @!attribute [r] create_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. The timestamp when this VolumeBackup resource was
+        #     created.
+        # @!attribute [r] update_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. The timestamp when this VolumeBackup resource was last
+        #     updated.
+        # @!attribute [r] source_pvc
+        #   @return [::Google::Cloud::GkeBackup::V1::NamespacedName]
+        #     Output only. A reference to the source Kubernetes PVC from which this VolumeBackup
+        #     was created.
+        # @!attribute [r] volume_backup_handle
+        #   @return [::String]
+        #     Output only. A storage system-specific opaque handle to the underlying volume backup.
+        # @!attribute [r] format
+        #   @return [::Google::Cloud::GkeBackup::V1::VolumeBackup::VolumeBackupFormat]
+        #     Output only. The format used for the volume backup.
+        # @!attribute [r] storage_bytes
+        #   @return [::Integer]
+        #     Output only. The aggregate size of the underlying artifacts associated with this
+        #     VolumeBackup in the backup storage. This may change over time when
+        #     multiple backups of the same volume share the same backup storage
+        #     location. In particular, this is likely to increase in size when
+        #     the immediately preceding backup of the same volume is deleted.
+        # @!attribute [r] disk_size_bytes
+        #   @return [::Integer]
+        #     Output only. The minimum size of the disk to which this VolumeBackup can be restored.
+        # @!attribute [r] complete_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. The timestamp when the associated underlying volume backup
+        #     operation completed.
+        # @!attribute [r] state
+        #   @return [::Google::Cloud::GkeBackup::V1::VolumeBackup::State]
+        #     Output only. The current state of this VolumeBackup.
+        # @!attribute [r] state_message
+        #   @return [::String]
+        #     Output only. A human readable message explaining why the VolumeBackup is in its current
+        #     state.
+        # @!attribute [r] etag
+        #   @return [::String]
+        #     Output only. `etag` is used for optimistic concurrency control as a way to help
+        #     prevent simultaneous updates of a volume backup from overwriting each
+        #     other. It is strongly suggested that systems make use of the `etag` in the
+        #     read-modify-write cycle to perform volume backup updates in order to avoid
+        #     race conditions.
+        class VolumeBackup
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Identifies the format used for the volume backup.
+          module VolumeBackupFormat
+            # Default value, not specified.
+            VOLUME_BACKUP_FORMAT_UNSPECIFIED = 0
+
+            # Compute Engine Persistent Disk snapshot based volume backup.
+            GCE_PERSISTENT_DISK = 1
+          end
+
+          # The current state of a VolumeBackup
+          module State
+            # This is an illegal state and should not be encountered.
+            STATE_UNSPECIFIED = 0
+
+            # A volume for the backup was identified and backup process is about to
+            # start.
+            CREATING = 1
+
+            # The volume backup operation has begun and is in the initial "snapshot"
+            # phase of the process. Any defined ProtectedApplication "pre" hooks will
+            # be executed before entering this state and "post" hooks will be executed
+            # upon leaving this state.
+            SNAPSHOTTING = 2
+
+            # The snapshot phase of the volume backup operation has completed and
+            # the snapshot is now being uploaded to backup storage.
+            UPLOADING = 3
+
+            # The volume backup operation has completed successfully.
+            SUCCEEDED = 4
+
+            # The volume backup operation has failed.
+            FAILED = 5
+
+            # This VolumeBackup resource (and its associated artifacts) is in the
+            # process of being deleted.
+            DELETING = 6
+          end
+        end
+
+        # Represents the operation of restoring a volume from a VolumeBackup.
+        # Next id: 13
+        # @!attribute [r] name
+        #   @return [::String]
+        #     Output only. Full name of the VolumeRestore resource.
+        #     Format: projects/*/locations/*/restorePlans/*/restores/*/volumeRestores/*.
+        # @!attribute [r] uid
+        #   @return [::String]
+        #     Output only. Server generated global unique identifier of
+        #     [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier) format.
+        # @!attribute [r] create_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. The timestamp when this VolumeRestore resource was
+        #     created.
+        # @!attribute [r] update_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. The timestamp when this VolumeRestore resource was last
+        #     updated.
+        # @!attribute [r] volume_backup
+        #   @return [::String]
+        #     Output only. The full name of the VolumeBackup from which the volume will be restored.
+        #     Format: projects/*/locations/*/backupPlans/*/backups/*/volumeBackups/*.
+        # @!attribute [r] target_pvc
+        #   @return [::Google::Cloud::GkeBackup::V1::NamespacedName]
+        #     Output only. The reference to the target Kubernetes PVC to be restored.
+        # @!attribute [r] volume_handle
+        #   @return [::String]
+        #     Output only. A storage system-specific opaque handler to the underlying volume created
+        #     for the target PVC from the volume backup.
+        # @!attribute [r] volume_type
+        #   @return [::Google::Cloud::GkeBackup::V1::VolumeRestore::VolumeType]
+        #     Output only. The type of volume provisioned
+        # @!attribute [r] complete_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. The timestamp when the associated underlying volume
+        #     restoration completed.
+        # @!attribute [r] state
+        #   @return [::Google::Cloud::GkeBackup::V1::VolumeRestore::State]
+        #     Output only. The current state of this VolumeRestore.
+        # @!attribute [r] state_message
+        #   @return [::String]
+        #     Output only. A human readable message explaining why the VolumeRestore is in its
+        #     current state.
+        # @!attribute [r] etag
+        #   @return [::String]
+        #     Output only. `etag` is used for optimistic concurrency control as a way to help
+        #     prevent simultaneous updates of a volume restore from overwriting each
+        #     other. It is strongly suggested that systems make use of the `etag` in the
+        #     read-modify-write cycle to perform volume restore updates in order to avoid
+        #     race conditions.
+        class VolumeRestore
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Supported volume types.
+          module VolumeType
+            # Default
+            VOLUME_TYPE_UNSPECIFIED = 0
+
+            # Compute Engine Persistent Disk volume
+            GCE_PERSISTENT_DISK = 1
+          end
+
+          # The current state of a VolumeRestore
+          module State
+            # This is an illegal state and should not be encountered.
+            STATE_UNSPECIFIED = 0
+
+            # A volume for the restore was identified and restore process is about to
+            # start.
+            CREATING = 1
+
+            # The volume is currently being restored.
+            RESTORING = 2
+
+            # The volume has been successfully restored.
+            SUCCEEDED = 3
+
+            # The volume restoration process failed.
+            FAILED = 4
+
+            # This VolumeRestore resource is in the process of being deleted.
+            DELETING = 5
+          end
+        end
+      end
+    end
+  end
+end