google-cloud-backupdr-v1 1.12.0 → 1.13.0

data/proto_docs/google/cloud/backupdr/v1/restore_template.rb

@@ -0,0 +1,292 @@
+# frozen_string_literal: true
+
+# Copyright 2026 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 BackupDR
+      module V1
+        # A `RestoreTemplate` encapsulates DR readiness configurations for validating
+        # backups.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Identifier. The resource name of the RestoreTemplate.
+        # @!attribute [rw] description
+        #   @return [::String]
+        #     Optional. User-provided description of the restore template.
+        # @!attribute [r] create_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. The time when the restore template was created.
+        # @!attribute [r] update_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. The time when the restore template was last updated.
+        # @!attribute [rw] resource_type
+        #   @return [::String]
+        #     Required. Immutable. The specific type of the workload being restored.
+        #     The format is "\\{service_name}/\\{resource_kind}", for example,
+        #     "compute.googleapis.com/Instance".
+        # @!attribute [rw] labels
+        #   @return [::Google::Protobuf::Map{::String => ::String}]
+        #     Optional. User-defined labels.
+        # @!attribute [rw] backup_selection_config
+        #   @return [::Google::Cloud::BackupDR::V1::BackupSelectionConfig]
+        #     Required. Backup selection configuration.
+        # @!attribute [rw] pre_restore_config
+        #   @return [::Google::Cloud::BackupDR::V1::PreRestoreConfig]
+        #     Optional. Pre-restore configuration.
+        # @!attribute [rw] post_restore_config
+        #   @return [::Google::Cloud::BackupDR::V1::PostRestoreConfig]
+        #     Optional. Post-restore configuration.
+        # @!attribute [rw] verification_config
+        #   @return [::Google::Cloud::BackupDR::V1::VerificationConfig]
+        #     Optional. Verification configuration.
+        # @!attribute [rw] restore_properties
+        #   @return [::Google::Protobuf::Struct]
+        #     Required. Defines target environments where the resource will be restored.
+        #
+        #     The target resource name in `restore_properties` supports the
+        #     `{EXECUTION_ID}` token to dynamically generate unique resource names for
+        #     each execution. During restore execution, every occurrence of
+        #     `{EXECUTION_ID}` in the target resource name is replaced with the
+        #     8-character `RestoreTemplateExecution` ID (for example,
+        #     `"restored-resource-{EXECUTION_ID}"` or
+        #     `"restored-{EXECUTION_ID}-resource"` resolves to
+        #     `"restored-resource-5d437b06"` or `"restored-5d437b06-resource"`).
+        # @!attribute [r] state
+        #   @return [::Google::Cloud::BackupDR::V1::RestoreTemplate::State]
+        #     Output only. The state of the restore template.
+        # @!attribute [r] execution_summary
+        #   @return [::Google::Cloud::BackupDR::V1::ExecutionSummary]
+        #     Output only. Summary of the last execution.
+        # @!attribute [rw] etag
+        #   @return [::String]
+        #     Optional. Etag for concurrency control.
+        class RestoreTemplate
+          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
+
+          # The state of the RestoreTemplate.
+          module State
+            # State not specified.
+            STATE_UNSPECIFIED = 0
+
+            # The template is being created.
+            CREATING = 1
+
+            # The template is active and ready to use.
+            ACTIVE = 2
+
+            # The template is being updated.
+            UPDATING = 3
+
+            # The template is being deleted.
+            DELETING = 4
+          end
+        end
+
+        # Summary of the last execution.
+        # @!attribute [r] last_execution
+        #   @return [::String]
+        #     Output only. The resource name of the last execution.
+        #     Format:
+        #     `projects/{project}/locations/{location}/restoreTemplates/{restore_template}/executions/{execution}`
+        # @!attribute [r] last_execution_state
+        #   @return [::Google::Cloud::BackupDR::V1::RestoreTemplateExecution::ExecutionState]
+        #     Output only. The state of the last execution.
+        class ExecutionSummary
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for creating a RestoreTemplate instance.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The restore template project and location in the format
+        #     'projects/\\{project_id}/locations/\\{location}'.
+        # @!attribute [rw] restore_template_id
+        #   @return [::String]
+        #     Required. The ID of the restore template to create. The ID must be
+        #     unique for the specified project and location.
+        # @!attribute [rw] restore_template
+        #   @return [::Google::Cloud::BackupDR::V1::RestoreTemplate]
+        #     Required. A RestoreTemplate resource.
+        # @!attribute [rw] request_id
+        #   @return [::String]
+        #     Optional. An optional request ID to identify requests. Specify a unique
+        #     request ID so that if you must retry your request, the server will know to
+        #     ignore the request if it has already been completed.
+        #
+        #     The request ID must be a valid UUID with the exception that zero UUID is
+        #     not supported (00000000-0000-0000-0000-000000000000).
+        class CreateRestoreTemplateRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for getting a RestoreTemplate instance.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The name of the restore template to retrieve.
+        #     Format:
+        #     'projects/\\{project_id}/locations/\\{location}/restoreTemplates/\\{restore_template_id}'
+        class GetRestoreTemplateRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for updating a RestoreTemplate instance.
+        # @!attribute [rw] update_mask
+        #   @return [::Google::Protobuf::FieldMask]
+        #     Optional. The list of fields to update.
+        #     Field mask is used to specify the fields to be overwritten in the
+        #     RestoreTemplate resource by the update.
+        #     The fields specified in the update_mask are relative to the resource, not
+        #     the full request. A field will be overwritten if it is in the mask.
+        # @!attribute [rw] restore_template
+        #   @return [::Google::Cloud::BackupDR::V1::RestoreTemplate]
+        #     Required. The restore template to update.
+        # @!attribute [rw] request_id
+        #   @return [::String]
+        #     Optional. An optional request ID to identify requests. Specify a unique
+        #     request ID so that if you must retry your request, the server will know to
+        #     ignore the request if it has already been completed.
+        #
+        #     The request ID must be a valid UUID with the exception that zero UUID is
+        #     not supported (00000000-0000-0000-0000-000000000000).
+        # @!attribute [rw] validate_only
+        #   @return [::Boolean]
+        #     Optional. Only validate the request, but do not perform mutations.
+        #     The default is 'false'.
+        class UpdateRestoreTemplateRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for deleting a RestoreTemplate instance.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The name of the restore template to delete.
+        #     Format:
+        #     'projects/\\{project_id}/locations/\\{location}/restoreTemplates/\\{restore_template_id}'
+        # @!attribute [rw] request_id
+        #   @return [::String]
+        #     Optional. An optional request ID to identify requests. Specify a unique
+        #     request ID so that if you must retry your request, the server will know to
+        #     ignore the request if it has already been completed.
+        #
+        #     The request ID must be a valid UUID with the exception that zero UUID is
+        #     not supported (00000000-0000-0000-0000-000000000000).
+        # @!attribute [rw] force
+        #   @return [::Boolean]
+        #     Optional. If set to true, any child RestoreTemplateExecutions will also be
+        #     deleted. If false and the RestoreTemplate has any child executions, the
+        #     request will fail.
+        class DeleteRestoreTemplateRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for running a RestoreTemplate.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The name of the restore template to run.
+        #     Format:
+        #     'projects/\\{project_id}/locations/\\{location}/restoreTemplates/\\{restore_template_id}'
+        # @!attribute [rw] backup
+        #   @return [::String]
+        #     Optional. The resource name of the Backup to restore from.
+        #     If not specified, the latest backup matching the backup selection
+        #     configuration in the RestoreTemplate will be used.
+        #     Format:
+        #     'projects/\\{project}/locations/\\{location}/backupVaults/\\{backup_vault}/dataSources/\\{data_source}/backups/\\{backup}'
+        # @!attribute [rw] request_id
+        #   @return [::String]
+        #     Optional. An optional request ID to identify requests. Specify a unique
+        #     request ID so that if you must retry your request, the server will know to
+        #     ignore the request if it has already been completed.
+        #
+        #     The request ID must be a valid UUID with the exception that zero UUID is
+        #     not supported (00000000-0000-0000-0000-000000000000).
+        class RunRestoreTemplateRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Response message for RunRestoreTemplate.
+        # @!attribute [r] restore_template_execution
+        #   @return [::String]
+        #     Output only. The resource name of the initiated RestoreTemplateExecution.
+        #     Format:
+        #     `projects/{project}/locations/{location}/restoreTemplates/{restore_template}/executions/{execution}`
+        class RunRestoreTemplateResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for listing RestoreTemplates.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The project and location from which to list the restore
+        #     templates.
+        #     Format: `projects/{project}/locations/{location}`.
+        # @!attribute [rw] page_size
+        #   @return [::Integer]
+        #     Optional. The maximum number of items to return.
+        # @!attribute [rw] page_token
+        #   @return [::String]
+        #     Optional. A page token, received from a previous `ListRestoreTemplates`
+        #     call.
+        # @!attribute [rw] filter
+        #   @return [::String]
+        #     Optional. Field match expression used to filter the results.
+        # @!attribute [rw] order_by
+        #   @return [::String]
+        #     Optional. Field by which to sort the results.
+        class ListRestoreTemplatesRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Response message for listing RestoreTemplates.
+        # @!attribute [rw] restore_templates
+        #   @return [::Array<::Google::Cloud::BackupDR::V1::RestoreTemplate>]
+        #     The list of RestoreTemplates.
+        # @!attribute [rw] next_page_token
+        #   @return [::String]
+        #     A token which may be sent as `page_token` in a subsequent
+        #     `ListRestoreTemplates` call.
+        # @!attribute [rw] unreachable
+        #   @return [::Array<::String>]
+        #     Locations that could not be reached.
+        class ListRestoreTemplatesResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/cloud/backupdr/v1/restore_template_common.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+# Copyright 2026 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 BackupDR
+      module V1
+        # Configuration for selecting a backup.
+        # @!attribute [rw] data_source
+        #   @return [::String]
+        #     Required. Immutable. The fully qualified URI of the backupdr data source.
+        class BackupSelectionConfig
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Configuration for Pre-Restore.
+        # @!attribute [rw] timeout
+        #   @return [::Google::Protobuf::Duration]
+        #     Optional. The `timeout` for this phase.
+        #     If set, the `timeout` must be positive and less than or equal to 24 hours
+        #     (86400s).
+        # @!attribute [rw] cloud_run_job
+        #   @return [::String]
+        #     Cloud Run job action to execute.
+        #     Format: `projects/{project}/locations/{location}/jobs/{job}`
+        class PreRestoreConfig
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Configuration for Post-Restore.
+        # @!attribute [rw] timeout
+        #   @return [::Google::Protobuf::Duration]
+        #     Optional. The `timeout` for this phase.
+        #     If set, the `timeout` must be positive and less than or equal to 24 hours
+        #     (86400s).
+        # @!attribute [rw] cloud_run_job
+        #   @return [::String]
+        #     Cloud Run job action to execute.
+        #     Format: `projects/{project}/locations/{location}/jobs/{job}`
+        class PostRestoreConfig
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Configuration for Verification.
+        # @!attribute [rw] timeout
+        #   @return [::Google::Protobuf::Duration]
+        #     Optional. The `timeout` for this phase.
+        #     If set, the `timeout` must be positive and less than or equal to 24 hours
+        #     (86400s).
+        # @!attribute [rw] cloud_run_job
+        #   @return [::String]
+        #     Cloud Run job action to execute.
+        #     Format: `projects/{project}/locations/{location}/jobs/{job}`
+        class VerificationConfig
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end