google-cloud-gke_backup-v1 0.8.0 → 0.9.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/google/cloud/gke_backup/v1/backup_for_gke/client.rb +145 -46
- data/lib/google/cloud/gke_backup/v1/backup_for_gke/rest/client.rb +138 -46
- data/lib/google/cloud/gke_backup/v1/backup_for_gke/rest/operations.rb +2 -2
- data/lib/google/cloud/gke_backup/v1/backup_for_gke/rest/service_stub.rb +59 -0
- data/lib/google/cloud/gke_backup/v1/version.rb +1 -1
- data/lib/google/cloud/gkebackup/v1/backup_pb.rb +1 -1
- data/lib/google/cloud/gkebackup/v1/backup_plan_pb.rb +11 -1
- data/lib/google/cloud/gkebackup/v1/common_pb.rb +2 -1
- data/lib/google/cloud/gkebackup/v1/gkebackup_pb.rb +3 -1
- data/lib/google/cloud/gkebackup/v1/gkebackup_services_pb.rb +2 -0
- data/lib/google/cloud/gkebackup/v1/restore_pb.rb +1 -1
- data/lib/google/cloud/gkebackup/v1/restore_plan_pb.rb +1 -1
- data/proto_docs/google/api/client.rb +4 -0
- data/proto_docs/google/cloud/gkebackup/v1/backup.rb +18 -18
- data/proto_docs/google/cloud/gkebackup/v1/backup_plan.rb +130 -34
- data/proto_docs/google/cloud/gkebackup/v1/common.rb +5 -5
- data/proto_docs/google/cloud/gkebackup/v1/gkebackup.rb +65 -46
- data/proto_docs/google/cloud/gkebackup/v1/restore.rb +60 -61
- data/proto_docs/google/cloud/gkebackup/v1/restore_plan.rb +2 -3
- data/proto_docs/google/cloud/gkebackup/v1/volume.rb +0 -2
- data/proto_docs/google/type/date.rb +53 -0
- data/proto_docs/google/type/dayofweek.rb +49 -0
- data/proto_docs/google/type/timeofday.rb +45 -0
- metadata +5 -2
@@ -82,15 +82,15 @@ module Google
|
|
82
82
|
# Format: `projects/*/locations/*`
|
83
83
|
# @!attribute [rw] page_size
|
84
84
|
# @return [::Integer]
|
85
|
-
# The target number of results to return in a single response.
|
85
|
+
# Optional. The target number of results to return in a single response.
|
86
86
|
# If not specified, a default value will be chosen by the service.
|
87
|
-
# Note that the response may
|
87
|
+
# Note that the response may include a partial list and a caller should
|
88
88
|
# only rely on the response's
|
89
89
|
# {::Google::Cloud::GkeBackup::V1::ListBackupPlansResponse#next_page_token next_page_token}
|
90
90
|
# to determine if there are more instances left to be queried.
|
91
91
|
# @!attribute [rw] page_token
|
92
92
|
# @return [::String]
|
93
|
-
# The value of
|
93
|
+
# Optional. The value of
|
94
94
|
# {::Google::Cloud::GkeBackup::V1::ListBackupPlansResponse#next_page_token next_page_token}
|
95
95
|
# received from a previous `ListBackupPlans` call.
|
96
96
|
# Provide this to retrieve the subsequent page in a multi-page list of
|
@@ -98,10 +98,10 @@ module Google
|
|
98
98
|
# `ListBackupPlans` must match the call that provided the page token.
|
99
99
|
# @!attribute [rw] filter
|
100
100
|
# @return [::String]
|
101
|
-
# Field match expression used to filter the results.
|
101
|
+
# Optional. Field match expression used to filter the results.
|
102
102
|
# @!attribute [rw] order_by
|
103
103
|
# @return [::String]
|
104
|
-
# Field by which to sort the results.
|
104
|
+
# Optional. Field by which to sort the results.
|
105
105
|
class ListBackupPlansRequest
|
106
106
|
include ::Google::Protobuf::MessageExts
|
107
107
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -143,7 +143,7 @@ module Google
|
|
143
143
|
# fields. This may be sparsely populated if an `update_mask` is provided.
|
144
144
|
# @!attribute [rw] update_mask
|
145
145
|
# @return [::Google::Protobuf::FieldMask]
|
146
|
-
# This is used to specify the fields to be overwritten in the
|
146
|
+
# Optional. This is used to specify the fields to be overwritten in the
|
147
147
|
# BackupPlan targeted for update. The values for each of these
|
148
148
|
# updated fields will be taken from the `backup_plan` provided
|
149
149
|
# with this request. Field names are relative to the root of the resource
|
@@ -164,7 +164,7 @@ module Google
|
|
164
164
|
# Format: `projects/*/locations/*/backupPlans/*`
|
165
165
|
# @!attribute [rw] etag
|
166
166
|
# @return [::String]
|
167
|
-
# If provided, this value must match the current value of the
|
167
|
+
# Optional. If provided, this value must match the current value of the
|
168
168
|
# target BackupPlan's {::Google::Cloud::GkeBackup::V1::BackupPlan#etag etag} field
|
169
169
|
# or the request is rejected.
|
170
170
|
class DeleteBackupPlanRequest
|
@@ -179,10 +179,10 @@ module Google
|
|
179
179
|
# Format: `projects/*/locations/*/backupPlans/*`
|
180
180
|
# @!attribute [rw] backup
|
181
181
|
# @return [::Google::Cloud::GkeBackup::V1::Backup]
|
182
|
-
# The Backup resource to create.
|
182
|
+
# Optional. The Backup resource to create.
|
183
183
|
# @!attribute [rw] backup_id
|
184
184
|
# @return [::String]
|
185
|
-
# The client-provided short name for the Backup resource.
|
185
|
+
# Optional. The client-provided short name for the Backup resource.
|
186
186
|
# This name must:
|
187
187
|
#
|
188
188
|
# - be between 1 and 63 characters long (inclusive)
|
@@ -202,15 +202,15 @@ module Google
|
|
202
202
|
# Format: `projects/*/locations/*/backupPlans/*`
|
203
203
|
# @!attribute [rw] page_size
|
204
204
|
# @return [::Integer]
|
205
|
-
# The target number of results to return in a single response.
|
205
|
+
# Optional. The target number of results to return in a single response.
|
206
206
|
# If not specified, a default value will be chosen by the service.
|
207
|
-
# Note that the response may
|
207
|
+
# Note that the response may include a partial list and a caller should
|
208
208
|
# only rely on the response's
|
209
209
|
# {::Google::Cloud::GkeBackup::V1::ListBackupsResponse#next_page_token next_page_token}
|
210
210
|
# to determine if there are more instances left to be queried.
|
211
211
|
# @!attribute [rw] page_token
|
212
212
|
# @return [::String]
|
213
|
-
# The value of
|
213
|
+
# Optional. The value of
|
214
214
|
# {::Google::Cloud::GkeBackup::V1::ListBackupsResponse#next_page_token next_page_token}
|
215
215
|
# received from a previous `ListBackups` call.
|
216
216
|
# Provide this to retrieve the subsequent page in a multi-page list of
|
@@ -218,10 +218,10 @@ module Google
|
|
218
218
|
# `ListBackups` must match the call that provided the page token.
|
219
219
|
# @!attribute [rw] filter
|
220
220
|
# @return [::String]
|
221
|
-
# Field match expression used to filter the results.
|
221
|
+
# Optional. Field match expression used to filter the results.
|
222
222
|
# @!attribute [rw] order_by
|
223
223
|
# @return [::String]
|
224
|
-
# Field by which to sort the results.
|
224
|
+
# Optional. Field by which to sort the results.
|
225
225
|
class ListBackupsRequest
|
226
226
|
include ::Google::Protobuf::MessageExts
|
227
227
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -259,7 +259,7 @@ module Google
|
|
259
259
|
# fields. This may be sparsely populated if an `update_mask` is provided.
|
260
260
|
# @!attribute [rw] update_mask
|
261
261
|
# @return [::Google::Protobuf::FieldMask]
|
262
|
-
# This is used to specify the fields to be overwritten in the
|
262
|
+
# Optional. This is used to specify the fields to be overwritten in the
|
263
263
|
# Backup targeted for update. The values for each of these
|
264
264
|
# updated fields will be taken from the `backup_plan` provided
|
265
265
|
# with this request. Field names are relative to the root of the resource.
|
@@ -279,13 +279,13 @@ module Google
|
|
279
279
|
# Format: `projects/*/locations/*/backupPlans/*/backups/*`
|
280
280
|
# @!attribute [rw] etag
|
281
281
|
# @return [::String]
|
282
|
-
# If provided, this value must match the current value of the
|
282
|
+
# Optional. If provided, this value must match the current value of the
|
283
283
|
# target Backup's {::Google::Cloud::GkeBackup::V1::Backup#etag etag} field or the
|
284
284
|
# request is rejected.
|
285
285
|
# @!attribute [rw] force
|
286
286
|
# @return [::Boolean]
|
287
|
-
# If set to true, any VolumeBackups below this Backup will also be
|
288
|
-
# Otherwise, the request will only succeed if the Backup has no
|
287
|
+
# Optional. If set to true, any VolumeBackups below this Backup will also be
|
288
|
+
# deleted. Otherwise, the request will only succeed if the Backup has no
|
289
289
|
# VolumeBackups.
|
290
290
|
class DeleteBackupRequest
|
291
291
|
include ::Google::Protobuf::MessageExts
|
@@ -299,15 +299,15 @@ module Google
|
|
299
299
|
# Format: `projects/*/locations/*/backupPlans/*/backups/*`
|
300
300
|
# @!attribute [rw] page_size
|
301
301
|
# @return [::Integer]
|
302
|
-
# The target number of results to return in a single response.
|
302
|
+
# Optional. The target number of results to return in a single response.
|
303
303
|
# If not specified, a default value will be chosen by the service.
|
304
|
-
# Note that the response may
|
304
|
+
# Note that the response may include a partial list and a caller should
|
305
305
|
# only rely on the response's
|
306
306
|
# {::Google::Cloud::GkeBackup::V1::ListVolumeBackupsResponse#next_page_token next_page_token}
|
307
307
|
# to determine if there are more instances left to be queried.
|
308
308
|
# @!attribute [rw] page_token
|
309
309
|
# @return [::String]
|
310
|
-
# The value of
|
310
|
+
# Optional. The value of
|
311
311
|
# {::Google::Cloud::GkeBackup::V1::ListVolumeBackupsResponse#next_page_token next_page_token}
|
312
312
|
# received from a previous `ListVolumeBackups` call.
|
313
313
|
# Provide this to retrieve the subsequent page in a multi-page list of
|
@@ -315,10 +315,10 @@ module Google
|
|
315
315
|
# `ListVolumeBackups` must match the call that provided the page token.
|
316
316
|
# @!attribute [rw] filter
|
317
317
|
# @return [::String]
|
318
|
-
# Field match expression used to filter the results.
|
318
|
+
# Optional. Field match expression used to filter the results.
|
319
319
|
# @!attribute [rw] order_by
|
320
320
|
# @return [::String]
|
321
|
-
# Field by which to sort the results.
|
321
|
+
# Optional. Field by which to sort the results.
|
322
322
|
class ListVolumeBackupsRequest
|
323
323
|
include ::Google::Protobuf::MessageExts
|
324
324
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -380,15 +380,15 @@ module Google
|
|
380
380
|
# Format: `projects/*/locations/*`
|
381
381
|
# @!attribute [rw] page_size
|
382
382
|
# @return [::Integer]
|
383
|
-
# The target number of results to return in a single response.
|
383
|
+
# Optional. The target number of results to return in a single response.
|
384
384
|
# If not specified, a default value will be chosen by the service.
|
385
|
-
# Note that the response may
|
385
|
+
# Note that the response may include a partial list and a caller should
|
386
386
|
# only rely on the response's
|
387
387
|
# {::Google::Cloud::GkeBackup::V1::ListRestorePlansResponse#next_page_token next_page_token}
|
388
388
|
# to determine if there are more instances left to be queried.
|
389
389
|
# @!attribute [rw] page_token
|
390
390
|
# @return [::String]
|
391
|
-
# The value of
|
391
|
+
# Optional. The value of
|
392
392
|
# {::Google::Cloud::GkeBackup::V1::ListRestorePlansResponse#next_page_token next_page_token}
|
393
393
|
# received from a previous `ListRestorePlans` call.
|
394
394
|
# Provide this to retrieve the subsequent page in a multi-page list of
|
@@ -396,10 +396,10 @@ module Google
|
|
396
396
|
# `ListRestorePlans` must match the call that provided the page token.
|
397
397
|
# @!attribute [rw] filter
|
398
398
|
# @return [::String]
|
399
|
-
# Field match expression used to filter the results.
|
399
|
+
# Optional. Field match expression used to filter the results.
|
400
400
|
# @!attribute [rw] order_by
|
401
401
|
# @return [::String]
|
402
|
-
# Field by which to sort the results.
|
402
|
+
# Optional. Field by which to sort the results.
|
403
403
|
class ListRestorePlansRequest
|
404
404
|
include ::Google::Protobuf::MessageExts
|
405
405
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -441,7 +441,7 @@ module Google
|
|
441
441
|
# fields. This may be sparsely populated if an `update_mask` is provided.
|
442
442
|
# @!attribute [rw] update_mask
|
443
443
|
# @return [::Google::Protobuf::FieldMask]
|
444
|
-
# This is used to specify the fields to be overwritten in the
|
444
|
+
# Optional. This is used to specify the fields to be overwritten in the
|
445
445
|
# RestorePlan targeted for update. The values for each of these
|
446
446
|
# updated fields will be taken from the `restore_plan` provided
|
447
447
|
# with this request. Field names are relative to the root of the resource.
|
@@ -461,13 +461,13 @@ module Google
|
|
461
461
|
# Format: `projects/*/locations/*/restorePlans/*`
|
462
462
|
# @!attribute [rw] etag
|
463
463
|
# @return [::String]
|
464
|
-
# If provided, this value must match the current value of the
|
464
|
+
# Optional. If provided, this value must match the current value of the
|
465
465
|
# target RestorePlan's {::Google::Cloud::GkeBackup::V1::RestorePlan#etag etag}
|
466
466
|
# field or the request is rejected.
|
467
467
|
# @!attribute [rw] force
|
468
468
|
# @return [::Boolean]
|
469
|
-
# If set to true, any Restores below this RestorePlan will also be
|
470
|
-
# Otherwise, the request will only succeed if the RestorePlan has no
|
469
|
+
# Optional. If set to true, any Restores below this RestorePlan will also be
|
470
|
+
# deleted. Otherwise, the request will only succeed if the RestorePlan has no
|
471
471
|
# Restores.
|
472
472
|
class DeleteRestorePlanRequest
|
473
473
|
include ::Google::Protobuf::MessageExts
|
@@ -504,15 +504,15 @@ module Google
|
|
504
504
|
# Format: `projects/*/locations/*/restorePlans/*`
|
505
505
|
# @!attribute [rw] page_size
|
506
506
|
# @return [::Integer]
|
507
|
-
# The target number of results to return in a single response.
|
507
|
+
# Optional. The target number of results to return in a single response.
|
508
508
|
# If not specified, a default value will be chosen by the service.
|
509
|
-
# Note that the response may
|
509
|
+
# Note that the response may include a partial list and a caller should
|
510
510
|
# only rely on the response's
|
511
511
|
# {::Google::Cloud::GkeBackup::V1::ListRestoresResponse#next_page_token next_page_token}
|
512
512
|
# to determine if there are more instances left to be queried.
|
513
513
|
# @!attribute [rw] page_token
|
514
514
|
# @return [::String]
|
515
|
-
# The value of
|
515
|
+
# Optional. The value of
|
516
516
|
# {::Google::Cloud::GkeBackup::V1::ListRestoresResponse#next_page_token next_page_token}
|
517
517
|
# received from a previous `ListRestores` call.
|
518
518
|
# Provide this to retrieve the subsequent page in a multi-page list of
|
@@ -520,10 +520,10 @@ module Google
|
|
520
520
|
# must match the call that provided the page token.
|
521
521
|
# @!attribute [rw] filter
|
522
522
|
# @return [::String]
|
523
|
-
# Field match expression used to filter the results.
|
523
|
+
# Optional. Field match expression used to filter the results.
|
524
524
|
# @!attribute [rw] order_by
|
525
525
|
# @return [::String]
|
526
|
-
# Field by which to sort the results.
|
526
|
+
# Optional. Field by which to sort the results.
|
527
527
|
class ListRestoresRequest
|
528
528
|
include ::Google::Protobuf::MessageExts
|
529
529
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -564,7 +564,7 @@ module Google
|
|
564
564
|
# fields. This may be sparsely populated if an `update_mask` is provided.
|
565
565
|
# @!attribute [rw] update_mask
|
566
566
|
# @return [::Google::Protobuf::FieldMask]
|
567
|
-
# This is used to specify the fields to be overwritten in the
|
567
|
+
# Optional. This is used to specify the fields to be overwritten in the
|
568
568
|
# Restore targeted for update. The values for each of these
|
569
569
|
# updated fields will be taken from the `restore` provided
|
570
570
|
# with this request. Field names are relative to the root of the resource.
|
@@ -584,13 +584,13 @@ module Google
|
|
584
584
|
# Format: `projects/*/locations/*/restorePlans/*/restores/*`
|
585
585
|
# @!attribute [rw] etag
|
586
586
|
# @return [::String]
|
587
|
-
# If provided, this value must match the current value of the
|
587
|
+
# Optional. If provided, this value must match the current value of the
|
588
588
|
# target Restore's {::Google::Cloud::GkeBackup::V1::Restore#etag etag} field or
|
589
589
|
# the request is rejected.
|
590
590
|
# @!attribute [rw] force
|
591
591
|
# @return [::Boolean]
|
592
|
-
# If set to true, any VolumeRestores below this restore will also
|
593
|
-
# Otherwise, the request will only succeed if the restore has no
|
592
|
+
# Optional. If set to true, any VolumeRestores below this restore will also
|
593
|
+
# be deleted. Otherwise, the request will only succeed if the restore has no
|
594
594
|
# VolumeRestores.
|
595
595
|
class DeleteRestoreRequest
|
596
596
|
include ::Google::Protobuf::MessageExts
|
@@ -604,15 +604,15 @@ module Google
|
|
604
604
|
# Format: `projects/*/locations/*/restorePlans/*/restores/*`
|
605
605
|
# @!attribute [rw] page_size
|
606
606
|
# @return [::Integer]
|
607
|
-
# The target number of results to return in a single response.
|
607
|
+
# Optional. The target number of results to return in a single response.
|
608
608
|
# If not specified, a default value will be chosen by the service.
|
609
|
-
# Note that the response may
|
609
|
+
# Note that the response may include a partial list and a caller should
|
610
610
|
# only rely on the response's
|
611
611
|
# {::Google::Cloud::GkeBackup::V1::ListVolumeRestoresResponse#next_page_token next_page_token}
|
612
612
|
# to determine if there are more instances left to be queried.
|
613
613
|
# @!attribute [rw] page_token
|
614
614
|
# @return [::String]
|
615
|
-
# The value of
|
615
|
+
# Optional. The value of
|
616
616
|
# {::Google::Cloud::GkeBackup::V1::ListVolumeRestoresResponse#next_page_token next_page_token}
|
617
617
|
# received from a previous `ListVolumeRestores` call.
|
618
618
|
# Provide this to retrieve the subsequent page in a multi-page list of
|
@@ -620,10 +620,10 @@ module Google
|
|
620
620
|
# `ListVolumeRestores` must match the call that provided the page token.
|
621
621
|
# @!attribute [rw] filter
|
622
622
|
# @return [::String]
|
623
|
-
# Field match expression used to filter the results.
|
623
|
+
# Optional. Field match expression used to filter the results.
|
624
624
|
# @!attribute [rw] order_by
|
625
625
|
# @return [::String]
|
626
|
-
# Field by which to sort the results.
|
626
|
+
# Optional. Field by which to sort the results.
|
627
627
|
class ListVolumeRestoresRequest
|
628
628
|
include ::Google::Protobuf::MessageExts
|
629
629
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -654,6 +654,25 @@ module Google
|
|
654
654
|
include ::Google::Protobuf::MessageExts
|
655
655
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
656
656
|
end
|
657
|
+
|
658
|
+
# Request message for GetBackupIndexDownloadUrl.
|
659
|
+
# @!attribute [rw] backup
|
660
|
+
# @return [::String]
|
661
|
+
# Required. Full name of Backup resource.
|
662
|
+
# Format:
|
663
|
+
# projects/\\{project}/locations/\\{location}/backupPlans/\\{backup_plan}/backups/\\{backup}
|
664
|
+
class GetBackupIndexDownloadUrlRequest
|
665
|
+
include ::Google::Protobuf::MessageExts
|
666
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
667
|
+
end
|
668
|
+
|
669
|
+
# Response message for GetBackupIndexDownloadUrl.
|
670
|
+
# @!attribute [rw] signed_url
|
671
|
+
# @return [::String]
|
672
|
+
class GetBackupIndexDownloadUrlResponse
|
673
|
+
include ::Google::Protobuf::MessageExts
|
674
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
675
|
+
end
|
657
676
|
end
|
658
677
|
end
|
659
678
|
end
|
@@ -23,7 +23,6 @@ module Google
|
|
23
23
|
module V1
|
24
24
|
# Represents both a request to Restore some portion of a Backup into
|
25
25
|
# a target GKE cluster and a record of the restore operation itself.
|
26
|
-
# Next id: 18
|
27
26
|
# @!attribute [r] name
|
28
27
|
# @return [::String]
|
29
28
|
# Output only. The full name of the Restore resource.
|
@@ -140,28 +139,29 @@ module Google
|
|
140
139
|
end
|
141
140
|
|
142
141
|
# Configuration of a restore.
|
143
|
-
# Next id: 12
|
144
142
|
# @!attribute [rw] volume_data_restore_policy
|
145
143
|
# @return [::Google::Cloud::GkeBackup::V1::RestoreConfig::VolumeDataRestorePolicy]
|
146
|
-
# Specifies the mechanism to be used to restore volume data.
|
144
|
+
# Optional. Specifies the mechanism to be used to restore volume data.
|
147
145
|
# Default: VOLUME_DATA_RESTORE_POLICY_UNSPECIFIED (will be treated as
|
148
146
|
# NO_VOLUME_DATA_RESTORATION).
|
149
147
|
# @!attribute [rw] cluster_resource_conflict_policy
|
150
148
|
# @return [::Google::Cloud::GkeBackup::V1::RestoreConfig::ClusterResourceConflictPolicy]
|
151
|
-
# Defines the behavior for handling the situation where
|
152
|
-
# resources being restored already exist in the target
|
153
|
-
# set to a value other than
|
149
|
+
# Optional. Defines the behavior for handling the situation where
|
150
|
+
# cluster-scoped resources being restored already exist in the target
|
151
|
+
# cluster. This MUST be set to a value other than
|
152
|
+
# CLUSTER_RESOURCE_CONFLICT_POLICY_UNSPECIFIED if
|
154
153
|
# {::Google::Cloud::GkeBackup::V1::RestoreConfig#cluster_resource_restore_scope cluster_resource_restore_scope}
|
155
154
|
# is not empty.
|
156
155
|
# @!attribute [rw] namespaced_resource_restore_mode
|
157
156
|
# @return [::Google::Cloud::GkeBackup::V1::RestoreConfig::NamespacedResourceRestoreMode]
|
158
|
-
# Defines the behavior for handling the situation where sets of
|
159
|
-
# resources being restored already exist in the target cluster.
|
160
|
-
# set to a value other than
|
157
|
+
# Optional. Defines the behavior for handling the situation where sets of
|
158
|
+
# namespaced resources being restored already exist in the target cluster.
|
159
|
+
# This MUST be set to a value other than
|
160
|
+
# NAMESPACED_RESOURCE_RESTORE_MODE_UNSPECIFIED.
|
161
161
|
# @!attribute [rw] cluster_resource_restore_scope
|
162
162
|
# @return [::Google::Cloud::GkeBackup::V1::RestoreConfig::ClusterResourceRestoreScope]
|
163
|
-
# Identifies the cluster-scoped resources to restore from the
|
164
|
-
# Not specifying it means NO cluster resource will be restored.
|
163
|
+
# Optional. Identifies the cluster-scoped resources to restore from the
|
164
|
+
# Backup. Not specifying it means NO cluster resource will be restored.
|
165
165
|
# @!attribute [rw] all_namespaces
|
166
166
|
# @return [::Boolean]
|
167
167
|
# Restore all namespaced resources in the Backup if set to "True".
|
@@ -185,17 +185,17 @@ module Google
|
|
185
185
|
# namespaces except those in this list will be restored.
|
186
186
|
# @!attribute [rw] substitution_rules
|
187
187
|
# @return [::Array<::Google::Cloud::GkeBackup::V1::RestoreConfig::SubstitutionRule>]
|
188
|
-
# A list of transformation rules to be applied against Kubernetes
|
189
|
-
# as they are selected for restoration from a Backup. Rules are
|
190
|
-
# order defined - this order matters, as changes made by a rule
|
191
|
-
# the filtering logic of subsequent rules. An empty list means no
|
188
|
+
# Optional. A list of transformation rules to be applied against Kubernetes
|
189
|
+
# resources as they are selected for restoration from a Backup. Rules are
|
190
|
+
# executed in order defined - this order matters, as changes made by a rule
|
191
|
+
# may impact the filtering logic of subsequent rules. An empty list means no
|
192
192
|
# substitution will occur.
|
193
193
|
# @!attribute [rw] transformation_rules
|
194
194
|
# @return [::Array<::Google::Cloud::GkeBackup::V1::RestoreConfig::TransformationRule>]
|
195
|
-
# A list of transformation rules to be applied against Kubernetes
|
196
|
-
# as they are selected for restoration from a Backup. Rules are
|
197
|
-
# order defined - this order matters, as changes made by a rule
|
198
|
-
# the filtering logic of subsequent rules. An empty list means no
|
195
|
+
# Optional. A list of transformation rules to be applied against Kubernetes
|
196
|
+
# resources as they are selected for restoration from a Backup. Rules are
|
197
|
+
# executed in order defined - this order matters, as changes made by a rule
|
198
|
+
# may impact the filtering logic of subsequent rules. An empty list means no
|
199
199
|
# transformation will occur.
|
200
200
|
class RestoreConfig
|
201
201
|
include ::Google::Protobuf::MessageExts
|
@@ -206,13 +206,14 @@ module Google
|
|
206
206
|
# and is used for identifying specific "types" of resources to restore.
|
207
207
|
# @!attribute [rw] resource_group
|
208
208
|
# @return [::String]
|
209
|
-
# API group string of a Kubernetes resource, e.g.
|
209
|
+
# Optional. API group string of a Kubernetes resource, e.g.
|
210
210
|
# "apiextensions.k8s.io", "storage.k8s.io", etc.
|
211
211
|
# Note: use empty string for core API group
|
212
212
|
# @!attribute [rw] resource_kind
|
213
213
|
# @return [::String]
|
214
|
-
# Kind of a Kubernetes resource,
|
215
|
-
# "CustomResourceDefinition",
|
214
|
+
# Optional. Kind of a Kubernetes resource, must be in UpperCamelCase
|
215
|
+
# (PascalCase) and singular form. E.g. "CustomResourceDefinition",
|
216
|
+
# "StorageClass", etc.
|
216
217
|
class GroupKind
|
217
218
|
include ::Google::Protobuf::MessageExts
|
218
219
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -238,22 +239,22 @@ module Google
|
|
238
239
|
# - PersistentVolume
|
239
240
|
# @!attribute [rw] selected_group_kinds
|
240
241
|
# @return [::Array<::Google::Cloud::GkeBackup::V1::RestoreConfig::GroupKind>]
|
241
|
-
# A list of cluster-scoped resource group kinds to restore from
|
242
|
-
# backup. If specified, only the selected resources will be restored.
|
242
|
+
# Optional. A list of cluster-scoped resource group kinds to restore from
|
243
|
+
# the backup. If specified, only the selected resources will be restored.
|
243
244
|
# Mutually exclusive to any other field in the message.
|
244
245
|
# @!attribute [rw] excluded_group_kinds
|
245
246
|
# @return [::Array<::Google::Cloud::GkeBackup::V1::RestoreConfig::GroupKind>]
|
246
|
-
# A list of cluster-scoped resource group kinds to NOT restore
|
247
|
-
# backup. If specified, all valid cluster-scoped resources will be
|
247
|
+
# Optional. A list of cluster-scoped resource group kinds to NOT restore
|
248
|
+
# from the backup. If specified, all valid cluster-scoped resources will be
|
248
249
|
# restored except for those specified in the list.
|
249
250
|
# Mutually exclusive to any other field in the message.
|
250
251
|
# @!attribute [rw] all_group_kinds
|
251
252
|
# @return [::Boolean]
|
252
|
-
# If True, all valid cluster-scoped resources will be restored.
|
253
|
+
# Optional. If True, all valid cluster-scoped resources will be restored.
|
253
254
|
# Mutually exclusive to any other field in the message.
|
254
255
|
# @!attribute [rw] no_group_kinds
|
255
256
|
# @return [::Boolean]
|
256
|
-
# If True, no cluster-scoped resources will be restored.
|
257
|
+
# Optional. If True, no cluster-scoped resources will be restored.
|
257
258
|
# This has the same restore scope as if the message is not defined.
|
258
259
|
# Mutually exclusive to any other field in the message.
|
259
260
|
class ClusterResourceRestoreScope
|
@@ -266,8 +267,8 @@ module Google
|
|
266
267
|
# logic (which resources are subject to substitution) and substitution logic.
|
267
268
|
# @!attribute [rw] target_namespaces
|
268
269
|
# @return [::Array<::String>]
|
269
|
-
# (Filtering parameter) Any resource subject to substitution must
|
270
|
-
# contained within one of the listed Kubernetes Namespace in the Backup.
|
270
|
+
# Optional. (Filtering parameter) Any resource subject to substitution must
|
271
|
+
# be contained within one of the listed Kubernetes Namespace in the Backup.
|
271
272
|
# If this field is not provided, no namespace filtering will be performed
|
272
273
|
# (all resources in all Namespaces, including all cluster-scoped resources,
|
273
274
|
# will be candidates for substitution).
|
@@ -275,11 +276,10 @@ module Google
|
|
275
276
|
# empty string ("") as one of the target namespaces.
|
276
277
|
# @!attribute [rw] target_group_kinds
|
277
278
|
# @return [::Array<::Google::Cloud::GkeBackup::V1::RestoreConfig::GroupKind>]
|
278
|
-
# (Filtering parameter) Any resource subject to substitution must
|
279
|
-
# one of the listed "types".
|
280
|
-
#
|
281
|
-
#
|
282
|
-
# candidates for substitution).
|
279
|
+
# Optional. (Filtering parameter) Any resource subject to substitution must
|
280
|
+
# belong to one of the listed "types". If this field is not provided, no
|
281
|
+
# type filtering will be performed (all resources of all types matching
|
282
|
+
# previous filtering parameters will be candidates for substitution).
|
283
283
|
# @!attribute [rw] target_json_path
|
284
284
|
# @return [::String]
|
285
285
|
# Required. This is a [JSONPath]
|
@@ -291,7 +291,7 @@ module Google
|
|
291
291
|
# fields out of the candidate resources will be modified).
|
292
292
|
# @!attribute [rw] original_value_pattern
|
293
293
|
# @return [::String]
|
294
|
-
# (Filtering parameter) This is a [regular expression]
|
294
|
+
# Optional. (Filtering parameter) This is a [regular expression]
|
295
295
|
# (https://en.wikipedia.org/wiki/Regular_expression)
|
296
296
|
# that is compared against the fields matched by the target_json_path
|
297
297
|
# expression (and must also have passed the previous filters).
|
@@ -302,9 +302,10 @@ module Google
|
|
302
302
|
# value for this field will only match empty fields.
|
303
303
|
# @!attribute [rw] new_value
|
304
304
|
# @return [::String]
|
305
|
-
# This is the new value to set for any fields that pass the
|
306
|
-
# selection criteria. To remove a value from a Kubernetes
|
307
|
-
# leave this field unspecified, or set it to the empty
|
305
|
+
# Optional. This is the new value to set for any fields that pass the
|
306
|
+
# filtering and selection criteria. To remove a value from a Kubernetes
|
307
|
+
# resource, either leave this field unspecified, or set it to the empty
|
308
|
+
# string ("").
|
308
309
|
class SubstitutionRule
|
309
310
|
include ::Google::Protobuf::MessageExts
|
310
311
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -317,15 +318,15 @@ module Google
|
|
317
318
|
# Required. op specifies the operation to perform.
|
318
319
|
# @!attribute [rw] from_path
|
319
320
|
# @return [::String]
|
320
|
-
# A string containing a JSON Pointer value that references the
|
321
|
-
# the target document to move the value from.
|
321
|
+
# Optional. A string containing a JSON Pointer value that references the
|
322
|
+
# location in the target document to move the value from.
|
322
323
|
# @!attribute [rw] path
|
323
324
|
# @return [::String]
|
324
|
-
# A string containing a JSON-Pointer value that references a
|
325
|
-
# within the target document where the operation is performed.
|
325
|
+
# Optional. A string containing a JSON-Pointer value that references a
|
326
|
+
# location within the target document where the operation is performed.
|
326
327
|
# @!attribute [rw] value
|
327
328
|
# @return [::String]
|
328
|
-
# A string that specifies the desired value in string format to
|
329
|
+
# Optional. A string that specifies the desired value in string format to
|
329
330
|
# use for transformation.
|
330
331
|
class TransformationRuleAction
|
331
332
|
include ::Google::Protobuf::MessageExts
|
@@ -373,22 +374,20 @@ module Google
|
|
373
374
|
# restoration from a backup.
|
374
375
|
# @!attribute [rw] namespaces
|
375
376
|
# @return [::Array<::String>]
|
376
|
-
# (Filtering parameter) Any resource subject to transformation
|
377
|
-
# contained within one of the listed Kubernetes Namespace in the
|
378
|
-
# If this field is not provided, no namespace filtering will be
|
379
|
-
# (all resources in all Namespaces, including all cluster-scoped
|
380
|
-
# will be candidates for transformation).
|
381
|
-
# To mix cluster-scoped and namespaced resources in the same rule, use an
|
382
|
-
# empty string ("") as one of the target namespaces.
|
377
|
+
# Optional. (Filtering parameter) Any resource subject to transformation
|
378
|
+
# must be contained within one of the listed Kubernetes Namespace in the
|
379
|
+
# Backup. If this field is not provided, no namespace filtering will be
|
380
|
+
# performed (all resources in all Namespaces, including all cluster-scoped
|
381
|
+
# resources, will be candidates for transformation).
|
383
382
|
# @!attribute [rw] group_kinds
|
384
383
|
# @return [::Array<::Google::Cloud::GkeBackup::V1::RestoreConfig::GroupKind>]
|
385
|
-
# (Filtering parameter) Any resource subject to transformation
|
386
|
-
# to one of the listed "types". If this field is not provided,
|
387
|
-
# filtering will be performed (all resources of all types matching
|
388
|
-
# filtering parameters will be candidates for transformation).
|
384
|
+
# Optional. (Filtering parameter) Any resource subject to transformation
|
385
|
+
# must belong to one of the listed "types". If this field is not provided,
|
386
|
+
# no type filtering will be performed (all resources of all types matching
|
387
|
+
# previous filtering parameters will be candidates for transformation).
|
389
388
|
# @!attribute [rw] json_path
|
390
389
|
# @return [::String]
|
391
|
-
# This is a [JSONPath]
|
390
|
+
# Optional. This is a [JSONPath]
|
392
391
|
# (https://github.com/json-path/JsonPath/blob/master/README.md)
|
393
392
|
# expression that matches specific fields of candidate
|
394
393
|
# resources and it operates as a filtering parameter (resources that
|
@@ -410,13 +409,13 @@ module Google
|
|
410
409
|
# could affect the outcome of the second operation.
|
411
410
|
# @!attribute [rw] resource_filter
|
412
411
|
# @return [::Google::Cloud::GkeBackup::V1::RestoreConfig::ResourceFilter]
|
413
|
-
# This field is used to specify a set of fields that should be
|
414
|
-
# determine which resources in backup should be acted upon by the
|
415
|
-
# transformation rule actions, and this will ensure that only
|
416
|
-
# resources are affected by transformation rule actions.
|
412
|
+
# Optional. This field is used to specify a set of fields that should be
|
413
|
+
# used to determine which resources in backup should be acted upon by the
|
414
|
+
# supplied transformation rule actions, and this will ensure that only
|
415
|
+
# specific resources are affected by transformation rule actions.
|
417
416
|
# @!attribute [rw] description
|
418
417
|
# @return [::String]
|
419
|
-
# The description is a user specified string description of the
|
418
|
+
# Optional. The description is a user specified string description of the
|
420
419
|
# transformation rule.
|
421
420
|
class TransformationRule
|
422
421
|
include ::Google::Protobuf::MessageExts
|
@@ -23,7 +23,6 @@ module Google
|
|
23
23
|
module V1
|
24
24
|
# The configuration of a potential series of Restore operations to be performed
|
25
25
|
# against Backups belong to a particular BackupPlan.
|
26
|
-
# Next id: 13
|
27
26
|
# @!attribute [r] name
|
28
27
|
# @return [::String]
|
29
28
|
# Output only. The full name of the RestorePlan resource.
|
@@ -42,7 +41,7 @@ module Google
|
|
42
41
|
# updated.
|
43
42
|
# @!attribute [rw] description
|
44
43
|
# @return [::String]
|
45
|
-
# User specified descriptive string for this RestorePlan.
|
44
|
+
# Optional. User specified descriptive string for this RestorePlan.
|
46
45
|
# @!attribute [rw] backup_plan
|
47
46
|
# @return [::String]
|
48
47
|
# Required. Immutable. A reference to the
|
@@ -62,7 +61,7 @@ module Google
|
|
62
61
|
# Required. Configuration of Restores created via this RestorePlan.
|
63
62
|
# @!attribute [rw] labels
|
64
63
|
# @return [::Google::Protobuf::Map{::String => ::String}]
|
65
|
-
# A set of custom labels supplied by user.
|
64
|
+
# Optional. A set of custom labels supplied by user.
|
66
65
|
# @!attribute [r] etag
|
67
66
|
# @return [::String]
|
68
67
|
# Output only. `etag` is used for optimistic concurrency control as a way to
|
@@ -24,7 +24,6 @@ module Google
|
|
24
24
|
# Represents the backup of a specific persistent volume as a component of a
|
25
25
|
# Backup - both the record of the operation and a pointer to the underlying
|
26
26
|
# storage-specific artifacts.
|
27
|
-
# Next id: 14
|
28
27
|
# @!attribute [r] name
|
29
28
|
# @return [::String]
|
30
29
|
# Output only. The full name of the VolumeBackup resource.
|
@@ -126,7 +125,6 @@ module Google
|
|
126
125
|
end
|
127
126
|
|
128
127
|
# Represents the operation of restoring a volume from a VolumeBackup.
|
129
|
-
# Next id: 13
|
130
128
|
# @!attribute [r] name
|
131
129
|
# @return [::String]
|
132
130
|
# Output only. Full name of the VolumeRestore resource.
|