google-cloud-gke_backup-v1 0.1.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 +7 -0
  2. data/.yardopts +12 -0
  3. data/AUTHENTICATION.md +149 -0
  4. data/LICENSE.md +201 -0
  5. data/README.md +144 -0
  6. data/lib/google/cloud/gke_backup/v1/backup_for_gke/client.rb +2980 -0
  7. data/lib/google/cloud/gke_backup/v1/backup_for_gke/credentials.rb +47 -0
  8. data/lib/google/cloud/gke_backup/v1/backup_for_gke/operations.rb +767 -0
  9. data/lib/google/cloud/gke_backup/v1/backup_for_gke/paths.rb +216 -0
  10. data/lib/google/cloud/gke_backup/v1/backup_for_gke.rb +51 -0
  11. data/lib/google/cloud/gke_backup/v1/version.rb +28 -0
  12. data/lib/google/cloud/gke_backup/v1.rb +40 -0
  13. data/lib/google/cloud/gkebackup/v1/backup_pb.rb +74 -0
  14. data/lib/google/cloud/gkebackup/v1/backup_plan_pb.rb +61 -0
  15. data/lib/google/cloud/gkebackup/v1/common_pb.rb +37 -0
  16. data/lib/google/cloud/gkebackup/v1/gkebackup_pb.rb +213 -0
  17. data/lib/google/cloud/gkebackup/v1/gkebackup_services_pb.rb +92 -0
  18. data/lib/google/cloud/gkebackup/v1/restore_pb.rb +101 -0
  19. data/lib/google/cloud/gkebackup/v1/restore_plan_pb.rb +36 -0
  20. data/lib/google/cloud/gkebackup/v1/volume_pb.rb +83 -0
  21. data/lib/google-cloud-gke_backup-v1.rb +21 -0
  22. data/proto_docs/README.md +4 -0
  23. data/proto_docs/google/api/field_behavior.rb +71 -0
  24. data/proto_docs/google/api/resource.rb +222 -0
  25. data/proto_docs/google/cloud/gkebackup/v1/backup.rb +226 -0
  26. data/proto_docs/google/cloud/gkebackup/v1/backup_plan.rb +196 -0
  27. data/proto_docs/google/cloud/gkebackup/v1/common.rb +67 -0
  28. data/proto_docs/google/cloud/gkebackup/v1/gkebackup.rb +658 -0
  29. data/proto_docs/google/cloud/gkebackup/v1/restore.rb +325 -0
  30. data/proto_docs/google/cloud/gkebackup/v1/restore_plan.rb +92 -0
  31. data/proto_docs/google/cloud/gkebackup/v1/volume.rb +214 -0
  32. data/proto_docs/google/longrunning/operations.rb +164 -0
  33. data/proto_docs/google/protobuf/any.rb +141 -0
  34. data/proto_docs/google/protobuf/duration.rb +98 -0
  35. data/proto_docs/google/protobuf/empty.rb +36 -0
  36. data/proto_docs/google/protobuf/field_mask.rb +229 -0
  37. data/proto_docs/google/protobuf/timestamp.rb +129 -0
  38. data/proto_docs/google/rpc/status.rb +46 -0
  39. metadata +229 -0
