google-cloud-backupdr-v1beta 0.1.0 → 0.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (39) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +4 -6
  3. data/lib/google/cloud/backupdr/v1beta/appliedautoprotectionpolicy_pb.rb +1 -1
  4. data/lib/google/cloud/backupdr/v1beta/autoprotectionpolicy_pb.rb +2 -1
  5. data/lib/google/cloud/backupdr/v1beta/autoprotectionpolicybinding_pb.rb +2 -1
  6. data/lib/google/cloud/backupdr/v1beta/backupdr/client.rb +2265 -114
  7. data/lib/google/cloud/backupdr/v1beta/backupdr/paths.rb +99 -0
  8. data/lib/google/cloud/backupdr/v1beta/backupdr/rest/client.rb +2137 -112
  9. data/lib/google/cloud/backupdr/v1beta/backupdr/rest/service_stub.rb +1491 -386
  10. data/lib/google/cloud/backupdr/v1beta/backupdr_pb.rb +5 -1
  11. data/lib/google/cloud/backupdr/v1beta/backupdr_services_pb.rb +45 -0
  12. data/lib/google/cloud/backupdr/v1beta/backupplan_pb.rb +1 -1
  13. data/lib/google/cloud/backupdr/v1beta/backupplanassociation_pb.rb +1 -1
  14. data/lib/google/cloud/backupdr/v1beta/backupvault_alloydb_pb.rb +1 -1
  15. data/lib/google/cloud/backupdr/v1beta/backupvault_ba_pb.rb +1 -1
  16. data/lib/google/cloud/backupdr/v1beta/backupvault_cloudsql_pb.rb +1 -1
  17. data/lib/google/cloud/backupdr/v1beta/backupvault_disk_pb.rb +1 -1
  18. data/lib/google/cloud/backupdr/v1beta/backupvault_gce_pb.rb +1 -1
  19. data/lib/google/cloud/backupdr/v1beta/backupvault_pb.rb +3 -1
  20. data/lib/google/cloud/backupdr/v1beta/bindingmatchingresource_pb.rb +1 -1
  21. data/lib/google/cloud/backupdr/v1beta/datasourcereference_pb.rb +1 -1
  22. data/lib/google/cloud/backupdr/v1beta/protection_summary_pb.rb +1 -1
  23. data/lib/google/cloud/backupdr/v1beta/restore_template_common_pb.rb +28 -0
  24. data/lib/google/cloud/backupdr/v1beta/restore_template_execution_pb.rb +45 -0
  25. data/lib/google/cloud/backupdr/v1beta/restore_template_pb.rb +40 -0
  26. data/lib/google/cloud/backupdr/v1beta/restore_verification_plan_association_pb.rb +36 -0
  27. data/lib/google/cloud/backupdr/v1beta/restore_verification_plan_pb.rb +34 -0
  28. data/lib/google/cloud/backupdr/v1beta/version.rb +1 -1
  29. data/proto_docs/google/cloud/backupdr/v1beta/autoprotectionpolicy.rb +38 -7
  30. data/proto_docs/google/cloud/backupdr/v1beta/autoprotectionpolicybinding.rb +32 -5
  31. data/proto_docs/google/cloud/backupdr/v1beta/backupvault.rb +31 -0
  32. data/proto_docs/google/cloud/backupdr/v1beta/bindingmatchingresource.rb +6 -6
  33. data/proto_docs/google/cloud/backupdr/v1beta/restore_template.rb +292 -0
  34. data/proto_docs/google/cloud/backupdr/v1beta/restore_template_common.rb +80 -0
  35. data/proto_docs/google/cloud/backupdr/v1beta/restore_template_execution.rb +399 -0
  36. data/proto_docs/google/cloud/backupdr/v1beta/restore_verification_plan.rb +270 -0
  37. data/proto_docs/google/cloud/backupdr/v1beta/restore_verification_plan_association.rb +264 -0
  38. data/proto_docs/google/protobuf/struct.rb +108 -0
  39. metadata +14 -3
