google-cloud-gke_backup-v1 1.0.0 → 1.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.
- checksums.yaml +4 -4
- data/lib/google/cloud/gke_backup/v1/backup_for_gke/client.rb +1910 -339
- data/lib/google/cloud/gke_backup/v1/backup_for_gke/paths.rb +80 -0
- data/lib/google/cloud/gke_backup/v1/backup_for_gke/rest/client.rb +1756 -283
- data/lib/google/cloud/gke_backup/v1/backup_for_gke/rest/service_stub.rb +878 -20
- data/lib/google/cloud/gke_backup/v1/version.rb +1 -1
- data/lib/google/cloud/gkebackup/v1/backup_channel_pb.rb +48 -0
- data/lib/google/cloud/gkebackup/v1/backup_pb.rb +1 -1
- data/lib/google/cloud/gkebackup/v1/backup_plan_binding_pb.rb +50 -0
- data/lib/google/cloud/gkebackup/v1/backup_plan_pb.rb +1 -1
- data/lib/google/cloud/gkebackup/v1/gkebackup_pb.rb +27 -1
- data/lib/google/cloud/gkebackup/v1/gkebackup_services_pb.rb +28 -0
- data/lib/google/cloud/gkebackup/v1/restore_channel_pb.rb +48 -0
- data/lib/google/cloud/gkebackup/v1/restore_pb.rb +1 -1
- data/lib/google/cloud/gkebackup/v1/restore_plan_binding_pb.rb +48 -0
- data/lib/google/cloud/gkebackup/v1/volume_pb.rb +1 -1
- data/proto_docs/google/api/client.rb +6 -0
- data/proto_docs/google/api/field_info.rb +88 -0
- data/proto_docs/google/cloud/gkebackup/v1/backup.rb +8 -1
- data/proto_docs/google/cloud/gkebackup/v1/backup_channel.rb +88 -0
- data/proto_docs/google/cloud/gkebackup/v1/backup_plan.rb +8 -1
- data/proto_docs/google/cloud/gkebackup/v1/backup_plan_binding.rb +130 -0
- data/proto_docs/google/cloud/gkebackup/v1/common.rb +2 -2
- data/proto_docs/google/cloud/gkebackup/v1/gkebackup.rb +389 -3
- data/proto_docs/google/cloud/gkebackup/v1/restore.rb +14 -6
- data/proto_docs/google/cloud/gkebackup/v1/restore_channel.rb +87 -0
- data/proto_docs/google/cloud/gkebackup/v1/restore_plan.rb +3 -1
- data/proto_docs/google/cloud/gkebackup/v1/restore_plan_binding.rb +68 -0
- data/proto_docs/google/cloud/gkebackup/v1/volume.rb +13 -1
- metadata +12 -3
@@ -41,9 +41,10 @@ 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
|
45
|
-
# {::Google::
|
46
|
-
#
|
44
|
+
# have
|
45
|
+
# {::Google::Longrunning::Operation#error google.longrunning.Operation.error}
|
46
|
+
# value with a {::Google::Rpc::Status#code google.rpc.Status.code} of 1,
|
47
|
+
# corresponding to `Code.CANCELLED`.
|
47
48
|
# @!attribute [r] api_version
|
48
49
|
# @return [::String]
|
49
50
|
# Output only. API version used to start the operation.
|
@@ -172,6 +173,196 @@ module Google
|
|
172
173
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
173
174
|
end
|
174
175
|
|
176
|
+
# Request message for CreateBackupChannel.
|
177
|
+
# @!attribute [rw] parent
|
178
|
+
# @return [::String]
|
179
|
+
# Required. The location within which to create the BackupChannel.
|
180
|
+
# Format: `projects/*/locations/*`
|
181
|
+
# @!attribute [rw] backup_channel
|
182
|
+
# @return [::Google::Cloud::GkeBackup::V1::BackupChannel]
|
183
|
+
# Required. The BackupChannel resource object to create.
|
184
|
+
# @!attribute [rw] backup_channel_id
|
185
|
+
# @return [::String]
|
186
|
+
# Optional. The client-provided short name for the BackupChannel resource.
|
187
|
+
# This name must:
|
188
|
+
#
|
189
|
+
# - be between 1 and 63 characters long (inclusive)
|
190
|
+
# - consist of only lower-case ASCII letters, numbers, and dashes
|
191
|
+
# - start with a lower-case letter
|
192
|
+
# - end with a lower-case letter or number
|
193
|
+
# - be unique within the set of BackupChannels in this location
|
194
|
+
# If the user does not provide a name, a uuid will be used as the name.
|
195
|
+
class CreateBackupChannelRequest
|
196
|
+
include ::Google::Protobuf::MessageExts
|
197
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
198
|
+
end
|
199
|
+
|
200
|
+
# Request message for ListBackupChannels.
|
201
|
+
# @!attribute [rw] parent
|
202
|
+
# @return [::String]
|
203
|
+
# Required. The location that contains the BackupChannels to list.
|
204
|
+
# Format: `projects/*/locations/*`
|
205
|
+
# @!attribute [rw] page_size
|
206
|
+
# @return [::Integer]
|
207
|
+
# Optional. The target number of results to return in a single response.
|
208
|
+
# If not specified, a default value will be chosen by the service.
|
209
|
+
# Note that the response may include a partial list and a caller should
|
210
|
+
# only rely on the response's
|
211
|
+
# {::Google::Cloud::GkeBackup::V1::ListBackupChannelsResponse#next_page_token next_page_token}
|
212
|
+
# to determine if there are more instances left to be queried.
|
213
|
+
# @!attribute [rw] page_token
|
214
|
+
# @return [::String]
|
215
|
+
# Optional. The value of
|
216
|
+
# {::Google::Cloud::GkeBackup::V1::ListBackupChannelsResponse#next_page_token next_page_token}
|
217
|
+
# received from a previous `ListBackupChannels` call.
|
218
|
+
# Provide this to retrieve the subsequent page in a multi-page list of
|
219
|
+
# results. When paginating, all other parameters provided to
|
220
|
+
# `ListBackupChannels` must match the call that provided the page
|
221
|
+
# token.
|
222
|
+
# @!attribute [rw] filter
|
223
|
+
# @return [::String]
|
224
|
+
# Optional. Field match expression used to filter the results.
|
225
|
+
# @!attribute [rw] order_by
|
226
|
+
# @return [::String]
|
227
|
+
# Optional. Field by which to sort the results.
|
228
|
+
class ListBackupChannelsRequest
|
229
|
+
include ::Google::Protobuf::MessageExts
|
230
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
231
|
+
end
|
232
|
+
|
233
|
+
# Response message for ListBackupChannels.
|
234
|
+
# @!attribute [rw] backup_channels
|
235
|
+
# @return [::Array<::Google::Cloud::GkeBackup::V1::BackupChannel>]
|
236
|
+
# The list of BackupChannels matching the given criteria.
|
237
|
+
# @!attribute [rw] next_page_token
|
238
|
+
# @return [::String]
|
239
|
+
# A token which may be sent as
|
240
|
+
# {::Google::Cloud::GkeBackup::V1::ListBackupChannelsRequest#page_token page_token}
|
241
|
+
# in a subsequent `ListBackupChannels` call to retrieve the next page of
|
242
|
+
# results. If this field is omitted or empty, then there are no more results
|
243
|
+
# to return.
|
244
|
+
# @!attribute [rw] unreachable
|
245
|
+
# @return [::Array<::String>]
|
246
|
+
# Locations that could not be reached.
|
247
|
+
class ListBackupChannelsResponse
|
248
|
+
include ::Google::Protobuf::MessageExts
|
249
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
250
|
+
end
|
251
|
+
|
252
|
+
# Request message for GetBackupChannel.
|
253
|
+
# @!attribute [rw] name
|
254
|
+
# @return [::String]
|
255
|
+
# Required. Fully qualified BackupChannel name.
|
256
|
+
# Format: `projects/*/locations/*/backupChannels/*`
|
257
|
+
class GetBackupChannelRequest
|
258
|
+
include ::Google::Protobuf::MessageExts
|
259
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
260
|
+
end
|
261
|
+
|
262
|
+
# Request message for UpdateBackupChannel.
|
263
|
+
# @!attribute [rw] backup_channel
|
264
|
+
# @return [::Google::Cloud::GkeBackup::V1::BackupChannel]
|
265
|
+
# Required. A new version of the BackupChannel resource that contains updated
|
266
|
+
# fields. This may be sparsely populated if an `update_mask` is provided.
|
267
|
+
# @!attribute [rw] update_mask
|
268
|
+
# @return [::Google::Protobuf::FieldMask]
|
269
|
+
# Optional. This is used to specify the fields to be overwritten in the
|
270
|
+
# BackupChannel targeted for update. The values for each of these
|
271
|
+
# updated fields will be taken from the `backup_channel` provided
|
272
|
+
# with this request. Field names are relative to the root of the resource
|
273
|
+
# (e.g., `description`, `labels`, etc.)
|
274
|
+
# If no `update_mask` is provided, all fields in `backup_channel` will
|
275
|
+
# be written to the target BackupChannel resource. Note that
|
276
|
+
# OUTPUT_ONLY and IMMUTABLE fields in `backup_channel` are ignored and
|
277
|
+
# are not used to update the target BackupChannel.
|
278
|
+
class UpdateBackupChannelRequest
|
279
|
+
include ::Google::Protobuf::MessageExts
|
280
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
281
|
+
end
|
282
|
+
|
283
|
+
# Request message for DeleteBackupChannel.
|
284
|
+
# @!attribute [rw] name
|
285
|
+
# @return [::String]
|
286
|
+
# Required. Fully qualified BackupChannel name.
|
287
|
+
# Format: `projects/*/locations/*/backupChannels/*`
|
288
|
+
# @!attribute [rw] etag
|
289
|
+
# @return [::String]
|
290
|
+
# Optional. If provided, this value must match the current value of the
|
291
|
+
# target BackupChannel's {::Google::Cloud::GkeBackup::V1::BackupChannel#etag etag}
|
292
|
+
# field or the request is rejected.
|
293
|
+
# @!attribute [rw] force
|
294
|
+
# @return [::Boolean]
|
295
|
+
# Optional. If set to true, any BackupPlanAssociations below this
|
296
|
+
# BackupChannel will also be deleted. Otherwise, the request will only
|
297
|
+
# succeed if the BackupChannel has no BackupPlanAssociations.
|
298
|
+
class DeleteBackupChannelRequest
|
299
|
+
include ::Google::Protobuf::MessageExts
|
300
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
301
|
+
end
|
302
|
+
|
303
|
+
# Request message for ListBackupPlanBindings.
|
304
|
+
# @!attribute [rw] parent
|
305
|
+
# @return [::String]
|
306
|
+
# Required. The BackupChannel that contains the BackupPlanBindings to list.
|
307
|
+
# Format: `projects/*/locations/*/backupChannels/*`
|
308
|
+
# @!attribute [rw] page_size
|
309
|
+
# @return [::Integer]
|
310
|
+
# Optional. The target number of results to return in a single response.
|
311
|
+
# If not specified, a default value will be chosen by the service.
|
312
|
+
# Note that the response may include a partial list and a caller should
|
313
|
+
# only rely on the response's
|
314
|
+
# {::Google::Cloud::GkeBackup::V1::ListBackupPlanBindingsResponse#next_page_token next_page_token}
|
315
|
+
# to determine if there are more instances left to be queried.
|
316
|
+
# @!attribute [rw] page_token
|
317
|
+
# @return [::String]
|
318
|
+
# Optional. The value of
|
319
|
+
# {::Google::Cloud::GkeBackup::V1::ListBackupPlanBindingsResponse#next_page_token next_page_token}
|
320
|
+
# received from a previous `ListBackupPlanBindings` call.
|
321
|
+
# Provide this to retrieve the subsequent page in a multi-page list of
|
322
|
+
# results. When paginating, all other parameters provided to
|
323
|
+
# `ListBackupPlanBindings` must match the call that provided the page
|
324
|
+
# token.
|
325
|
+
# @!attribute [rw] filter
|
326
|
+
# @return [::String]
|
327
|
+
# Optional. Field match expression used to filter the results.
|
328
|
+
# @!attribute [rw] order_by
|
329
|
+
# @return [::String]
|
330
|
+
# Optional. Field by which to sort the results.
|
331
|
+
class ListBackupPlanBindingsRequest
|
332
|
+
include ::Google::Protobuf::MessageExts
|
333
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
334
|
+
end
|
335
|
+
|
336
|
+
# Response message for ListBackupPlanBindings.
|
337
|
+
# @!attribute [rw] backup_plan_bindings
|
338
|
+
# @return [::Array<::Google::Cloud::GkeBackup::V1::BackupPlanBinding>]
|
339
|
+
# The list of BackupPlanBindings matching the given criteria.
|
340
|
+
# @!attribute [rw] next_page_token
|
341
|
+
# @return [::String]
|
342
|
+
# A token which may be sent as
|
343
|
+
# {::Google::Cloud::GkeBackup::V1::ListBackupPlanBindingsRequest#page_token page_token}
|
344
|
+
# in a subsequent `ListBackupPlanBindingss` call to retrieve the next page of
|
345
|
+
# results. If this field is omitted or empty, then there are no more results
|
346
|
+
# to return.
|
347
|
+
# @!attribute [rw] unreachable
|
348
|
+
# @return [::Array<::String>]
|
349
|
+
# Locations that could not be reached.
|
350
|
+
class ListBackupPlanBindingsResponse
|
351
|
+
include ::Google::Protobuf::MessageExts
|
352
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
353
|
+
end
|
354
|
+
|
355
|
+
# Request message for GetBackupPlanBinding.
|
356
|
+
# @!attribute [rw] name
|
357
|
+
# @return [::String]
|
358
|
+
# Required. Fully qualified BackupPlanBinding name.
|
359
|
+
# Format:
|
360
|
+
# `projects/*/locations/*/backupChannels/*/backupPlanBindings/*`
|
361
|
+
class GetBackupPlanBindingRequest
|
362
|
+
include ::Google::Protobuf::MessageExts
|
363
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
364
|
+
end
|
365
|
+
|
175
366
|
# Request message for CreateBackup.
|
176
367
|
# @!attribute [rw] parent
|
177
368
|
# @return [::String]
|
@@ -222,6 +413,10 @@ module Google
|
|
222
413
|
# @!attribute [rw] order_by
|
223
414
|
# @return [::String]
|
224
415
|
# Optional. Field by which to sort the results.
|
416
|
+
# @!attribute [rw] return_partial_success
|
417
|
+
# @return [::Boolean]
|
418
|
+
# Optional. If set to true, the response will return partial results when
|
419
|
+
# some regions are unreachable and the unreachable field will be populated.
|
225
420
|
class ListBackupsRequest
|
226
421
|
include ::Google::Protobuf::MessageExts
|
227
422
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -237,6 +432,9 @@ module Google
|
|
237
432
|
# {::Google::Cloud::GkeBackup::V1::ListBackupsRequest#page_token page_token} in a
|
238
433
|
# subsequent `ListBackups` call to retrieve the next page of results. If this
|
239
434
|
# field is omitted or empty, then there are no more results to return.
|
435
|
+
# @!attribute [rw] unreachable
|
436
|
+
# @return [::Array<::String>]
|
437
|
+
# Locations that could not be reached.
|
240
438
|
class ListBackupsResponse
|
241
439
|
include ::Google::Protobuf::MessageExts
|
242
440
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -474,6 +672,193 @@ module Google
|
|
474
672
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
475
673
|
end
|
476
674
|
|
675
|
+
# Request message for CreateRestoreChannel.
|
676
|
+
# @!attribute [rw] parent
|
677
|
+
# @return [::String]
|
678
|
+
# Required. The location within which to create the RestoreChannel.
|
679
|
+
# Format: `projects/*/locations/*`
|
680
|
+
# @!attribute [rw] restore_channel
|
681
|
+
# @return [::Google::Cloud::GkeBackup::V1::RestoreChannel]
|
682
|
+
# Required. The RestoreChannel resource object to create.
|
683
|
+
# @!attribute [rw] restore_channel_id
|
684
|
+
# @return [::String]
|
685
|
+
# Optional. The client-provided short name for the RestoreChannel resource.
|
686
|
+
# This name must:
|
687
|
+
#
|
688
|
+
# - be between 1 and 63 characters long (inclusive)
|
689
|
+
# - consist of only lower-case ASCII letters, numbers, and dashes
|
690
|
+
# - start with a lower-case letter
|
691
|
+
# - end with a lower-case letter or number
|
692
|
+
# - be unique within the set of RestoreChannels in this location
|
693
|
+
# If the user does not provide a name, a uuid will be used as the name.
|
694
|
+
class CreateRestoreChannelRequest
|
695
|
+
include ::Google::Protobuf::MessageExts
|
696
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
697
|
+
end
|
698
|
+
|
699
|
+
# Request message for ListRestoreChannels.
|
700
|
+
# @!attribute [rw] parent
|
701
|
+
# @return [::String]
|
702
|
+
# Required. The location that contains the RestoreChannels to list.
|
703
|
+
# Format: `projects/*/locations/*`
|
704
|
+
# @!attribute [rw] page_size
|
705
|
+
# @return [::Integer]
|
706
|
+
# Optional. The target number of results to return in a single response.
|
707
|
+
# If not specified, a default value will be chosen by the service.
|
708
|
+
# Note that the response may include a partial list and a caller should
|
709
|
+
# only rely on the response's
|
710
|
+
# {::Google::Cloud::GkeBackup::V1::ListRestoreChannelsResponse#next_page_token next_page_token}
|
711
|
+
# to determine if there are more instances left to be queried.
|
712
|
+
# @!attribute [rw] page_token
|
713
|
+
# @return [::String]
|
714
|
+
# Optional. The value of
|
715
|
+
# {::Google::Cloud::GkeBackup::V1::ListRestoreChannelsResponse#next_page_token next_page_token}
|
716
|
+
# received from a previous `ListRestoreChannels` call.
|
717
|
+
# Provide this to retrieve the subsequent page in a multi-page list of
|
718
|
+
# results. When paginating, all other parameters provided to
|
719
|
+
# `ListRestoreChannels` must match the call that provided the page
|
720
|
+
# token.
|
721
|
+
# @!attribute [rw] filter
|
722
|
+
# @return [::String]
|
723
|
+
# Optional. Field match expression used to filter the results.
|
724
|
+
# @!attribute [rw] order_by
|
725
|
+
# @return [::String]
|
726
|
+
# Optional. Field by which to sort the results.
|
727
|
+
class ListRestoreChannelsRequest
|
728
|
+
include ::Google::Protobuf::MessageExts
|
729
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
730
|
+
end
|
731
|
+
|
732
|
+
# Response message for ListRestoreChannels.
|
733
|
+
# @!attribute [rw] restore_channels
|
734
|
+
# @return [::Array<::Google::Cloud::GkeBackup::V1::RestoreChannel>]
|
735
|
+
# The list of RestoreChannels matching the given criteria.
|
736
|
+
# @!attribute [rw] next_page_token
|
737
|
+
# @return [::String]
|
738
|
+
# A token which may be sent as
|
739
|
+
# {::Google::Cloud::GkeBackup::V1::ListRestoreChannelsRequest#page_token page_token}
|
740
|
+
# in a subsequent `ListRestoreChannels` call to retrieve the next page of
|
741
|
+
# results. If this field is omitted or empty, then there are no more results
|
742
|
+
# to return.
|
743
|
+
# @!attribute [rw] unreachable
|
744
|
+
# @return [::Array<::String>]
|
745
|
+
# Locations that could not be reached.
|
746
|
+
class ListRestoreChannelsResponse
|
747
|
+
include ::Google::Protobuf::MessageExts
|
748
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
749
|
+
end
|
750
|
+
|
751
|
+
# Request message for GetRestoreChannel.
|
752
|
+
# @!attribute [rw] name
|
753
|
+
# @return [::String]
|
754
|
+
# Required. Fully qualified RestoreChannel name.
|
755
|
+
# Format: `projects/*/locations/*/restoreChannels/*`
|
756
|
+
class GetRestoreChannelRequest
|
757
|
+
include ::Google::Protobuf::MessageExts
|
758
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
759
|
+
end
|
760
|
+
|
761
|
+
# Request message for UpdateRestoreChannel.
|
762
|
+
# @!attribute [rw] restore_channel
|
763
|
+
# @return [::Google::Cloud::GkeBackup::V1::RestoreChannel]
|
764
|
+
# Required. A new version of the RestoreChannel resource that contains
|
765
|
+
# updated fields. This may be sparsely populated if an `update_mask` is
|
766
|
+
# provided.
|
767
|
+
# @!attribute [rw] update_mask
|
768
|
+
# @return [::Google::Protobuf::FieldMask]
|
769
|
+
# Optional. This is used to specify the fields to be overwritten in the
|
770
|
+
# RestoreChannel targeted for update. The values for each of these
|
771
|
+
# updated fields will be taken from the `restore_channel` provided
|
772
|
+
# with this request. Field names are relative to the root of the resource
|
773
|
+
# (e.g., `description`, `destination_project_id`, etc.)
|
774
|
+
# If no `update_mask` is provided, all fields in `restore_channel` will
|
775
|
+
# be written to the target RestoreChannel resource. Note that
|
776
|
+
# OUTPUT_ONLY and IMMUTABLE fields in `restore_channel` are ignored and
|
777
|
+
# are not used to update the target RestoreChannel.
|
778
|
+
class UpdateRestoreChannelRequest
|
779
|
+
include ::Google::Protobuf::MessageExts
|
780
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
781
|
+
end
|
782
|
+
|
783
|
+
# Request message for DeleteRestoreChannel.
|
784
|
+
# @!attribute [rw] name
|
785
|
+
# @return [::String]
|
786
|
+
# Required. Fully qualified RestoreChannel name.
|
787
|
+
# Format: `projects/*/locations/*/restoreChannels/*`
|
788
|
+
# @!attribute [rw] etag
|
789
|
+
# @return [::String]
|
790
|
+
# Optional. If provided, this value must match the current value of the
|
791
|
+
# target RestoreChannel's
|
792
|
+
# {::Google::Cloud::GkeBackup::V1::RestoreChannel#etag etag} field or the request
|
793
|
+
# is rejected.
|
794
|
+
class DeleteRestoreChannelRequest
|
795
|
+
include ::Google::Protobuf::MessageExts
|
796
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
797
|
+
end
|
798
|
+
|
799
|
+
# Request message for ListRestorePlanBindings.
|
800
|
+
# @!attribute [rw] parent
|
801
|
+
# @return [::String]
|
802
|
+
# Required. The RestoreChannel that contains the ListRestorePlanBindings to
|
803
|
+
# list. Format: `projects/*/locations/*/restoreChannels/*`
|
804
|
+
# @!attribute [rw] page_size
|
805
|
+
# @return [::Integer]
|
806
|
+
# Optional. The target number of results to return in a single response.
|
807
|
+
# If not specified, a default value will be chosen by the service.
|
808
|
+
# Note that the response may include a partial list and a caller should
|
809
|
+
# only rely on the response's
|
810
|
+
# {::Google::Cloud::GkeBackup::V1::ListRestorePlanBindingsResponse#next_page_token next_page_token}
|
811
|
+
# to determine if there are more instances left to be queried.
|
812
|
+
# @!attribute [rw] page_token
|
813
|
+
# @return [::String]
|
814
|
+
# Optional. The value of
|
815
|
+
# {::Google::Cloud::GkeBackup::V1::ListRestorePlanBindingsResponse#next_page_token next_page_token}
|
816
|
+
# received from a previous `ListRestorePlanBindings` call.
|
817
|
+
# Provide this to retrieve the subsequent page in a multi-page list of
|
818
|
+
# results. When paginating, all other parameters provided to
|
819
|
+
# `ListRestorePlanBindings` must match the call that provided the page
|
820
|
+
# token.
|
821
|
+
# @!attribute [rw] filter
|
822
|
+
# @return [::String]
|
823
|
+
# Optional. Field match expression used to filter the results.
|
824
|
+
# @!attribute [rw] order_by
|
825
|
+
# @return [::String]
|
826
|
+
# Optional. Field by which to sort the results.
|
827
|
+
class ListRestorePlanBindingsRequest
|
828
|
+
include ::Google::Protobuf::MessageExts
|
829
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
830
|
+
end
|
831
|
+
|
832
|
+
# Response message for ListRestorePlanBindings.
|
833
|
+
# @!attribute [rw] restore_plan_bindings
|
834
|
+
# @return [::Array<::Google::Cloud::GkeBackup::V1::RestorePlanBinding>]
|
835
|
+
# The list of RestorePlanBindings matching the given criteria.
|
836
|
+
# @!attribute [rw] next_page_token
|
837
|
+
# @return [::String]
|
838
|
+
# A token which may be sent as
|
839
|
+
# {::Google::Cloud::GkeBackup::V1::ListRestorePlanBindingsRequest#page_token page_token}
|
840
|
+
# in a subsequent `ListRestorePlanBindings` call to retrieve the next page of
|
841
|
+
# results. If this field is omitted or empty, then there are no more results
|
842
|
+
# to return.
|
843
|
+
# @!attribute [rw] unreachable
|
844
|
+
# @return [::Array<::String>]
|
845
|
+
# Unordered list. Locations that could not be reached.
|
846
|
+
class ListRestorePlanBindingsResponse
|
847
|
+
include ::Google::Protobuf::MessageExts
|
848
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
849
|
+
end
|
850
|
+
|
851
|
+
# Request message for GetRestorePlanBinding.
|
852
|
+
# @!attribute [rw] name
|
853
|
+
# @return [::String]
|
854
|
+
# Required. Fully qualified RestorePlanBinding name.
|
855
|
+
# Format:
|
856
|
+
# `projects/*/locations/*/restoreChannels/*/restorePlanBindings/*`
|
857
|
+
class GetRestorePlanBindingRequest
|
858
|
+
include ::Google::Protobuf::MessageExts
|
859
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
860
|
+
end
|
861
|
+
|
477
862
|
# Request message for CreateRestore.
|
478
863
|
# @!attribute [rw] parent
|
479
864
|
# @return [::String]
|
@@ -669,6 +1054,7 @@ module Google
|
|
669
1054
|
# Response message for GetBackupIndexDownloadUrl.
|
670
1055
|
# @!attribute [rw] signed_url
|
671
1056
|
# @return [::String]
|
1057
|
+
# Required. The signed URL for downloading the backup index.
|
672
1058
|
class GetBackupIndexDownloadUrlResponse
|
673
1059
|
include ::Google::Protobuf::MessageExts
|
674
1060
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -40,7 +40,7 @@ module Google
|
|
40
40
|
# updated.
|
41
41
|
# @!attribute [rw] description
|
42
42
|
# @return [::String]
|
43
|
-
# User specified descriptive string for this Restore.
|
43
|
+
# Optional. User specified descriptive string for this Restore.
|
44
44
|
# @!attribute [rw] backup
|
45
45
|
# @return [::String]
|
46
46
|
# Required. Immutable. A reference to the
|
@@ -73,7 +73,9 @@ module Google
|
|
73
73
|
# @!attribute [r] state_reason
|
74
74
|
# @return [::String]
|
75
75
|
# Output only. Human-readable description of why the Restore is in its
|
76
|
-
# current state.
|
76
|
+
# current state. This field is only meant for human readability and should
|
77
|
+
# not be used programmatically as this field is not guaranteed to be
|
78
|
+
# consistent.
|
77
79
|
# @!attribute [r] complete_time
|
78
80
|
# @return [::Google::Protobuf::Timestamp]
|
79
81
|
# Output only. Timestamp of when the restore operation completed.
|
@@ -104,8 +106,8 @@ module Google
|
|
104
106
|
# @return [::Google::Cloud::GkeBackup::V1::Restore::Filter]
|
105
107
|
# Optional. Immutable. Filters resources for `Restore`. If not specified, the
|
106
108
|
# scope of the restore will remain the same as defined in the `RestorePlan`.
|
107
|
-
# If this is specified
|
108
|
-
# `inclusion_filters` or
|
109
|
+
# If this is specified and no resources are matched by the
|
110
|
+
# `inclusion_filters` or everything is excluded by the `exclusion_filters`,
|
109
111
|
# nothing will be restored. This filter can only be specified if the value of
|
110
112
|
# {::Google::Cloud::GkeBackup::V1::RestoreConfig#namespaced_resource_restore_mode namespaced_resource_restore_mode}
|
111
113
|
# is set to `MERGE_SKIP_ON_CONFLICT`, `MERGE_REPLACE_VOLUME_ON_CONFLICT` or
|
@@ -170,6 +172,10 @@ module Google
|
|
170
172
|
|
171
173
|
# This Restore resource is in the process of being deleted.
|
172
174
|
DELETING = 5
|
175
|
+
|
176
|
+
# The Kubernetes resources created by this Restore are being
|
177
|
+
# validated.
|
178
|
+
VALIDATING = 6
|
173
179
|
end
|
174
180
|
end
|
175
181
|
|
@@ -261,7 +267,7 @@ module Google
|
|
261
267
|
# @return [::String]
|
262
268
|
# Optional. API group string of a Kubernetes resource, e.g.
|
263
269
|
# "apiextensions.k8s.io", "storage.k8s.io", etc.
|
264
|
-
# Note: use empty string for core API group
|
270
|
+
# Note: use empty string for core API group.
|
265
271
|
# @!attribute [rw] resource_kind
|
266
272
|
# @return [::String]
|
267
273
|
# Optional. Kind of a Kubernetes resource, must be in UpperCamelCase
|
@@ -277,14 +283,16 @@ module Google
|
|
277
283
|
# Some group kinds are not reasonable choices for a restore, and will cause
|
278
284
|
# an error if selected here. Any scope selection that would restore
|
279
285
|
# "all valid" resources automatically excludes these group kinds.
|
286
|
+
# - Node
|
287
|
+
# - ComponentStatus
|
280
288
|
# - gkebackup.gke.io/BackupJob
|
281
289
|
# - gkebackup.gke.io/RestoreJob
|
282
290
|
# - metrics.k8s.io/NodeMetrics
|
283
291
|
# - migration.k8s.io/StorageState
|
284
292
|
# - migration.k8s.io/StorageVersionMigration
|
285
|
-
# - Node
|
286
293
|
# - snapshot.storage.k8s.io/VolumeSnapshotContent
|
287
294
|
# - storage.k8s.io/CSINode
|
295
|
+
# - storage.k8s.io/VolumeAttachment
|
288
296
|
#
|
289
297
|
# Some group kinds are driven by restore configuration elsewhere,
|
290
298
|
# and will cause an error if selected here.
|
@@ -0,0 +1,87 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2025 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
|
+
# A RestoreChannel imposes constraints on where backups can be restored.
|
25
|
+
# The RestoreChannel should be in the same project and region
|
26
|
+
# as the backups. The backups can only be restored in the
|
27
|
+
# `destination_project`.
|
28
|
+
# @!attribute [rw] name
|
29
|
+
# @return [::String]
|
30
|
+
# Identifier. The fully qualified name of the RestoreChannel.
|
31
|
+
# `projects/*/locations/*/restoreChannels/*`
|
32
|
+
# @!attribute [rw] destination_project
|
33
|
+
# @return [::String]
|
34
|
+
# Required. Immutable. The project into which the backups will be restored.
|
35
|
+
# The format is `projects/{project}`.
|
36
|
+
# Currently, \\{project} can only be the project number. Support for project
|
37
|
+
# IDs will be added in the future.
|
38
|
+
# @!attribute [r] uid
|
39
|
+
# @return [::String]
|
40
|
+
# Output only. Server generated global unique identifier of
|
41
|
+
# [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier) format.
|
42
|
+
# @!attribute [r] create_time
|
43
|
+
# @return [::Google::Protobuf::Timestamp]
|
44
|
+
# Output only. The timestamp when this RestoreChannel was created.
|
45
|
+
# @!attribute [r] update_time
|
46
|
+
# @return [::Google::Protobuf::Timestamp]
|
47
|
+
# Output only. The timestamp when this RestoreChannel was last updated.
|
48
|
+
# @!attribute [rw] labels
|
49
|
+
# @return [::Google::Protobuf::Map{::String => ::String}]
|
50
|
+
# Optional. A set of custom labels supplied by user.
|
51
|
+
# @!attribute [rw] description
|
52
|
+
# @return [::String]
|
53
|
+
# Optional. User specified descriptive string for this RestoreChannel.
|
54
|
+
# @!attribute [r] etag
|
55
|
+
# @return [::String]
|
56
|
+
# Output only. `etag` is used for optimistic concurrency control as a way to
|
57
|
+
# help prevent simultaneous updates of a RestoreChannel from overwriting each
|
58
|
+
# other. It is strongly suggested that systems make use of the 'etag' in the
|
59
|
+
# read-modify-write cycle to perform RestoreChannel updates in order to
|
60
|
+
# avoid race conditions: An `etag` is returned in the response to
|
61
|
+
# `GetRestoreChannel`, and systems are expected to put that etag in the
|
62
|
+
# request to `UpdateRestoreChannel` or `DeleteRestoreChannel` to
|
63
|
+
# ensure that their change will be applied to the same version of the
|
64
|
+
# resource.
|
65
|
+
# @!attribute [r] destination_project_id
|
66
|
+
# @return [::String]
|
67
|
+
# Output only. The project_id where backups will be restored.
|
68
|
+
# Example Project ID: "my-project-id".
|
69
|
+
# This will be an OUTPUT_ONLY field to return the project_id of the
|
70
|
+
# destination project.
|
71
|
+
class RestoreChannel
|
72
|
+
include ::Google::Protobuf::MessageExts
|
73
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
74
|
+
|
75
|
+
# @!attribute [rw] key
|
76
|
+
# @return [::String]
|
77
|
+
# @!attribute [rw] value
|
78
|
+
# @return [::String]
|
79
|
+
class LabelsEntry
|
80
|
+
include ::Google::Protobuf::MessageExts
|
81
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
82
|
+
end
|
83
|
+
end
|
84
|
+
end
|
85
|
+
end
|
86
|
+
end
|
87
|
+
end
|
@@ -80,7 +80,9 @@ module Google
|
|
80
80
|
# @!attribute [r] state_reason
|
81
81
|
# @return [::String]
|
82
82
|
# Output only. Human-readable description of why RestorePlan is in the
|
83
|
-
# current `state
|
83
|
+
# current `state`. This field is only meant for human readability and should
|
84
|
+
# not be used programmatically as this field is not guaranteed to be
|
85
|
+
# consistent.
|
84
86
|
class RestorePlan
|
85
87
|
include ::Google::Protobuf::MessageExts
|
86
88
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -0,0 +1,68 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2025 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
|
+
# A RestorePlanBinding binds a RestorePlan with a RestoreChannel.
|
25
|
+
# This resource is created automatically when a RestorePlan is created using a
|
26
|
+
# RestoreChannel. This also serves as a holder for cross-project fields
|
27
|
+
# that need to be displayed in the current project.
|
28
|
+
# @!attribute [rw] name
|
29
|
+
# @return [::String]
|
30
|
+
# Identifier. The fully qualified name of the RestorePlanBinding.
|
31
|
+
# `projects/*/locations/*/restoreChannels/*/restorePlanBindings/*`
|
32
|
+
# @!attribute [r] uid
|
33
|
+
# @return [::String]
|
34
|
+
# Output only. Server generated global unique identifier of
|
35
|
+
# [UUID4](https://en.wikipedia.org/wiki/Universally_unique_identifier)
|
36
|
+
# @!attribute [r] create_time
|
37
|
+
# @return [::Google::Protobuf::Timestamp]
|
38
|
+
# Output only. The timestamp when this binding was created.
|
39
|
+
# @!attribute [r] update_time
|
40
|
+
# @return [::Google::Protobuf::Timestamp]
|
41
|
+
# Output only. The timestamp when this binding was created.
|
42
|
+
# @!attribute [r] restore_plan
|
43
|
+
# @return [::String]
|
44
|
+
# Output only. The fully qualified name of the RestorePlan bound to this
|
45
|
+
# RestoreChannel. `projects/*/locations/*/restorePlans/{restore_plan}`
|
46
|
+
# @!attribute [r] etag
|
47
|
+
# @return [::String]
|
48
|
+
# Output only. `etag` is used for optimistic concurrency control as a way to
|
49
|
+
# help prevent simultaneous updates of a RestorePlanBinding from overwriting
|
50
|
+
# each other. It is strongly suggested that systems make use of the 'etag' in
|
51
|
+
# the read-modify-write cycle to perform RestorePlanBinding updates in
|
52
|
+
# order to avoid race conditions: An `etag` is returned in the response to
|
53
|
+
# `GetRestorePlanBinding`, and systems are expected to put that etag in
|
54
|
+
# the request to `UpdateRestorePlanBinding` or
|
55
|
+
# `DeleteRestorePlanBinding` to ensure that their change will be applied
|
56
|
+
# to the same version of the resource.
|
57
|
+
# @!attribute [r] backup_plan
|
58
|
+
# @return [::String]
|
59
|
+
# Output only. The fully qualified name of the BackupPlan bound to the
|
60
|
+
# specified RestorePlan. `projects/*/locations/*/backukpPlans/{backup_plan}`
|
61
|
+
class RestorePlanBinding
|
62
|
+
include ::Google::Protobuf::MessageExts
|
63
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
64
|
+
end
|
65
|
+
end
|
66
|
+
end
|
67
|
+
end
|
68
|
+
end
|