@@ -0,0 +1,658 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2022 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 GkeBackup
23
+ module V1
24
+ # Represents the metadata of the long-running operation.
25
+ # @!attribute [r] create_time
26
+ # @return [::Google::Protobuf::Timestamp]
27
+ # Output only. The time the operation was created.
28
+ # @!attribute [r] end_time
29
+ # @return [::Google::Protobuf::Timestamp]
30
+ # Output only. The time the operation finished running.
31
+ # @!attribute [r] target
32
+ # @return [::String]
33
+ # Output only. Server-defined resource path for the target of the operation.
34
+ # @!attribute [r] verb
35
+ # @return [::String]
36
+ # Output only. Name of the verb executed by the operation.
37
+ # @!attribute [r] status_message
38
+ # @return [::String]
39
+ # Output only. Human-readable status of the operation, if any.
40
+ # @!attribute [r] requested_cancellation
41
+ # @return [::Boolean]
42
+ # Output only. Identifies whether the user has requested cancellation
43
+ # of the operation. Operations that have successfully been cancelled
44
+ # have [Operation.error][] value with a {::Google::Rpc::Status#code google.rpc.Status.code} of 1,
45
+ # corresponding to `Code.CANCELLED`.
46
+ # @!attribute [r] api_version
47
+ # @return [::String]
48
+ # Output only. API version used to start the operation.
49
+ class OperationMetadata
50
+ include ::Google::Protobuf::MessageExts
51
+ extend ::Google::Protobuf::MessageExts::ClassMethods
52
+ end
53
+
54
+ # Request message for CreateBackupPlan.
55
+ # @!attribute [rw] parent
56
+ # @return [::String]
57
+ # Required. The location within which to create the BackupPlan.
58
+ # Format: projects/*/locations/*
59
+ # @!attribute [rw] backup_plan
60
+ # @return [::Google::Cloud::GkeBackup::V1::BackupPlan]
61
+ # Required. The BackupPlan resource object to create.
62
+ # @!attribute [rw] backup_plan_id
63
+ # @return [::String]
64
+ # Required. The client-provided short name for the BackupPlan resource.
65
+ # This name must:
66
+ #
67
+ # - be between 1 and 63 characters long (inclusive)
68
+ # - consist of only lower-case ASCII letters, numbers, and dashes
69
+ # - start with a lower-case letter
70
+ # - end with a lower-case letter or number
71
+ # - be unique within the set of BackupPlans in this location
72
+ class CreateBackupPlanRequest
73
+ include ::Google::Protobuf::MessageExts
74
+ extend ::Google::Protobuf::MessageExts::ClassMethods
75
+ end
76
+
77
+ # Request message for ListBackupPlans.
78
+ # @!attribute [rw] parent
79
+ # @return [::String]
80
+ # Required. The location that contains the BackupPlans to list.
81
+ # Format: projects/*/locations/*
82
+ # @!attribute [rw] page_size
83
+ # @return [::Integer]
84
+ # The target number of results to return in a single response.
85
+ # If not specified, a default value will be chosen by the service.
86
+ # Note that the response may inclue a partial list and a caller should
87
+ # only rely on the response's
88
+ # {::Google::Cloud::GkeBackup::V1::ListBackupPlansResponse#next_page_token next_page_token}
89
+ # to determine if there are more instances left to be queried.
90
+ # @!attribute [rw] page_token
91
+ # @return [::String]
92
+ # The value of
93
+ # {::Google::Cloud::GkeBackup::V1::ListBackupPlansResponse#next_page_token next_page_token}
94
+ # received from a previous `ListBackupPlans` call.
95
+ # Provide this to retrieve the subsequent page in a multi-page list of
96
+ # results. When paginating, all other parameters provided to
97
+ # `ListBackupPlans` must match the call that provided the page token.
98
+ # @!attribute [rw] filter
99
+ # @return [::String]
100
+ # Field match expression used to filter the results.
101
+ # @!attribute [rw] order_by
102
+ # @return [::String]
103
+ # Field by which to sort the results.
104
+ class ListBackupPlansRequest
105
+ include ::Google::Protobuf::MessageExts
106
+ extend ::Google::Protobuf::MessageExts::ClassMethods
107
+ end
108
+
109
+ # Response message for ListBackupPlans.
110
+ # @!attribute [rw] backup_plans
111
+ # @return [::Array<::Google::Cloud::GkeBackup::V1::BackupPlan>]
112
+ # The list of BackupPlans matching the given criteria.
113
+ # @!attribute [rw] next_page_token
114
+ # @return [::String]
115
+ # A token which may be sent as
116
+ # {::Google::Cloud::GkeBackup::V1::ListBackupPlansRequest#page_token page_token} in a subsequent
117
+ # `ListBackupPlans` call to retrieve the next page of results.
118
+ # If this field is omitted or empty, then there are no more results to
119
+ # return.
120
+ # @!attribute [rw] unreachable
121
+ # @return [::Array<::String>]
122
+ # Locations that could not be reached.
123
+ class ListBackupPlansResponse
124
+ include ::Google::Protobuf::MessageExts
125
+ extend ::Google::Protobuf::MessageExts::ClassMethods
126
+ end
127
+
128
+ # Request message for GetBackupPlan.
129
+ # @!attribute [rw] name
130
+ # @return [::String]
131
+ # Required. Fully qualified BackupPlan name.
132
+ # Format: projects/*/locations/*/backupPlans/*
133
+ class GetBackupPlanRequest
134
+ include ::Google::Protobuf::MessageExts
135
+ extend ::Google::Protobuf::MessageExts::ClassMethods
136
+ end
137
+
138
+ # Request message for UpdateBackupPlan.
139
+ # @!attribute [rw] backup_plan
140
+ # @return [::Google::Cloud::GkeBackup::V1::BackupPlan]
141
+ # Required. A new version of the BackupPlan resource that contains updated fields.
142
+ # This may be sparsely populated if an `update_mask` is provided.
143
+ # @!attribute [rw] update_mask
144
+ # @return [::Google::Protobuf::FieldMask]
145
+ # This is used to specify the fields to be overwritten in the
146
+ # BackupPlan targeted for update. The values for each of these
147
+ # updated fields will be taken from the `backup_plan` provided
148
+ # with this request. Field names are relative to the root of the resource
149
+ # (e.g., `description`, `backup_config.include_volume_data`, etc.)
150
+ # If no `update_mask` is provided, all fields in `backup_plan` will be
151
+ # written to the target BackupPlan resource.
152
+ # Note that OUTPUT_ONLY and IMMUTABLE fields in `backup_plan` are ignored
153
+ # and are not used to update the target BackupPlan.
154
+ class UpdateBackupPlanRequest
155
+ include ::Google::Protobuf::MessageExts
156
+ extend ::Google::Protobuf::MessageExts::ClassMethods
157
+ end
158
+
159
+ # Request message for DeleteBackupPlan.
160
+ # @!attribute [rw] name
161
+ # @return [::String]
162
+ # Required. Fully qualified BackupPlan name.
163
+ # Format: projects/*/locations/*/backupPlans/*
164
+ # @!attribute [rw] etag
165
+ # @return [::String]
166
+ # If provided, this value must match the current value of the
167
+ # target BackupPlan's {::Google::Cloud::GkeBackup::V1::BackupPlan#etag etag} field or the request is
168
+ # rejected.
169
+ class DeleteBackupPlanRequest
170
+ include ::Google::Protobuf::MessageExts
171
+ extend ::Google::Protobuf::MessageExts::ClassMethods
172
+ end
173
+
174
+ # Request message for CreateBackup.
175
+ # @!attribute [rw] parent
176
+ # @return [::String]
177
+ # Required. The BackupPlan within which to create the Backup.
178
+ # Format: projects/*/locations/*/backupPlans/*
179
+ # @!attribute [rw] backup
180
+ # @return [::Google::Cloud::GkeBackup::V1::Backup]
181
+ # The Backup resource to create.
182
+ # @!attribute [rw] backup_id
183
+ # @return [::String]
184
+ # The client-provided short name for the Backup resource.
185
+ # This name must:
186
+ #
187
+ # - be between 1 and 63 characters long (inclusive)
188
+ # - consist of only lower-case ASCII letters, numbers, and dashes
189
+ # - start with a lower-case letter
190
+ # - end with a lower-case letter or number
191
+ # - be unique within the set of Backups in this BackupPlan
192
+ class CreateBackupRequest
193
+ include ::Google::Protobuf::MessageExts
194
+ extend ::Google::Protobuf::MessageExts::ClassMethods
195
+ end
196
+
197
+ # Request message for ListBackups.
198
+ # @!attribute [rw] parent
199
+ # @return [::String]
200
+ # Required. The BackupPlan that contains the Backups to list.
201
+ # Format: projects/*/locations/*/backupPlans/*
202
+ # @!attribute [rw] page_size
203
+ # @return [::Integer]
204
+ # The target number of results to return in a single response.
205
+ # If not specified, a default value will be chosen by the service.
206
+ # Note that the response may inclue a partial list and a caller should
207
+ # only rely on the response's
208
+ # {::Google::Cloud::GkeBackup::V1::ListBackupsResponse#next_page_token next_page_token}
209
+ # to determine if there are more instances left to be queried.
210
+ # @!attribute [rw] page_token
211
+ # @return [::String]
212
+ # The value of
213
+ # {::Google::Cloud::GkeBackup::V1::ListBackupsResponse#next_page_token next_page_token}
214
+ # received from a previous `ListBackups` call.
215
+ # Provide this to retrieve the subsequent page in a multi-page list of
216
+ # results. When paginating, all other parameters provided to
217
+ # `ListBackups` must match the call that provided the page token.
218
+ # @!attribute [rw] filter
219
+ # @return [::String]
220
+ # Field match expression used to filter the results.
221
+ # @!attribute [rw] order_by
222
+ # @return [::String]
223
+ # Field by which to sort the results.
224
+ class ListBackupsRequest
225
+ include ::Google::Protobuf::MessageExts
226
+ extend ::Google::Protobuf::MessageExts::ClassMethods
227
+ end
228
+
229
+ # Response message for ListBackups.
230
+ # @!attribute [rw] backups
231
+ # @return [::Array<::Google::Cloud::GkeBackup::V1::Backup>]
232
+ # The list of Backups matching the given criteria.
233
+ # @!attribute [rw] next_page_token
234
+ # @return [::String]
235
+ # A token which may be sent as {::Google::Cloud::GkeBackup::V1::ListBackupsRequest#page_token page_token} in
236
+ # a subsequent `ListBackups` call to retrieve the next page of results. If
237
+ # this field is omitted or empty, then there are no more results to return.
238
+ class ListBackupsResponse
239
+ include ::Google::Protobuf::MessageExts
240
+ extend ::Google::Protobuf::MessageExts::ClassMethods
241
+ end
242
+
243
+ # Request message for GetBackup.
244
+ # @!attribute [rw] name
245
+ # @return [::String]
246
+ # Required. Full name of the Backup resource.
247
+ # Format: projects/*/locations/*/backupPlans/*/backups/*
248
+ class GetBackupRequest
249
+ include ::Google::Protobuf::MessageExts
250
+ extend ::Google::Protobuf::MessageExts::ClassMethods
251
+ end
252
+
253
+ # Request message for UpdateBackup.
254
+ # @!attribute [rw] backup
255
+ # @return [::Google::Cloud::GkeBackup::V1::Backup]
256
+ # Required. A new version of the Backup resource that contains updated fields.
257
+ # This may be sparsely populated if an `update_mask` is provided.
258
+ # @!attribute [rw] update_mask
259
+ # @return [::Google::Protobuf::FieldMask]
260
+ # This is used to specify the fields to be overwritten in the
261
+ # Backup targeted for update. The values for each of these
262
+ # updated fields will be taken from the `backup_plan` provided
263
+ # with this request. Field names are relative to the root of the resource.
264
+ # If no `update_mask` is provided, all fields in `backup` will be
265
+ # written to the target Backup resource.
266
+ # Note that OUTPUT_ONLY and IMMUTABLE fields in `backup` are ignored
267
+ # and are not used to update the target Backup.
268
+ class UpdateBackupRequest
269
+ include ::Google::Protobuf::MessageExts
270
+ extend ::Google::Protobuf::MessageExts::ClassMethods
271
+ end
272
+
273
+ # Request message for DeleteBackup.
274
+ # @!attribute [rw] name
275
+ # @return [::String]
276
+ # Required. Name of the Backup resource.
277
+ # Format: projects/*/locations/*/backupPlans/*/backups/*
278
+ # @!attribute [rw] etag
279
+ # @return [::String]
280
+ # If provided, this value must match the current value of the
281
+ # target Backup's {::Google::Cloud::GkeBackup::V1::Backup#etag etag} field or the request is
282
+ # rejected.
283
+ # @!attribute [rw] force
284
+ # @return [::Boolean]
285
+ # If set to true, any VolumeBackups below this Backup will also be deleted.
286
+ # Otherwise, the request will only succeed if the Backup has no
287
+ # VolumeBackups.
288
+ class DeleteBackupRequest
289
+ include ::Google::Protobuf::MessageExts
290
+ extend ::Google::Protobuf::MessageExts::ClassMethods
291
+ end
292
+
293
+ # Request message for ListVolumeBackups.
294
+ # @!attribute [rw] parent
295
+ # @return [::String]
296
+ # Required. The Backup that contains the VolumeBackups to list.
297
+ # Format: projects/*/locations/*/backupPlans/*/backups/*
298
+ # @!attribute [rw] page_size
299
+ # @return [::Integer]
300
+ # The target number of results to return in a single response.
301
+ # If not specified, a default value will be chosen by the service.
302
+ # Note that the response may inclue a partial list and a caller should
303
+ # only rely on the response's
304
+ # {::Google::Cloud::GkeBackup::V1::ListVolumeBackupsResponse#next_page_token next_page_token}
305
+ # to determine if there are more instances left to be queried.
306
+ # @!attribute [rw] page_token
307
+ # @return [::String]
308
+ # The value of
309
+ # {::Google::Cloud::GkeBackup::V1::ListVolumeBackupsResponse#next_page_token next_page_token}
310
+ # received from a previous `ListVolumeBackups` call.
311
+ # Provide this to retrieve the subsequent page in a multi-page list of
312
+ # results. When paginating, all other parameters provided to
313
+ # `ListVolumeBackups` must match the call that provided the page token.
314
+ # @!attribute [rw] filter
315
+ # @return [::String]
316
+ # Field match expression used to filter the results.
317
+ # @!attribute [rw] order_by
318
+ # @return [::String]
319
+ # Field by which to sort the results.
320
+ class ListVolumeBackupsRequest
321
+ include ::Google::Protobuf::MessageExts
322
+ extend ::Google::Protobuf::MessageExts::ClassMethods
323
+ end
324
+
325
+ # Response message for ListVolumeBackups.
326
+ # @!attribute [rw] volume_backups
327
+ # @return [::Array<::Google::Cloud::GkeBackup::V1::VolumeBackup>]
328
+ # The list of VolumeBackups matching the given criteria.
329
+ # @!attribute [rw] next_page_token
330
+ # @return [::String]
331
+ # A token which may be sent as
332
+ # {::Google::Cloud::GkeBackup::V1::ListVolumeBackupsRequest#page_token page_token} in a subsequent
333
+ # `ListVolumeBackups` call to retrieve the next page of results.
334
+ # If this field is omitted or empty, then there are no more results to
335
+ # return.
336
+ class ListVolumeBackupsResponse
337
+ include ::Google::Protobuf::MessageExts
338
+ extend ::Google::Protobuf::MessageExts::ClassMethods
339
+ end
340
+
341
+ # Request message for GetVolumeBackup.
342
+ # @!attribute [rw] name
343
+ # @return [::String]
344
+ # Required. Full name of the VolumeBackup resource.
345
+ # Format: projects/*/locations/*/backupPlans/*/backups/*/volumeBackups/*
346
+ class GetVolumeBackupRequest
347
+ include ::Google::Protobuf::MessageExts
348
+ extend ::Google::Protobuf::MessageExts::ClassMethods
349
+ end
350
+
351
+ # Request message for CreateRestorePlan.
352
+ # @!attribute [rw] parent
353
+ # @return [::String]
354
+ # Required. The location within which to create the RestorePlan.
355
+ # Format: projects/*/locations/*
356
+ # @!attribute [rw] restore_plan
357
+ # @return [::Google::Cloud::GkeBackup::V1::RestorePlan]
358
+ # Required. The RestorePlan resource object to create.
359
+ # @!attribute [rw] restore_plan_id
360
+ # @return [::String]
361
+ # Required. The client-provided short name for the RestorePlan resource.
362
+ # This name must:
363
+ #
364
+ # - be between 1 and 63 characters long (inclusive)
365
+ # - consist of only lower-case ASCII letters, numbers, and dashes
366
+ # - start with a lower-case letter
367
+ # - end with a lower-case letter or number
368
+ # - be unique within the set of RestorePlans in this location
369
+ class CreateRestorePlanRequest
370
+ include ::Google::Protobuf::MessageExts
371
+ extend ::Google::Protobuf::MessageExts::ClassMethods
372
+ end
373
+
374
+ # Request message for ListRestorePlans.
375
+ # @!attribute [rw] parent
376
+ # @return [::String]
377
+ # Required. The location that contains the RestorePlans to list.
378
+ # Format: projects/*/locations/*
379
+ # @!attribute [rw] page_size
380
+ # @return [::Integer]
381
+ # The target number of results to return in a single response.
382
+ # If not specified, a default value will be chosen by the service.
383
+ # Note that the response may inclue a partial list and a caller should
384
+ # only rely on the response's
385
+ # {::Google::Cloud::GkeBackup::V1::ListRestorePlansResponse#next_page_token next_page_token}
386
+ # to determine if there are more instances left to be queried.
387
+ # @!attribute [rw] page_token
388
+ # @return [::String]
389
+ # The value of
390
+ # {::Google::Cloud::GkeBackup::V1::ListRestorePlansResponse#next_page_token next_page_token}
391
+ # received from a previous `ListRestorePlans` call.
392
+ # Provide this to retrieve the subsequent page in a multi-page list of
393
+ # results. When paginating, all other parameters provided to
394
+ # `ListRestorePlans` must match the call that provided the page token.
395
+ # @!attribute [rw] filter
396
+ # @return [::String]
397
+ # Field match expression used to filter the results.
398
+ # @!attribute [rw] order_by
399
+ # @return [::String]
400
+ # Field by which to sort the results.
401
+ class ListRestorePlansRequest
402
+ include ::Google::Protobuf::MessageExts
403
+ extend ::Google::Protobuf::MessageExts::ClassMethods
404
+ end
405
+
406
+ # Response message for ListRestorePlans.
407
+ # @!attribute [rw] restore_plans
408
+ # @return [::Array<::Google::Cloud::GkeBackup::V1::RestorePlan>]
409
+ # The list of RestorePlans matching the given criteria.
410
+ # @!attribute [rw] next_page_token
411
+ # @return [::String]
412
+ # A token which may be sent as
413
+ # {::Google::Cloud::GkeBackup::V1::ListRestorePlansRequest#page_token page_token} in a subsequent
414
+ # `ListRestorePlans` call to retrieve the next page of results.
415
+ # If this field is omitted or empty, then there are no more results to
416
+ # return.
417
+ # @!attribute [rw] unreachable
418
+ # @return [::Array<::String>]
419
+ # Locations that could not be reached.
420
+ class ListRestorePlansResponse
421
+ include ::Google::Protobuf::MessageExts
422
+ extend ::Google::Protobuf::MessageExts::ClassMethods
423
+ end
424
+
425
+ # Request message for GetRestorePlan.
426
+ # @!attribute [rw] name
427
+ # @return [::String]
428
+ # Required. Fully qualified RestorePlan name.
429
+ # Format: projects/*/locations/*/restorePlans/*
430
+ class GetRestorePlanRequest
431
+ include ::Google::Protobuf::MessageExts
432
+ extend ::Google::Protobuf::MessageExts::ClassMethods
433
+ end
434
+
435
+ # Request message for UpdateRestorePlan.
436
+ # @!attribute [rw] restore_plan
437
+ # @return [::Google::Cloud::GkeBackup::V1::RestorePlan]
438
+ # Required. A new version of the RestorePlan resource that contains updated fields.
439
+ # This may be sparsely populated if an `update_mask` is provided.
440
+ # @!attribute [rw] update_mask
441
+ # @return [::Google::Protobuf::FieldMask]
442
+ # This is used to specify the fields to be overwritten in the
443
+ # RestorePlan targeted for update. The values for each of these
444
+ # updated fields will be taken from the `restore_plan` provided
445
+ # with this request. Field names are relative to the root of the resource.
446
+ # If no `update_mask` is provided, all fields in `restore_plan` will be
447
+ # written to the target RestorePlan resource.
448
+ # Note that OUTPUT_ONLY and IMMUTABLE fields in `restore_plan` are ignored
449
+ # and are not used to update the target RestorePlan.
450
+ class UpdateRestorePlanRequest
451
+ include ::Google::Protobuf::MessageExts
452
+ extend ::Google::Protobuf::MessageExts::ClassMethods
453
+ end
454
+
455
+ # Request message for DeleteRestorePlan.
456
+ # @!attribute [rw] name
457
+ # @return [::String]
458
+ # Required. Fully qualified RestorePlan name.
459
+ # Format: projects/*/locations/*/restorePlans/*
460
+ # @!attribute [rw] etag
461
+ # @return [::String]
462
+ # If provided, this value must match the current value of the
463
+ # target RestorePlan's {::Google::Cloud::GkeBackup::V1::RestorePlan#etag etag} field or the request is
464
+ # rejected.
465
+ # @!attribute [rw] force
466
+ # @return [::Boolean]
467
+ # If set to true, any Restores below this RestorePlan will also be deleted.
468
+ # Otherwise, the request will only succeed if the RestorePlan has no
469
+ # Restores.
470
+ class DeleteRestorePlanRequest
471
+ include ::Google::Protobuf::MessageExts
472
+ extend ::Google::Protobuf::MessageExts::ClassMethods
473
+ end
474
+
475
+ # Request message for CreateRestore.
476
+ # @!attribute [rw] parent
477
+ # @return [::String]
478
+ # Required. The RestorePlan within which to create the Restore.
479
+ # Format: projects/*/locations/*/restorePlans/*
480
+ # @!attribute [rw] restore
481
+ # @return [::Google::Cloud::GkeBackup::V1::Restore]
482
+ # Required. The restore resource to create.
483
+ # @!attribute [rw] restore_id
484
+ # @return [::String]
485
+ # Required. The client-provided short name for the Restore resource.
486
+ # This name must:
487
+ #
488
+ # - be between 1 and 63 characters long (inclusive)
489
+ # - consist of only lower-case ASCII letters, numbers, and dashes
490
+ # - start with a lower-case letter
491
+ # - end with a lower-case letter or number
492
+ # - be unique within the set of Restores in this RestorePlan.
493
+ class CreateRestoreRequest
494
+ include ::Google::Protobuf::MessageExts
495
+ extend ::Google::Protobuf::MessageExts::ClassMethods
496
+ end
497
+
498
+ # Request message for ListRestores.
499
+ # @!attribute [rw] parent
500
+ # @return [::String]
501
+ # Required. The RestorePlan that contains the Restores to list.
502
+ # Format: projects/*/locations/*/restorePlans/*
503
+ # @!attribute [rw] page_size
504
+ # @return [::Integer]
505
+ # The target number of results to return in a single response.
506
+ # If not specified, a default value will be chosen by the service.
507
+ # Note that the response may inclue a partial list and a caller should
508
+ # only rely on the response's
509
+ # {::Google::Cloud::GkeBackup::V1::ListRestoresResponse#next_page_token next_page_token}
510
+ # to determine if there are more instances left to be queried.
511
+ # @!attribute [rw] page_token
512
+ # @return [::String]
513
+ # The value of
514
+ # {::Google::Cloud::GkeBackup::V1::ListRestoresResponse#next_page_token next_page_token}
515
+ # received from a previous `ListRestores` call.
516
+ # Provide this to retrieve the subsequent page in a multi-page list of
517
+ # results. When paginating, all other parameters provided to `ListRestores`
518
+ # must match the call that provided the page token.
519
+ # @!attribute [rw] filter
520
+ # @return [::String]
521
+ # Field match expression used to filter the results.
522
+ # @!attribute [rw] order_by
523
+ # @return [::String]
524
+ # Field by which to sort the results.
525
+ class ListRestoresRequest
526
+ include ::Google::Protobuf::MessageExts
527
+ extend ::Google::Protobuf::MessageExts::ClassMethods
528
+ end
529
+
530
+ # Response message for ListRestores.
531
+ # @!attribute [rw] restores
532
+ # @return [::Array<::Google::Cloud::GkeBackup::V1::Restore>]
533
+ # The list of Restores matching the given criteria.
534
+ # @!attribute [rw] next_page_token
535
+ # @return [::String]
536
+ # A token which may be sent as {::Google::Cloud::GkeBackup::V1::ListRestoresRequest#page_token page_token}
537
+ # in a subsequent `ListRestores` call to retrieve the next page of results.
538
+ # If this field is omitted or empty, then there are no more results to
539
+ # return.
540
+ # @!attribute [rw] unreachable
541
+ # @return [::Array<::String>]
542
+ # Locations that could not be reached.
543
+ class ListRestoresResponse
544
+ include ::Google::Protobuf::MessageExts
545
+ extend ::Google::Protobuf::MessageExts::ClassMethods
546
+ end
547
+
548
+ # Request message for GetRestore.
549
+ # @!attribute [rw] name
550
+ # @return [::String]
551
+ # Required. Name of the restore resource.
552
+ # Format: projects/*/locations/*/restorePlans/*/restores/*
553
+ class GetRestoreRequest
554
+ include ::Google::Protobuf::MessageExts
555
+ extend ::Google::Protobuf::MessageExts::ClassMethods
556
+ end
557
+
558
+ # Request message for UpdateRestore.
559
+ # @!attribute [rw] restore
560
+ # @return [::Google::Cloud::GkeBackup::V1::Restore]
561
+ # Required. A new version of the Restore resource that contains updated fields.
562
+ # This may be sparsely populated if an `update_mask` is provided.
563
+ # @!attribute [rw] update_mask
564
+ # @return [::Google::Protobuf::FieldMask]
565
+ # This is used to specify the fields to be overwritten in the
566
+ # Restore targeted for update. The values for each of these
567
+ # updated fields will be taken from the `restore` provided
568
+ # with this request. Field names are relative to the root of the resource.
569
+ # If no `update_mask` is provided, all fields in `restore` will be
570
+ # written to the target Restore resource.
571
+ # Note that OUTPUT_ONLY and IMMUTABLE fields in `restore` are ignored
572
+ # and are not used to update the target Restore.
573
+ class UpdateRestoreRequest
574
+ include ::Google::Protobuf::MessageExts
575
+ extend ::Google::Protobuf::MessageExts::ClassMethods
576
+ end
577
+
578
+ # Request message for DeleteRestore.
579
+ # @!attribute [rw] name
580
+ # @return [::String]
581
+ # Required. Full name of the Restore
582
+ # Format: projects/*/locations/*/restorePlans/*/restores/*
583
+ # @!attribute [rw] etag
584
+ # @return [::String]
585
+ # If provided, this value must match the current value of the
586
+ # target Restore's {::Google::Cloud::GkeBackup::V1::Restore#etag etag} field or the request is
587
+ # rejected.
588
+ # @!attribute [rw] force
589
+ # @return [::Boolean]
590
+ # If set to true, any VolumeRestores below this restore will also be deleted.
591
+ # Otherwise, the request will only succeed if the restore has no
592
+ # VolumeRestores.
593
+ class DeleteRestoreRequest
594
+ include ::Google::Protobuf::MessageExts
595
+ extend ::Google::Protobuf::MessageExts::ClassMethods
596
+ end
597
+
598
+ # Request message for ListVolumeRestores.
599
+ # @!attribute [rw] parent
600
+ # @return [::String]
601
+ # Required. The Restore that contains the VolumeRestores to list.
602
+ # Format: projects/*/locations/*/restorePlans/*/restores/*
603
+ # @!attribute [rw] page_size
604
+ # @return [::Integer]
605
+ # The target number of results to return in a single response.
606
+ # If not specified, a default value will be chosen by the service.
607
+ # Note that the response may inclue a partial list and a caller should
608
+ # only rely on the response's
609
+ # {::Google::Cloud::GkeBackup::V1::ListVolumeRestoresResponse#next_page_token next_page_token}
610
+ # to determine if there are more instances left to be queried.
611
+ # @!attribute [rw] page_token
612
+ # @return [::String]
613
+ # The value of
614
+ # {::Google::Cloud::GkeBackup::V1::ListVolumeRestoresResponse#next_page_token next_page_token}
615
+ # received from a previous `ListVolumeRestores` call.
616
+ # Provide this to retrieve the subsequent page in a multi-page list of
617
+ # results. When paginating, all other parameters provided to
618
+ # `ListVolumeRestores` must match the call that provided the page token.
619
+ # @!attribute [rw] filter
620
+ # @return [::String]
621
+ # Field match expression used to filter the results.
622
+ # @!attribute [rw] order_by
623
+ # @return [::String]
624
+ # Field by which to sort the results.
625
+ class ListVolumeRestoresRequest
626
+ include ::Google::Protobuf::MessageExts
627
+ extend ::Google::Protobuf::MessageExts::ClassMethods
628
+ end
629
+
630
+ # Response message for ListVolumeRestores.
631
+ # @!attribute [rw] volume_restores
632
+ # @return [::Array<::Google::Cloud::GkeBackup::V1::VolumeRestore>]
633
+ # The list of VolumeRestores matching the given criteria.
634
+ # @!attribute [rw] next_page_token
635
+ # @return [::String]
636
+ # A token which may be sent as
637
+ # {::Google::Cloud::GkeBackup::V1::ListVolumeRestoresRequest#page_token page_token} in a subsequent
638
+ # `ListVolumeRestores` call to retrieve the next page of results.
639
+ # If this field is omitted or empty, then there are no more results to
640
+ # return.
641
+ class ListVolumeRestoresResponse
642
+ include ::Google::Protobuf::MessageExts
643
+ extend ::Google::Protobuf::MessageExts::ClassMethods
644
+ end
645
+
646
+ # Request message for GetVolumeRestore.
647
+ # @!attribute [rw] name
648
+ # @return [::String]
649
+ # Required. Full name of the VolumeRestore resource.
650
+ # Format: projects/*/locations/*/restorePlans/*/restores/*/volumeRestores/*
651
+ class GetVolumeRestoreRequest
652
+ include ::Google::Protobuf::MessageExts
653
+ extend ::Google::Protobuf::MessageExts::ClassMethods
654
+ end
655
+ end
656
+ end
657
+ end
658
+ end