google-cloud-gke_backup-v1 0.4.0 → 0.5.1

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.
@@ -41,8 +41,9 @@ module Google
41
41
  # @return [::Boolean]
42
42
  # Output only. Identifies whether the user has requested cancellation
43
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`.
44
+ # have [Operation.error][] value with a
45
+ # {::Google::Rpc::Status#code google.rpc.Status.code} of 1, corresponding to
46
+ # `Code.CANCELLED`.
46
47
  # @!attribute [r] api_version
47
48
  # @return [::String]
48
49
  # Output only. API version used to start the operation.
@@ -55,7 +56,7 @@ module Google
55
56
  # @!attribute [rw] parent
56
57
  # @return [::String]
57
58
  # Required. The location within which to create the BackupPlan.
58
- # Format: projects/*/locations/*
59
+ # Format: `projects/*/locations/*`
59
60
  # @!attribute [rw] backup_plan
60
61
  # @return [::Google::Cloud::GkeBackup::V1::BackupPlan]
61
62
  # Required. The BackupPlan resource object to create.
@@ -78,7 +79,7 @@ module Google
78
79
  # @!attribute [rw] parent
79
80
  # @return [::String]
80
81
  # Required. The location that contains the BackupPlans to list.
81
- # Format: projects/*/locations/*
82
+ # Format: `projects/*/locations/*`
82
83
  # @!attribute [rw] page_size
83
84
  # @return [::Integer]
84
85
  # The target number of results to return in a single response.
@@ -113,10 +114,10 @@ module Google
113
114
  # @!attribute [rw] next_page_token
114
115
  # @return [::String]
115
116
  # 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.
117
+ # {::Google::Cloud::GkeBackup::V1::ListBackupPlansRequest#page_token page_token}
118
+ # in a subsequent `ListBackupPlans` call to retrieve the next page of
119
+ # results. If this field is omitted or empty, then there are no more results
120
+ # to return.
120
121
  # @!attribute [rw] unreachable
121
122
  # @return [::Array<::String>]
122
123
  # Locations that could not be reached.
@@ -129,7 +130,7 @@ module Google
129
130
  # @!attribute [rw] name
130
131
  # @return [::String]
131
132
  # Required. Fully qualified BackupPlan name.
132
- # Format: projects/*/locations/*/backupPlans/*
133
+ # Format: `projects/*/locations/*/backupPlans/*`
133
134
  class GetBackupPlanRequest
134
135
  include ::Google::Protobuf::MessageExts
135
136
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -138,8 +139,8 @@ module Google
138
139
  # Request message for UpdateBackupPlan.
139
140
  # @!attribute [rw] backup_plan
140
141
  # @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.
142
+ # Required. A new version of the BackupPlan resource that contains updated
143
+ # fields. This may be sparsely populated if an `update_mask` is provided.
143
144
  # @!attribute [rw] update_mask
144
145
  # @return [::Google::Protobuf::FieldMask]
145
146
  # This is used to specify the fields to be overwritten in the
@@ -160,12 +161,12 @@ module Google
160
161
  # @!attribute [rw] name
161
162
  # @return [::String]
162
163
  # Required. Fully qualified BackupPlan name.
163
- # Format: projects/*/locations/*/backupPlans/*
164
+ # Format: `projects/*/locations/*/backupPlans/*`
164
165
  # @!attribute [rw] etag
165
166
  # @return [::String]
166
167
  # 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.
168
+ # target BackupPlan's {::Google::Cloud::GkeBackup::V1::BackupPlan#etag etag} field
169
+ # or the request is rejected.
169
170
  class DeleteBackupPlanRequest
170
171
  include ::Google::Protobuf::MessageExts
171
172
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -175,7 +176,7 @@ module Google
175
176
  # @!attribute [rw] parent
176
177
  # @return [::String]
177
178
  # Required. The BackupPlan within which to create the Backup.
178
- # Format: projects/*/locations/*/backupPlans/*
179
+ # Format: `projects/*/locations/*/backupPlans/*`
179
180
  # @!attribute [rw] backup
180
181
  # @return [::Google::Cloud::GkeBackup::V1::Backup]
181
182
  # The Backup resource to create.
@@ -184,11 +185,11 @@ module Google
184
185
  # The client-provided short name for the Backup resource.
185
186
  # This name must:
186
187
  #
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
188
+ # - be between 1 and 63 characters long (inclusive)
189
+ # - consist of only lower-case ASCII letters, numbers, and dashes
190
+ # - start with a lower-case letter
191
+ # - end with a lower-case letter or number
192
+ # - be unique within the set of Backups in this BackupPlan
192
193
  class CreateBackupRequest
193
194
  include ::Google::Protobuf::MessageExts
194
195
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -198,7 +199,7 @@ module Google
198
199
  # @!attribute [rw] parent
199
200
  # @return [::String]
200
201
  # Required. The BackupPlan that contains the Backups to list.
201
- # Format: projects/*/locations/*/backupPlans/*
202
+ # Format: `projects/*/locations/*/backupPlans/*`
202
203
  # @!attribute [rw] page_size
203
204
  # @return [::Integer]
204
205
  # The target number of results to return in a single response.
@@ -232,9 +233,10 @@ module Google
232
233
  # The list of Backups matching the given criteria.
233
234
  # @!attribute [rw] next_page_token
234
235
  # @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.
236
+ # A token which may be sent as
237
+ # {::Google::Cloud::GkeBackup::V1::ListBackupsRequest#page_token page_token} in a
238
+ # subsequent `ListBackups` call to retrieve the next page of results. If this
239
+ # field is omitted or empty, then there are no more results to return.
238
240
  class ListBackupsResponse
239
241
  include ::Google::Protobuf::MessageExts
240
242
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -244,7 +246,7 @@ module Google
244
246
  # @!attribute [rw] name
245
247
  # @return [::String]
246
248
  # Required. Full name of the Backup resource.
247
- # Format: projects/*/locations/*/backupPlans/*/backups/*
249
+ # Format: `projects/*/locations/*/backupPlans/*/backups/*`
248
250
  class GetBackupRequest
249
251
  include ::Google::Protobuf::MessageExts
250
252
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -253,8 +255,8 @@ module Google
253
255
  # Request message for UpdateBackup.
254
256
  # @!attribute [rw] backup
255
257
  # @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
+ # Required. A new version of the Backup resource that contains updated
259
+ # fields. This may be sparsely populated if an `update_mask` is provided.
258
260
  # @!attribute [rw] update_mask
259
261
  # @return [::Google::Protobuf::FieldMask]
260
262
  # This is used to specify the fields to be overwritten in the
@@ -274,12 +276,12 @@ module Google
274
276
  # @!attribute [rw] name
275
277
  # @return [::String]
276
278
  # Required. Name of the Backup resource.
277
- # Format: projects/*/locations/*/backupPlans/*/backups/*
279
+ # Format: `projects/*/locations/*/backupPlans/*/backups/*`
278
280
  # @!attribute [rw] etag
279
281
  # @return [::String]
280
282
  # 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
+ # target Backup's {::Google::Cloud::GkeBackup::V1::Backup#etag etag} field or the
284
+ # request is rejected.
283
285
  # @!attribute [rw] force
284
286
  # @return [::Boolean]
285
287
  # If set to true, any VolumeBackups below this Backup will also be deleted.
@@ -294,7 +296,7 @@ module Google
294
296
  # @!attribute [rw] parent
295
297
  # @return [::String]
296
298
  # Required. The Backup that contains the VolumeBackups to list.
297
- # Format: projects/*/locations/*/backupPlans/*/backups/*
299
+ # Format: `projects/*/locations/*/backupPlans/*/backups/*`
298
300
  # @!attribute [rw] page_size
299
301
  # @return [::Integer]
300
302
  # The target number of results to return in a single response.
@@ -329,10 +331,10 @@ module Google
329
331
  # @!attribute [rw] next_page_token
330
332
  # @return [::String]
331
333
  # 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.
334
+ # {::Google::Cloud::GkeBackup::V1::ListVolumeBackupsRequest#page_token page_token}
335
+ # in a subsequent `ListVolumeBackups` call to retrieve the next page of
336
+ # results. If this field is omitted or empty, then there are no more results
337
+ # to return.
336
338
  class ListVolumeBackupsResponse
337
339
  include ::Google::Protobuf::MessageExts
338
340
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -342,7 +344,7 @@ module Google
342
344
  # @!attribute [rw] name
343
345
  # @return [::String]
344
346
  # Required. Full name of the VolumeBackup resource.
345
- # Format: projects/*/locations/*/backupPlans/*/backups/*/volumeBackups/*
347
+ # Format: `projects/*/locations/*/backupPlans/*/backups/*/volumeBackups/*`
346
348
  class GetVolumeBackupRequest
347
349
  include ::Google::Protobuf::MessageExts
348
350
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -352,7 +354,7 @@ module Google
352
354
  # @!attribute [rw] parent
353
355
  # @return [::String]
354
356
  # Required. The location within which to create the RestorePlan.
355
- # Format: projects/*/locations/*
357
+ # Format: `projects/*/locations/*`
356
358
  # @!attribute [rw] restore_plan
357
359
  # @return [::Google::Cloud::GkeBackup::V1::RestorePlan]
358
360
  # Required. The RestorePlan resource object to create.
@@ -361,11 +363,11 @@ module Google
361
363
  # Required. The client-provided short name for the RestorePlan resource.
362
364
  # This name must:
363
365
  #
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
366
+ # - be between 1 and 63 characters long (inclusive)
367
+ # - consist of only lower-case ASCII letters, numbers, and dashes
368
+ # - start with a lower-case letter
369
+ # - end with a lower-case letter or number
370
+ # - be unique within the set of RestorePlans in this location
369
371
  class CreateRestorePlanRequest
370
372
  include ::Google::Protobuf::MessageExts
371
373
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -375,7 +377,7 @@ module Google
375
377
  # @!attribute [rw] parent
376
378
  # @return [::String]
377
379
  # Required. The location that contains the RestorePlans to list.
378
- # Format: projects/*/locations/*
380
+ # Format: `projects/*/locations/*`
379
381
  # @!attribute [rw] page_size
380
382
  # @return [::Integer]
381
383
  # The target number of results to return in a single response.
@@ -410,10 +412,10 @@ module Google
410
412
  # @!attribute [rw] next_page_token
411
413
  # @return [::String]
412
414
  # 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.
415
+ # {::Google::Cloud::GkeBackup::V1::ListRestorePlansRequest#page_token page_token}
416
+ # in a subsequent `ListRestorePlans` call to retrieve the next page of
417
+ # results. If this field is omitted or empty, then there are no more results
418
+ # to return.
417
419
  # @!attribute [rw] unreachable
418
420
  # @return [::Array<::String>]
419
421
  # Locations that could not be reached.
@@ -426,7 +428,7 @@ module Google
426
428
  # @!attribute [rw] name
427
429
  # @return [::String]
428
430
  # Required. Fully qualified RestorePlan name.
429
- # Format: projects/*/locations/*/restorePlans/*
431
+ # Format: `projects/*/locations/*/restorePlans/*`
430
432
  class GetRestorePlanRequest
431
433
  include ::Google::Protobuf::MessageExts
432
434
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -435,8 +437,8 @@ module Google
435
437
  # Request message for UpdateRestorePlan.
436
438
  # @!attribute [rw] restore_plan
437
439
  # @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
+ # Required. A new version of the RestorePlan resource that contains updated
441
+ # fields. This may be sparsely populated if an `update_mask` is provided.
440
442
  # @!attribute [rw] update_mask
441
443
  # @return [::Google::Protobuf::FieldMask]
442
444
  # This is used to specify the fields to be overwritten in the
@@ -456,12 +458,12 @@ module Google
456
458
  # @!attribute [rw] name
457
459
  # @return [::String]
458
460
  # Required. Fully qualified RestorePlan name.
459
- # Format: projects/*/locations/*/restorePlans/*
461
+ # Format: `projects/*/locations/*/restorePlans/*`
460
462
  # @!attribute [rw] etag
461
463
  # @return [::String]
462
464
  # 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
+ # target RestorePlan's {::Google::Cloud::GkeBackup::V1::RestorePlan#etag etag}
466
+ # field or the request is rejected.
465
467
  # @!attribute [rw] force
466
468
  # @return [::Boolean]
467
469
  # If set to true, any Restores below this RestorePlan will also be deleted.
@@ -476,7 +478,7 @@ module Google
476
478
  # @!attribute [rw] parent
477
479
  # @return [::String]
478
480
  # Required. The RestorePlan within which to create the Restore.
479
- # Format: projects/*/locations/*/restorePlans/*
481
+ # Format: `projects/*/locations/*/restorePlans/*`
480
482
  # @!attribute [rw] restore
481
483
  # @return [::Google::Cloud::GkeBackup::V1::Restore]
482
484
  # Required. The restore resource to create.
@@ -485,11 +487,11 @@ module Google
485
487
  # Required. The client-provided short name for the Restore resource.
486
488
  # This name must:
487
489
  #
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.
490
+ # - be between 1 and 63 characters long (inclusive)
491
+ # - consist of only lower-case ASCII letters, numbers, and dashes
492
+ # - start with a lower-case letter
493
+ # - end with a lower-case letter or number
494
+ # - be unique within the set of Restores in this RestorePlan.
493
495
  class CreateRestoreRequest
494
496
  include ::Google::Protobuf::MessageExts
495
497
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -499,7 +501,7 @@ module Google
499
501
  # @!attribute [rw] parent
500
502
  # @return [::String]
501
503
  # Required. The RestorePlan that contains the Restores to list.
502
- # Format: projects/*/locations/*/restorePlans/*
504
+ # Format: `projects/*/locations/*/restorePlans/*`
503
505
  # @!attribute [rw] page_size
504
506
  # @return [::Integer]
505
507
  # The target number of results to return in a single response.
@@ -533,10 +535,10 @@ module Google
533
535
  # The list of Restores matching the given criteria.
534
536
  # @!attribute [rw] next_page_token
535
537
  # @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.
538
+ # A token which may be sent as
539
+ # {::Google::Cloud::GkeBackup::V1::ListRestoresRequest#page_token page_token} in a
540
+ # subsequent `ListRestores` call to retrieve the next page of results. If
541
+ # this field is omitted or empty, then there are no more results to return.
540
542
  # @!attribute [rw] unreachable
541
543
  # @return [::Array<::String>]
542
544
  # Locations that could not be reached.
@@ -549,7 +551,7 @@ module Google
549
551
  # @!attribute [rw] name
550
552
  # @return [::String]
551
553
  # Required. Name of the restore resource.
552
- # Format: projects/*/locations/*/restorePlans/*/restores/*
554
+ # Format: `projects/*/locations/*/restorePlans/*/restores/*`
553
555
  class GetRestoreRequest
554
556
  include ::Google::Protobuf::MessageExts
555
557
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -558,8 +560,8 @@ module Google
558
560
  # Request message for UpdateRestore.
559
561
  # @!attribute [rw] restore
560
562
  # @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
+ # Required. A new version of the Restore resource that contains updated
564
+ # fields. This may be sparsely populated if an `update_mask` is provided.
563
565
  # @!attribute [rw] update_mask
564
566
  # @return [::Google::Protobuf::FieldMask]
565
567
  # This is used to specify the fields to be overwritten in the
@@ -579,12 +581,12 @@ module Google
579
581
  # @!attribute [rw] name
580
582
  # @return [::String]
581
583
  # Required. Full name of the Restore
582
- # Format: projects/*/locations/*/restorePlans/*/restores/*
584
+ # Format: `projects/*/locations/*/restorePlans/*/restores/*`
583
585
  # @!attribute [rw] etag
584
586
  # @return [::String]
585
587
  # 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
+ # target Restore's {::Google::Cloud::GkeBackup::V1::Restore#etag etag} field or
589
+ # the request is rejected.
588
590
  # @!attribute [rw] force
589
591
  # @return [::Boolean]
590
592
  # If set to true, any VolumeRestores below this restore will also be deleted.
@@ -599,7 +601,7 @@ module Google
599
601
  # @!attribute [rw] parent
600
602
  # @return [::String]
601
603
  # Required. The Restore that contains the VolumeRestores to list.
602
- # Format: projects/*/locations/*/restorePlans/*/restores/*
604
+ # Format: `projects/*/locations/*/restorePlans/*/restores/*`
603
605
  # @!attribute [rw] page_size
604
606
  # @return [::Integer]
605
607
  # The target number of results to return in a single response.
@@ -634,10 +636,10 @@ module Google
634
636
  # @!attribute [rw] next_page_token
635
637
  # @return [::String]
636
638
  # 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.
639
+ # {::Google::Cloud::GkeBackup::V1::ListVolumeRestoresRequest#page_token page_token}
640
+ # in a subsequent `ListVolumeRestores` call to retrieve the next page of
641
+ # results. If this field is omitted or empty, then there are no more results
642
+ # to return.
641
643
  class ListVolumeRestoresResponse
642
644
  include ::Google::Protobuf::MessageExts
643
645
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -647,7 +649,7 @@ module Google
647
649
  # @!attribute [rw] name
648
650
  # @return [::String]
649
651
  # Required. Full name of the VolumeRestore resource.
650
- # Format: projects/*/locations/*/restorePlans/*/restores/*/volumeRestores/*
652
+ # Format: `projects/*/locations/*/restorePlans/*/restores/*/volumeRestores/*`
651
653
  class GetVolumeRestoreRequest
652
654
  include ::Google::Protobuf::MessageExts
653
655
  extend ::Google::Protobuf::MessageExts::ClassMethods