@@ -0,0 +1,399 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2026 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+
20
+ module Google
21
+ module Cloud
22
+ module BackupDR
23
+ module V1beta
24
+ # A `RestoreTemplateExecution` represents a single historical or active
25
+ # execution run.
26
+ # @!attribute [rw] name
27
+ # @return [::String]
28
+ # Identifier. Resource name of the execution.
29
+ # @!attribute [r] resource_type
30
+ # @return [::String]
31
+ # Output only. The workload resource type being restored.
32
+ # The format is "\\{service_name}/\\{resource_kind}", for example,
33
+ # "compute.googleapis.com/Instance".
34
+ # @!attribute [r] create_time
35
+ # @return [::Google::Protobuf::Timestamp]
36
+ # Output only. Create time of the execution.
37
+ # @!attribute [r] update_time
38
+ # @return [::Google::Protobuf::Timestamp]
39
+ # Output only. Update time of the execution.
40
+ # @!attribute [r] type
41
+ # @return [::Google::Cloud::BackupDR::V1beta::RestoreTemplateExecution::ExecutionType]
42
+ # Output only. The type of the execution.
43
+ # @!attribute [r] phase
44
+ # @return [::Google::Cloud::BackupDR::V1beta::RestoreTemplateExecution::ExecutionPhase]
45
+ # Output only. The current active phase.
46
+ # @!attribute [r] state
47
+ # @return [::Google::Cloud::BackupDR::V1beta::RestoreTemplateExecution::ExecutionState]
48
+ # Output only. State of the execution.
49
+ # @!attribute [r] prepare_phase_info
50
+ # @return [::Google::Cloud::BackupDR::V1beta::PreparePhaseInfo]
51
+ # Output only. Info for the prepare phase.
52
+ # @!attribute [r] pre_restore_phase_info
53
+ # @return [::Google::Cloud::BackupDR::V1beta::PreRestorePhaseInfo]
54
+ # Output only. Info for the pre-restore phase.
55
+ # @!attribute [r] restore_phase_info
56
+ # @return [::Google::Cloud::BackupDR::V1beta::RestorePhaseInfo]
57
+ # Output only. Info for the restore phase.
58
+ # @!attribute [r] post_restore_phase_info
59
+ # @return [::Google::Cloud::BackupDR::V1beta::PostRestorePhaseInfo]
60
+ # Output only. Info for the post-restore phase.
61
+ # @!attribute [r] verification_phase_info
62
+ # @return [::Google::Cloud::BackupDR::V1beta::VerificationPhaseInfo]
63
+ # Output only. Info for the verification phase.
64
+ # @!attribute [r] cleanup_phase_info
65
+ # @return [::Google::Cloud::BackupDR::V1beta::CleanupPhaseInfo]
66
+ # Output only. Info for the cleanup phase.
67
+ class RestoreTemplateExecution
68
+ include ::Google::Protobuf::MessageExts
69
+ extend ::Google::Protobuf::MessageExts::ClassMethods
70
+
71
+ # The type of execution.
72
+ module ExecutionType
73
+ # Execution type not specified.
74
+ EXECUTION_TYPE_UNSPECIFIED = 0
75
+
76
+ # Scheduled execution.
77
+ SCHEDULED = 1
78
+
79
+ # On-demand execution.
80
+ ON_DEMAND = 2
81
+ end
82
+
83
+ # The phase of execution.
84
+ module ExecutionPhase
85
+ # Execution phase not specified.
86
+ EXECUTION_PHASE_UNSPECIFIED = 0
87
+
88
+ # Preparing for execution.
89
+ PREPARING = 1
90
+
91
+ # Executing pre-restore action.
92
+ EXECUTING_PRE_RESTORE_ACTION = 2
93
+
94
+ # Restoring the resource.
95
+ RESTORING = 3
96
+
97
+ # Executing post-restore action.
98
+ EXECUTING_POST_RESTORE_ACTION = 4
99
+
100
+ # Verifying the restored resource.
101
+ VERIFYING = 5
102
+
103
+ # Cleaning up resources.
104
+ CLEANING_UP = 6
105
+
106
+ # Execution completed.
107
+ COMPLETED = 7
108
+ end
109
+
110
+ # State of the execution.
111
+ module ExecutionState
112
+ # State not set.
113
+ EXECUTION_STATE_UNSPECIFIED = 0
114
+
115
+ # Execution is running.
116
+ RUNNING = 1
117
+
118
+ # Execution succeeded.
119
+ SUCCEEDED = 2
120
+
121
+ # Execution failed.
122
+ FAILED = 3
123
+
124
+ # Resources are being deleted (cleanup).
125
+ DELETING = 4
126
+ end
127
+ end
128
+
129
+ # Info for Prepare phase execution.
130
+ # @!attribute [r] phase_state
131
+ # @return [::Google::Cloud::BackupDR::V1beta::PhaseState]
132
+ # Output only. The state of this phase.
133
+ # @!attribute [r] error
134
+ # @return [::Google::Rpc::Status]
135
+ # Output only. Error details if the phase failed.
136
+ # @!attribute [r] start_time
137
+ # @return [::Google::Protobuf::Timestamp]
138
+ # Output only. Start time of the phase.
139
+ # @!attribute [r] end_time
140
+ # @return [::Google::Protobuf::Timestamp]
141
+ # Output only. End time of the phase.
142
+ # @!attribute [r] backup_selection_config
143
+ # @return [::Google::Cloud::BackupDR::V1beta::BackupSelectionConfig]
144
+ # Output only. Snapshot of config used in this execution.
145
+ # @!attribute [r] backup
146
+ # @return [::String]
147
+ # Output only. The source backup used for the restore.
148
+ # The fully qualified URI of the backupdr backup.
149
+ # @!attribute [r] is_backup_explicitly_passed
150
+ # @return [::Boolean]
151
+ # Output only. Indicates whether the backup was explicitly passed in the
152
+ # request.
153
+ # @!attribute [r] restore_verification_plan_association
154
+ # @return [::String]
155
+ # Output only. The restore verification plan association associated with the
156
+ # execution.
157
+ class PreparePhaseInfo
158
+ include ::Google::Protobuf::MessageExts
159
+ extend ::Google::Protobuf::MessageExts::ClassMethods
160
+ end
161
+
162
+ # Info for Pre-Restore phase execution.
163
+ # @!attribute [r] cloud_run_execution
164
+ # @return [::String]
165
+ # Output only. The fully qualified URI of the Cloud Run Execution triggered
166
+ # for pre-restore actions.
167
+ # @!attribute [r] phase_state
168
+ # @return [::Google::Cloud::BackupDR::V1beta::PhaseState]
169
+ # Output only. The state of this phase.
170
+ # @!attribute [r] error
171
+ # @return [::Google::Rpc::Status]
172
+ # Output only. Error details if the phase failed.
173
+ # @!attribute [r] start_time
174
+ # @return [::Google::Protobuf::Timestamp]
175
+ # Output only. Start time of the phase.
176
+ # @!attribute [r] end_time
177
+ # @return [::Google::Protobuf::Timestamp]
178
+ # Output only. End time of the phase.
179
+ # @!attribute [r] pre_restore_config
180
+ # @return [::Google::Cloud::BackupDR::V1beta::PreRestoreConfig]
181
+ # Output only. Snapshot of config that will be executed before restore
182
+ # operation.
183
+ class PreRestorePhaseInfo
184
+ include ::Google::Protobuf::MessageExts
185
+ extend ::Google::Protobuf::MessageExts::ClassMethods
186
+ end
187
+
188
+ # Info for Restore phase execution.
189
+ # @!attribute [r] phase_state
190
+ # @return [::Google::Cloud::BackupDR::V1beta::PhaseState]
191
+ # Output only. The state of this phase.
192
+ # @!attribute [r] error
193
+ # @return [::Google::Rpc::Status]
194
+ # Output only. Error details if the phase failed.
195
+ # @!attribute [r] start_time
196
+ # @return [::Google::Protobuf::Timestamp]
197
+ # Output only. Start time of the phase.
198
+ # @!attribute [r] end_time
199
+ # @return [::Google::Protobuf::Timestamp]
200
+ # Output only. End time of the phase.
201
+ # @!attribute [r] restore_properties
202
+ # @return [::Google::Protobuf::Struct]
203
+ # Output only. Snapshot of environment config used during restore of this
204
+ # RestoreTemplateExecution.
205
+ # @!attribute [r] restore_resource
206
+ # @return [::String]
207
+ # Output only. The resource created or restored by this execution.
208
+ # @!attribute [r] restore_duration
209
+ # @return [::Google::Protobuf::Duration]
210
+ # Output only. Time taken to restore the resource.
211
+ class RestorePhaseInfo
212
+ include ::Google::Protobuf::MessageExts
213
+ extend ::Google::Protobuf::MessageExts::ClassMethods
214
+ end
215
+
216
+ # Info for Post-Restore phase execution.
217
+ # @!attribute [r] cloud_run_execution
218
+ # @return [::String]
219
+ # Output only. The fully qualified URI of the Cloud Run Execution triggered
220
+ # for post-restore actions.
221
+ # @!attribute [r] phase_state
222
+ # @return [::Google::Cloud::BackupDR::V1beta::PhaseState]
223
+ # Output only. The state of this phase.
224
+ # @!attribute [r] error
225
+ # @return [::Google::Rpc::Status]
226
+ # Output only. Error details if the phase failed.
227
+ # @!attribute [r] start_time
228
+ # @return [::Google::Protobuf::Timestamp]
229
+ # Output only. Start time of the phase.
230
+ # @!attribute [r] end_time
231
+ # @return [::Google::Protobuf::Timestamp]
232
+ # Output only. End time of the phase.
233
+ # @!attribute [r] post_restore_config
234
+ # @return [::Google::Cloud::BackupDR::V1beta::PostRestoreConfig]
235
+ # Output only. Snapshot of config that will be executed after successful
236
+ # restore operation.
237
+ class PostRestorePhaseInfo
238
+ include ::Google::Protobuf::MessageExts
239
+ extend ::Google::Protobuf::MessageExts::ClassMethods
240
+ end
241
+
242
+ # Info for Verification phase execution.
243
+ # @!attribute [r] cloud_run_execution
244
+ # @return [::String]
245
+ # Output only. The fully qualified URI of the Cloud Run Execution triggered
246
+ # for verification.
247
+ # @!attribute [r] phase_state
248
+ # @return [::Google::Cloud::BackupDR::V1beta::PhaseState]
249
+ # Output only. The state of this phase.
250
+ # @!attribute [r] error
251
+ # @return [::Google::Rpc::Status]
252
+ # Output only. Error details if the phase failed.
253
+ # @!attribute [r] start_time
254
+ # @return [::Google::Protobuf::Timestamp]
255
+ # Output only. Start time of the phase.
256
+ # @!attribute [r] end_time
257
+ # @return [::Google::Protobuf::Timestamp]
258
+ # Output only. End time of the phase.
259
+ # @!attribute [r] verification_config
260
+ # @return [::Google::Cloud::BackupDR::V1beta::VerificationConfig]
261
+ # Output only. Snapshot of config that will be executed after successful post
262
+ # restore validation.
263
+ class VerificationPhaseInfo
264
+ include ::Google::Protobuf::MessageExts
265
+ extend ::Google::Protobuf::MessageExts::ClassMethods
266
+ end
267
+
268
+ # Info for Cleanup phase execution.
269
+ # @!attribute [r] phase_state
270
+ # @return [::Google::Cloud::BackupDR::V1beta::PhaseState]
271
+ # Output only. The state of this phase.
272
+ # @!attribute [r] error
273
+ # @return [::Google::Rpc::Status]
274
+ # Output only. Error details if the phase failed.
275
+ # @!attribute [r] start_time
276
+ # @return [::Google::Protobuf::Timestamp]
277
+ # Output only. Start time of the phase.
278
+ # @!attribute [r] end_time
279
+ # @return [::Google::Protobuf::Timestamp]
280
+ # Output only. End time of the phase.
281
+ # @!attribute [r] cleanup_duration
282
+ # @return [::Google::Protobuf::Duration]
283
+ # Output only. Time taken to perform the cleanup of restored resource.
284
+ # @!attribute [r] success_cleanup_rule
285
+ # @return [::Google::Cloud::BackupDR::V1beta::RestoreVerificationCleanupRule]
286
+ # Output only. Snapshot of cleanup rule provided for this execution when
287
+ # execution is successful.
288
+ # @!attribute [r] failure_cleanup_rule
289
+ # @return [::Google::Cloud::BackupDR::V1beta::RestoreVerificationCleanupRule]
290
+ # Output only. Snapshot of cleanup rule provided for this execution when
291
+ # execution is failed.
292
+ # @!attribute [r] cleanup_time
293
+ # @return [::Google::Protobuf::Timestamp]
294
+ # Output only. The time when the resources will be cleaned up.
295
+ class CleanupPhaseInfo
296
+ include ::Google::Protobuf::MessageExts
297
+ extend ::Google::Protobuf::MessageExts::ClassMethods
298
+ end
299
+
300
+ # Request message for getting a RestoreTemplateExecution instance.
301
+ # @!attribute [rw] name
302
+ # @return [::String]
303
+ # Required. The name of the restore template execution to retrieve.
304
+ # Format:
305
+ # 'projects/\\{project_id}/locations/\\{location}/restoreTemplates/\\{restore_template_id}/executions/\\{execution_id}'
306
+ class GetRestoreTemplateExecutionRequest
307
+ include ::Google::Protobuf::MessageExts
308
+ extend ::Google::Protobuf::MessageExts::ClassMethods
309
+ end
310
+
311
+ # Request message for triggering a restore cleanup.
312
+ # @!attribute [rw] name
313
+ # @return [::String]
314
+ # Required. Name of the restore template execution.
315
+ # Format:
316
+ # 'projects/\\{project_id}/locations/\\{location}/restoreTemplates/\\{restore_template_id}/executions/\\{execution_id}'
317
+ # @!attribute [rw] request_id
318
+ # @return [::String]
319
+ # Optional. An optional request ID to identify requests. Specify a unique
320
+ # request ID so that if you must retry your request, the server will know to
321
+ # ignore the request if it has already been completed. The server will
322
+ # guarantee that for at least 60 minutes after the first request.
323
+ #
324
+ # The request ID must be a valid UUID with the exception that zero UUID is
325
+ # not supported (00000000-0000-0000-0000-000000000000).
326
+ class TriggerRestoreCleanupRequest
327
+ include ::Google::Protobuf::MessageExts
328
+ extend ::Google::Protobuf::MessageExts::ClassMethods
329
+ end
330
+
331
+ # Request message for listing RestoreTemplateExecutions.
332
+ # @!attribute [rw] parent
333
+ # @return [::String]
334
+ # Required. The project, location, and restore template for which to retrieve
335
+ # executions information.
336
+ # Format:
337
+ # `projects/{project}/locations/{location}/restoreTemplates/{restore_template}`.
338
+ # @!attribute [rw] page_size
339
+ # @return [::Integer]
340
+ # Optional. Requested page size.
341
+ # @!attribute [rw] page_token
342
+ # @return [::String]
343
+ # Optional. A token identifying a page of results.
344
+ # @!attribute [rw] filter
345
+ # @return [::String]
346
+ # Optional. Filtering results.
347
+ # @!attribute [rw] order_by
348
+ # @return [::String]
349
+ # Optional. Hint for how to order the results.
350
+ class ListRestoreTemplateExecutionsRequest
351
+ include ::Google::Protobuf::MessageExts
352
+ extend ::Google::Protobuf::MessageExts::ClassMethods
353
+ end
354
+
355
+ # Response message for listing RestoreTemplateExecutions.
356
+ # @!attribute [rw] restore_template_executions
357
+ # @return [::Array<::Google::Cloud::BackupDR::V1beta::RestoreTemplateExecution>]
358
+ # The list of RestoreTemplateExecution instances.
359
+ # @!attribute [rw] next_page_token
360
+ # @return [::String]
361
+ # A token identifying a page of results.
362
+ # @!attribute [rw] unreachable
363
+ # @return [::Array<::String>]
364
+ # Locations that could not be reached.
365
+ class ListRestoreTemplateExecutionsResponse
366
+ include ::Google::Protobuf::MessageExts
367
+ extend ::Google::Protobuf::MessageExts::ClassMethods
368
+ end
369
+
370
+ # Represents the state of a specific phase (RUNNING, SUCCEEDED, FAILED, etc.).
371
+ module PhaseState
372
+ # Phase state is not set.
373
+ PHASE_STATE_UNSPECIFIED = 0
374
+
375
+ # This phase is pending execution.
376
+ PENDING = 1
377
+
378
+ # The phase is actively executing.
379
+ RUNNING = 2
380
+
381
+ # The phase completed successfully.
382
+ SUCCEEDED = 3
383
+
384
+ # The phase encountered an error and failed.
385
+ FAILED = 4
386
+
387
+ # The phase timed out.
388
+ TIMED_OUT = 5
389
+
390
+ # The phase was skipped.
391
+ SKIPPED = 6
392
+
393
+ # The phase is waiting to be executed.
394
+ WAITING = 7
395
+ end
396
+ end
397
+ end
398
+ end
399
+ end
@@ -0,0 +1,270 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2026 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+
20
+ module Google
21
+ module Cloud
22
+ module BackupDR
23
+ module V1beta
24
+ # A `RestoreVerificationPlan` specifies the scheduling and clean-up template
25
+ # for automated restore verification. It contains a `schedule` to dictate when
26
+ # the verifications should run, and a `RestoreVerificationCleanupRule` for
27
+ # post-verification resource deletion.
28
+ # @!attribute [r] name
29
+ # @return [::String]
30
+ # Output only. Identifier. The resource name of the
31
+ # `RestoreVerificationPlan`.
32
+ #
33
+ # Format:
34
+ # `projects/{project}/locations/{location}/restoreVerificationPlans/{restoreVerificationPlan}`
35
+ # @!attribute [rw] description
36
+ # @return [::String]
37
+ # Optional. The description of the `RestoreVerificationPlan` resource.
38
+ #
39
+ # The description allows for additional details about
40
+ # `RestoreVerificationPlan` and its use cases to be provided. An example
41
+ # description is the following: "This is a restore verification plan that
42
+ # performs a daily verification and cleans up the resources immediately
43
+ # after." The description must be at most 2048 characters.
44
+ # @!attribute [r] create_time
45
+ # @return [::Google::Protobuf::Timestamp]
46
+ # Output only. When the `RestoreVerificationPlan` was created.
47
+ # @!attribute [r] update_time
48
+ # @return [::Google::Protobuf::Timestamp]
49
+ # Output only. When the `RestoreVerificationPlan` was last updated.
50
+ # @!attribute [rw] labels
51
+ # @return [::Google::Protobuf::Map{::String => ::String}]
52
+ # Optional. User-defined labels.
53
+ # @!attribute [r] state
54
+ # @return [::Google::Cloud::BackupDR::V1beta::RestoreVerificationPlan::State]
55
+ # Output only. The `State` for the `RestoreVerificationPlan`.
56
+ # @!attribute [rw] schedule
57
+ # @return [::String]
58
+ # Required. Describes the schedule on which the restore verification will be
59
+ # executed.
60
+ #
61
+ # The schedule is specified as a
62
+ # [Crontab](https://en.wikipedia.org/wiki/Cron#Overview) string.
63
+ # @!attribute [rw] time_zone
64
+ # @return [::String]
65
+ # Optional. Specifies the time zone to be used in interpreting
66
+ # {::Google::Cloud::BackupDR::V1beta::RestoreVerificationPlan#schedule schedule}.
67
+ # The value of this field must be a time zone name from the [tz
68
+ # database](https://en.wikipedia.org/wiki/Tz_database), like
69
+ # "America/New_York" or "UTC". Defaults to `UTC` if not specified.
70
+ # @!attribute [rw] success_cleanup_rule
71
+ # @return [::Google::Cloud::BackupDR::V1beta::RestoreVerificationCleanupRule]
72
+ # Optional. The cleanup rule to apply if the restore verification succeeds.
73
+ # @!attribute [rw] failure_cleanup_rule
74
+ # @return [::Google::Cloud::BackupDR::V1beta::RestoreVerificationCleanupRule]
75
+ # Optional. The cleanup rule to apply if the restore verification fails.
76
+ class RestoreVerificationPlan
77
+ include ::Google::Protobuf::MessageExts
78
+ extend ::Google::Protobuf::MessageExts::ClassMethods
79
+
80
+ # @!attribute [rw] key
81
+ # @return [::String]
82
+ # @!attribute [rw] value
83
+ # @return [::String]
84
+ class LabelsEntry
85
+ include ::Google::Protobuf::MessageExts
86
+ extend ::Google::Protobuf::MessageExts::ClassMethods
87
+ end
88
+
89
+ # `State` enumerates the possible states for a `RestoreVerificationPlan`.
90
+ module State
91
+ # State not set.
92
+ STATE_UNSPECIFIED = 0
93
+
94
+ # The resource is being created.
95
+ CREATING = 1
96
+
97
+ # The resource has been created and is fully usable.
98
+ ACTIVE = 2
99
+
100
+ # The resource is being deleted.
101
+ DELETING = 3
102
+
103
+ # The resource has been created but is not usable.
104
+ INACTIVE = 4
105
+
106
+ # The resource is being updated.
107
+ UPDATING = 5
108
+
109
+ # The resource is in an error state due to a configuration issue.
110
+ ERROR = 6
111
+ end
112
+ end
113
+
114
+ # Defines the specific cleanup action.
115
+ # @!attribute [rw] cleanup_delay
116
+ # @return [::Google::Protobuf::Duration]
117
+ # Optional. Duration after restore finishes when cleanup triggers.
118
+ # Delay must be non-negative and at most 30 days (2592000 seconds).
119
+ # @!attribute [rw] skip_cleanup
120
+ # @return [::Boolean]
121
+ # Optional. If set to true, the restored resource will not be cleaned up.
122
+ class RestoreVerificationCleanupRule
123
+ include ::Google::Protobuf::MessageExts
124
+ extend ::Google::Protobuf::MessageExts::ClassMethods
125
+ end
126
+
127
+ # The request message for creating a `RestoreVerificationPlan`.
128
+ # @!attribute [rw] parent
129
+ # @return [::String]
130
+ # Required. The `RestoreVerificationPlan` project and location in the format
131
+ # `projects/{project}/locations/{location}`. In Google Cloud Backup and DR
132
+ # locations map to Google Cloud regions, for example **us-central1**.
133
+ # @!attribute [rw] restore_verification_plan_id
134
+ # @return [::String]
135
+ # Required. The name of the `RestoreVerificationPlan` to create. The name
136
+ # must be unique for the specified project and location. The name must start
137
+ # with a lowercase letter followed by up to 62 lowercase letters, numbers, or
138
+ # hyphens. Pattern, `^[a-z]([-a-z0-9]*[a-z0-9])?$`.
139
+ # @!attribute [rw] restore_verification_plan
140
+ # @return [::Google::Cloud::BackupDR::V1beta::RestoreVerificationPlan]
141
+ # Required. The `RestoreVerificationPlan` resource object to create.
142
+ # @!attribute [rw] request_id
143
+ # @return [::String]
144
+ # Optional. An optional request ID to identify requests. Specify a unique
145
+ # request ID so that if you must retry your request, the server will know to
146
+ # ignore the request if it has already been completed. The server will
147
+ # guarantee that for at least 60 minutes since the first request.
148
+ #
149
+ # For example, consider a situation where you make an initial request and
150
+ # the request times out. If you make the request again with the same request
151
+ # ID, the server can check if original operation with the same request ID
152
+ # was received, and if so, will ignore the second request. This prevents
153
+ # clients from accidentally creating duplicate commitments.
154
+ #
155
+ # The request ID must be a valid UUID with the exception that zero UUID is
156
+ # not supported (00000000-0000-0000-0000-000000000000).
157
+ class CreateRestoreVerificationPlanRequest
158
+ include ::Google::Protobuf::MessageExts
159
+ extend ::Google::Protobuf::MessageExts::ClassMethods
160
+ end
161
+
162
+ # The request message for getting a `RestoreVerificationPlan`.
163
+ # @!attribute [rw] name
164
+ # @return [::String]
165
+ # Required. The resource name of the `RestoreVerificationPlan` to retrieve.
166
+ #
167
+ # Format:
168
+ # `projects/{project}/locations/{location}/restoreVerificationPlans/{restoreVerificationPlan}`
169
+ class GetRestoreVerificationPlanRequest
170
+ include ::Google::Protobuf::MessageExts
171
+ extend ::Google::Protobuf::MessageExts::ClassMethods
172
+ end
173
+
174
+ # The request message for getting a list of `RestoreVerificationPlans`.
175
+ # @!attribute [rw] parent
176
+ # @return [::String]
177
+ # Required. The project and location for which to retrieve
178
+ # `RestoreVerificationPlans` information. Format:
179
+ # `projects/{project}/locations/{location}`. In Google Cloud Backup and DR,
180
+ # locations map to Google Cloud regions, for example **us-central1**. To
181
+ # retrieve restore verification plans for all locations, use
182
+ # "-" for the `{location}` value.
183
+ # @!attribute [rw] page_size
184
+ # @return [::Integer]
185
+ # Optional. The maximum number of `RestoreVerificationPlans` to return in a
186
+ # single response. If not specified, a default value will be chosen by the
187
+ # service. Note that the response may include a partial list and a caller
188
+ # should only rely on the response's
189
+ # {::Google::Cloud::BackupDR::V1beta::ListRestoreVerificationPlansResponse#next_page_token next_page_token}
190
+ # to determine if there are more instances left to be queried.
191
+ # @!attribute [rw] page_token
192
+ # @return [::String]
193
+ # Optional. The value of
194
+ # {::Google::Cloud::BackupDR::V1beta::ListRestoreVerificationPlansResponse#next_page_token next_page_token}
195
+ # received from a previous `ListRestoreVerificationPlans` call.
196
+ # Provide this to retrieve the subsequent page in a multi-page list of
197
+ # results. When paginating, all other parameters provided to
198
+ # `ListRestoreVerificationPlans` must match the call that provided the page
199
+ # token.
200
+ # @!attribute [rw] filter
201
+ # @return [::String]
202
+ # Optional. Field match expression used to filter the results.
203
+ # @!attribute [rw] order_by
204
+ # @return [::String]
205
+ # Optional. Field by which to sort the results.
206
+ class ListRestoreVerificationPlansRequest
207
+ include ::Google::Protobuf::MessageExts
208
+ extend ::Google::Protobuf::MessageExts::ClassMethods
209
+ end
210
+
211
+ # The response message for getting a list of `RestoreVerificationPlans`.
212
+ # @!attribute [rw] restore_verification_plans
213
+ # @return [::Array<::Google::Cloud::BackupDR::V1beta::RestoreVerificationPlan>]
214
+ # The list of `RestoreVerificationPlans` in the project for the specified
215
+ # location.
216
+ #
217
+ # If the `{location}` value in the request is "-", the response contains a
218
+ # list of resources from all locations. In case any location is unreachable,
219
+ # the response will only return restore verification plans in reachable
220
+ # locations and the 'unreachable' field will be populated with a list of
221
+ # unreachable locations.
222
+ # @!attribute [rw] next_page_token
223
+ # @return [::String]
224
+ # A token which may be sent as
225
+ # {::Google::Cloud::BackupDR::V1beta::ListRestoreVerificationPlansRequest#page_token page_token}
226
+ # in a subsequent `ListRestoreVerificationPlans` call to retrieve the next
227
+ # page of results. If this field is omitted or empty, then there are no more
228
+ # results to return.
229
+ # @!attribute [rw] unreachable
230
+ # @return [::Array<::String>]
231
+ # Locations that could not be reached.
232
+ class ListRestoreVerificationPlansResponse
233
+ include ::Google::Protobuf::MessageExts
234
+ extend ::Google::Protobuf::MessageExts::ClassMethods
235
+ end
236
+
237
+ # The request message for deleting a `RestoreVerificationPlan`.
238
+ # @!attribute [rw] name
239
+ # @return [::String]
240
+ # Required. The resource name of the `RestoreVerificationPlan` to delete.
241
+ #
242
+ # Format:
243
+ # `projects/{project}/locations/{location}/restoreVerificationPlans/{restoreVerificationPlan}`
244
+ # @!attribute [rw] request_id
245
+ # @return [::String]
246
+ # Optional. An optional request ID to identify requests. Specify a unique
247
+ # request ID so that if you must retry your request, the server will know to
248
+ # ignore the request if it has already been completed. The server will
249
+ # guarantee that for at least 60 minutes after the first request.
250
+ #
251
+ # For example, consider a situation where you make an initial request and
252
+ # the request times out. If you make the request again with the same request
253
+ # ID, the server can check if original operation with the same request ID
254
+ # was received, and if so, will ignore the second request. This prevents
255
+ # clients from accidentally creating duplicate commitments.
256
+ #
257
+ # The request ID must be a valid UUID with the exception that zero UUID is
258
+ # not supported (00000000-0000-0000-0000-000000000000).
259
+ # @!attribute [rw] force
260
+ # @return [::Boolean]
261
+ # Optional. If set to true, any RestoreVerificationPlanAssociations linked to
262
+ # this RestoreVerificationPlan will also be deleted.
263
+ class DeleteRestoreVerificationPlanRequest
264
+ include ::Google::Protobuf::MessageExts
265
+ extend ::Google::Protobuf::MessageExts::ClassMethods
266
+ end
267
+ end
268
+ end
269
+ end
270
+ end