google-apis-gkebackup_v1 0.2.0 → 0.5.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -35,8 +35,8 @@ module Google
35
35
  # "audit_log_configs": [ ` "log_type": "DATA_READ" `, ` "log_type": "DATA_WRITE"
36
36
  # , "exempted_members": [ "user:aliya@example.com" ] ` ] ` ] ` For sampleservice,
37
37
  # this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also
38
- # exempts jose@example.com from DATA_READ logging, and aliya@example.com from
39
- # DATA_WRITE logging.
38
+ # exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com`
39
+ # from DATA_WRITE logging.
40
40
  class AuditConfig
41
41
  include Google::Apis::Core::Hashable
42
42
 
@@ -116,27 +116,26 @@ module Google
116
116
  # @return [String]
117
117
  attr_accessor :complete_time
118
118
 
119
- # Output only. cluster config backup size in bytes.
119
+ # Output only. The size of the config backup in bytes.
120
120
  # Corresponds to the JSON property `configBackupSizeBytes`
121
121
  # @return [Fixnum]
122
122
  attr_accessor :config_backup_size_bytes
123
123
 
124
- # Output only. Whether or not the Backup contains Kubernetes Secrets. Inherited
125
- # from the parent BackupPlan's backup_config.include_secrets.
124
+ # Output only. Whether or not the Backup contains Kubernetes Secrets. Controlled
125
+ # by the parent BackupPlan's include_secrets value.
126
126
  # Corresponds to the JSON property `containsSecrets`
127
127
  # @return [Boolean]
128
128
  attr_accessor :contains_secrets
129
129
  alias_method :contains_secrets?, :contains_secrets
130
130
 
131
- # Output only. Whether or not the Backup contains volume data. Inherited from
132
- # the parent BackupPlan's backup_config.include_volume_data.
131
+ # Output only. Whether or not the Backup contains volume data. Controlled by the
132
+ # parent BackupPlan's include_volume_data value.
133
133
  # Corresponds to the JSON property `containsVolumeData`
134
134
  # @return [Boolean]
135
135
  attr_accessor :contains_volume_data
136
136
  alias_method :contains_volume_data?, :contains_volume_data
137
137
 
138
- # Output only. [Output Only] The timestamp when this Backup resource was created
139
- # - can be converted to and from [RFC3339](https://www.ietf.org/rfc/rfc3339.txt)
138
+ # Output only. The timestamp when this Backup resource was created.
140
139
  # Corresponds to the JSON property `createTime`
141
140
  # @return [String]
142
141
  attr_accessor :create_time
@@ -144,11 +143,9 @@ module Google
144
143
  # Minimum age for this Backup (in days). If this field is set to a non-zero
145
144
  # value, the Backup will be "locked" against deletion (either manual or
146
145
  # automatic deletion) for the number of days provided (measured from the
147
- # creation time of the Backup). This value is inherited from the parent
148
- # BackupPlan's retention_policy.backup_delete_lock_days value and may only be
149
- # increased (either at creation time or in a subsequent update). This field MUST
150
- # be an integer value between 0-90 (inclusive). Default: inherited from
151
- # BackupPlan.
146
+ # creation time of the Backup). MUST be an integer value between 0-90 (inclusive)
147
+ # . Defaults to parent BackupPlan's backup_delete_lock_days setting and may only
148
+ # be increased (either at creation time or in a subsequent update).
152
149
  # Corresponds to the JSON property `deleteLockDays`
153
150
  # @return [Fixnum]
154
151
  attr_accessor :delete_lock_days
@@ -175,8 +172,8 @@ module Google
175
172
  # is strongly suggested that systems make use of the `etag` in the read-modify-
176
173
  # write cycle to perform backup updates in order to avoid race conditions: An `
177
174
  # etag` is returned in the response to `GetBackup`, and systems are expected to
178
- # put that etag in the request to `UpdateBackup` to ensure that their change
179
- # will be applied to the same version.
175
+ # put that etag in the request to `UpdateBackup` or `DeleteBackup` to ensure
176
+ # that their change will be applied to the same version of the resource.
180
177
  # Corresponds to the JSON property `etag`
181
178
  # @return [String]
182
179
  attr_accessor :etag
@@ -210,12 +207,11 @@ module Google
210
207
  # @return [Fixnum]
211
208
  attr_accessor :resource_count
212
209
 
213
- # The age (in days) after which this Backup will be automatically deleted. If
214
- # not specified at Backup creation time, this value is inherited from the parent
215
- # BackupPlan's retention_policy.backup_retain_days value. Once a Backup is
216
- # created, this value may only be increased. This must be an integer value >= 0.
217
- # If 0, no automatic deletion will occur for this Backup. If not 0, this must be
218
- # >= delete_lock_days. Default: inherited from BackupPlan.
210
+ # The age (in days) after which this Backup will be automatically deleted. Must
211
+ # be an integer value >= 0: - If 0, no automatic deletion will occur for this
212
+ # Backup. - If not 0, this must be >= delete_lock_days. Once a Backup is created,
213
+ # this value may only be increased. Defaults to the parent BackupPlan's
214
+ # backup_retain_days value.
219
215
  # Corresponds to the JSON property `retainDays`
220
216
  # @return [Fixnum]
221
217
  attr_accessor :retain_days
@@ -253,15 +249,13 @@ module Google
253
249
  # @return [String]
254
250
  attr_accessor :state_reason
255
251
 
256
- # Output only. [Output Only] Server generated global unique identifier of [UUID4]
257
- # (https://en.wikipedia.org/wiki/Universally_unique_identifier)
252
+ # Output only. Server generated global unique identifier of [UUID4](https://en.
253
+ # wikipedia.org/wiki/Universally_unique_identifier)
258
254
  # Corresponds to the JSON property `uid`
259
255
  # @return [String]
260
256
  attr_accessor :uid
261
257
 
262
- # Output only. [Output Only] The timestamp when this Backup resource was last
263
- # updated - can be converted to and from [RFC3339](https://www.ietf.org/rfc/
264
- # rfc3339.txt)
258
+ # Output only. The timestamp when this Backup resource was last updated.
265
259
  # Corresponds to the JSON property `updateTime`
266
260
  # @return [String]
267
261
  attr_accessor :update_time
@@ -378,24 +372,22 @@ module Google
378
372
  attr_accessor :backup_schedule
379
373
 
380
374
  # Required. Immutable. The source cluster from which Backups will be created via
381
- # this BackupPlan. Possible formats: 1. projects/*/locations/*/clusters/* 2.
382
- # projects/*/zones/*/clusters/*
375
+ # this BackupPlan. Valid formats: - projects/*/locations/*/clusters/* - projects/
376
+ # */zones/*/clusters/*
383
377
  # Corresponds to the JSON property `cluster`
384
378
  # @return [String]
385
379
  attr_accessor :cluster
386
380
 
387
- # Output only. [Output Only] The timestamp when this BackupPlan resource was
388
- # created - can be converted to and from [RFC3339](https://www.ietf.org/rfc/
389
- # rfc3339.txt)
381
+ # Output only. The timestamp when this BackupPlan resource was created.
390
382
  # Corresponds to the JSON property `createTime`
391
383
  # @return [String]
392
384
  attr_accessor :create_time
393
385
 
394
386
  # This flag indicates whether this BackupPlan has been deactivated. Setting this
395
387
  # field to True locks the BackupPlan such that no further updates will be
396
- # allowed, including the deactivated field. It also prevents any new Backups
397
- # from being created via this BackupPlan (including scheduled Backups). Default:
398
- # False
388
+ # allowed (except deletes), including the deactivated field itself. It also
389
+ # prevents any new Backups from being created via this BackupPlan (including
390
+ # scheduled Backups). Default: False
399
391
  # Corresponds to the JSON property `deactivated`
400
392
  # @return [Boolean]
401
393
  attr_accessor :deactivated
@@ -411,8 +403,9 @@ module Google
411
403
  # It is strongly suggested that systems make use of the 'etag' in the read-
412
404
  # modify-write cycle to perform BackupPlan updates in order to avoid race
413
405
  # conditions: An `etag` is returned in the response to `GetBackupPlan`, and
414
- # systems are expected to put that etag in the request to `UpdateBackupPlan` to
415
- # ensure that their change will be applied to the same version.
406
+ # systems are expected to put that etag in the request to `UpdateBackupPlan` or `
407
+ # DeleteBackupPlan` to ensure that their change will be applied to the same
408
+ # version of the resource.
416
409
  # Corresponds to the JSON property `etag`
417
410
  # @return [String]
418
411
  attr_accessor :etag
@@ -422,36 +415,30 @@ module Google
422
415
  # @return [Hash<String,String>]
423
416
  attr_accessor :labels
424
417
 
425
- # Output only. [Output Only] The full name of the BackupPlan resource. Format:
426
- # projects/*/locations/*/backupPlans/*
418
+ # Output only. The full name of the BackupPlan resource. Format: projects/*/
419
+ # locations/*/backupPlans/*
427
420
  # Corresponds to the JSON property `name`
428
421
  # @return [String]
429
422
  attr_accessor :name
430
423
 
431
- # Output only. [Output Only] Represents the number of Kubernetes Pods backed up
432
- # in the last successful Backup created underneath this BackupPlan.
424
+ # Output only. The number of Kubernetes Pods backed up in the last successful
425
+ # Backup created via this BackupPlan.
433
426
  # Corresponds to the JSON property `protectedPodCount`
434
427
  # @return [Fixnum]
435
428
  attr_accessor :protected_pod_count
436
429
 
437
- # RentionPolicy is an inner message type to define: 1. Minimum age for Backups
438
- # created via this BackupPlan - deletion (either manual or automatic) of Backups
439
- # younger than this age will be blocked 2. Default maximum age of Backups
440
- # created via this BackupPlan, after which automatic deletion will occur 3. Lock
441
- # to disallow any changes to any RetentionPolicy settings
430
+ # RetentionPolicy defines a Backup retention policy for a BackupPlan.
442
431
  # Corresponds to the JSON property `retentionPolicy`
443
432
  # @return [Google::Apis::GkebackupV1::RetentionPolicy]
444
433
  attr_accessor :retention_policy
445
434
 
446
- # Output only. [Output Only] Server generated global unique identifier of [UUID](
447
- # https://en.wikipedia.org/wiki/Universally_unique_identifier) format.
435
+ # Output only. Server generated global unique identifier of [UUID](https://en.
436
+ # wikipedia.org/wiki/Universally_unique_identifier) format.
448
437
  # Corresponds to the JSON property `uid`
449
438
  # @return [String]
450
439
  attr_accessor :uid
451
440
 
452
- # Output only. [Output Only] The timestamp when this BackupPlan resource was
453
- # last updated - can be converted to and from [RFC3339](https://www.ietf.org/rfc/
454
- # rfc3339.txt)
441
+ # Output only. The timestamp when this BackupPlan resource was last updated.
455
442
  # Corresponds to the JSON property `updateTime`
456
443
  # @return [String]
457
444
  attr_accessor :update_time
@@ -563,9 +550,9 @@ module Google
563
550
  # @return [Hash<String,String>]
564
551
  attr_accessor :backup_crd_versions
565
552
 
566
- # The source cluster from which this Backup was created. Possible formats: 1.
567
- # projects/*/locations/*/clusters/* 2. projects/*/zones/*/clusters/* This will
568
- # be the same value as the parent BackupPlan's cluster field.
553
+ # The source cluster from which this Backup was created. Valid formats: -
554
+ # projects/*/locations/*/clusters/* - projects/*/zones/*/clusters/* This is
555
+ # inherited from the parent BackupPlan's cluster field.
569
556
  # Corresponds to the JSON property `cluster`
570
557
  # @return [String]
571
558
  attr_accessor :cluster
@@ -637,8 +624,8 @@ module Google
637
624
  class EncryptionKey
638
625
  include Google::Apis::Core::Hashable
639
626
 
640
- # Google Cloud KMS encryption key. Format: projects//locations//keyRings//
641
- # cryptoKeys/
627
+ # Google Cloud KMS encryption key. Format: projects/*/locations/*/keyRings/*/
628
+ # cryptoKeys/*
642
629
  # Corresponds to the JSON property `gcpKmsEncryptionKey`
643
630
  # @return [String]
644
631
  attr_accessor :gcp_kms_encryption_key
@@ -879,14 +866,14 @@ module Google
879
866
  class ListBackupPlansResponse
880
867
  include Google::Apis::Core::Hashable
881
868
 
882
- # The list of BackupPlans.
869
+ # The list of BackupPlans matching the given criteria.
883
870
  # Corresponds to the JSON property `backupPlans`
884
871
  # @return [Array<Google::Apis::GkebackupV1::BackupPlan>]
885
872
  attr_accessor :backup_plans
886
873
 
887
- # A token which may be sent as `page_token` in a subsequent `ListBackupPlans`
888
- # call to retrieve the next page of results. If this field is omitted or empty,
889
- # then there are no more results to return.
874
+ # A token which may be sent as page_token in a subsequent `ListBackupPlans` call
875
+ # to retrieve the next page of results. If this field is omitted or empty, then
876
+ # there are no more results to return.
890
877
  # Corresponds to the JSON property `nextPageToken`
891
878
  # @return [String]
892
879
  attr_accessor :next_page_token
@@ -912,13 +899,13 @@ module Google
912
899
  class ListBackupsResponse
913
900
  include Google::Apis::Core::Hashable
914
901
 
915
- # The list of restore resources within the parent.
902
+ # The list of Backups matching the given criteria.
916
903
  # Corresponds to the JSON property `backups`
917
904
  # @return [Array<Google::Apis::GkebackupV1::Backup>]
918
905
  attr_accessor :backups
919
906
 
920
- # A token which may be sent as `page_token` in a subsequent `ListBackups` call
921
- # to retrieve the next page of results. If this field is omitted or empty, then
907
+ # A token which may be sent as page_token in a subsequent `ListBackups` call to
908
+ # retrieve the next page of results. If this field is omitted or empty, then
922
909
  # there are no more results to return.
923
910
  # Corresponds to the JSON property `nextPageToken`
924
911
  # @return [String]
@@ -964,14 +951,14 @@ module Google
964
951
  class ListRestorePlansResponse
965
952
  include Google::Apis::Core::Hashable
966
953
 
967
- # A token which may be sent as `page_token` in a subsequent `ListRestorePlans`
954
+ # A token which may be sent as page_token in a subsequent `ListRestorePlans`
968
955
  # call to retrieve the next page of results. If this field is omitted or empty,
969
956
  # then there are no more results to return.
970
957
  # Corresponds to the JSON property `nextPageToken`
971
958
  # @return [String]
972
959
  attr_accessor :next_page_token
973
960
 
974
- # The list of RestorePlans.
961
+ # The list of RestorePlans matching the given criteria.
975
962
  # Corresponds to the JSON property `restorePlans`
976
963
  # @return [Array<Google::Apis::GkebackupV1::RestorePlan>]
977
964
  attr_accessor :restore_plans
@@ -997,14 +984,14 @@ module Google
997
984
  class ListRestoresResponse
998
985
  include Google::Apis::Core::Hashable
999
986
 
1000
- # A token which may be sent as `page_token` in a subsequent `ListRestores` call
1001
- # to retrieve the next page of results. If this field is omitted or empty, then
987
+ # A token which may be sent as page_token in a subsequent `ListRestores` call to
988
+ # retrieve the next page of results. If this field is omitted or empty, then
1002
989
  # there are no more results to return.
1003
990
  # Corresponds to the JSON property `nextPageToken`
1004
991
  # @return [String]
1005
992
  attr_accessor :next_page_token
1006
993
 
1007
- # The list of restore resources within the parent.
994
+ # The list of Restores matching the given criteria.
1008
995
  # Corresponds to the JSON property `restores`
1009
996
  # @return [Array<Google::Apis::GkebackupV1::Restore>]
1010
997
  attr_accessor :restores
@@ -1030,14 +1017,14 @@ module Google
1030
1017
  class ListVolumeBackupsResponse
1031
1018
  include Google::Apis::Core::Hashable
1032
1019
 
1033
- # A token which may be sent as `page_token` in a subsequent `ListVolumeBackups`
1020
+ # A token which may be sent as page_token in a subsequent `ListVolumeBackups`
1034
1021
  # call to retrieve the next page of results. If this field is omitted or empty,
1035
1022
  # then there are no more results to return.
1036
1023
  # Corresponds to the JSON property `nextPageToken`
1037
1024
  # @return [String]
1038
1025
  attr_accessor :next_page_token
1039
1026
 
1040
- # The list of VolumeBackups resources within the parent.
1027
+ # The list of VolumeBackups matching the given criteria.
1041
1028
  # Corresponds to the JSON property `volumeBackups`
1042
1029
  # @return [Array<Google::Apis::GkebackupV1::VolumeBackup>]
1043
1030
  attr_accessor :volume_backups
@@ -1057,14 +1044,14 @@ module Google
1057
1044
  class ListVolumeRestoresResponse
1058
1045
  include Google::Apis::Core::Hashable
1059
1046
 
1060
- # A token which may be sent as `page_token` in a subsequent `ListVolumeRestores`
1047
+ # A token which may be sent as page_token in a subsequent `ListVolumeRestores`
1061
1048
  # call to retrieve the next page of results. If this field is omitted or empty,
1062
1049
  # then there are no more results to return.
1063
1050
  # Corresponds to the JSON property `nextPageToken`
1064
1051
  # @return [String]
1065
1052
  attr_accessor :next_page_token
1066
1053
 
1067
- # The list of VolumeRestores resources within the parent.
1054
+ # The list of VolumeRestores matching the given criteria.
1068
1055
  # Corresponds to the JSON property `volumeRestores`
1069
1056
  # @return [Array<Google::Apis::GkebackupV1::VolumeRestore>]
1070
1057
  attr_accessor :volume_restores
@@ -1349,29 +1336,27 @@ module Google
1349
1336
  class Restore
1350
1337
  include Google::Apis::Core::Hashable
1351
1338
 
1352
- # Required. Immutable. The Backup used as the source from which this Restore
1353
- # will restore. Note that this Backup must be a sub-resource of the RestorePlan'
1354
- # s backup_plan. Format: projects/*/locations/*/backupPlans/*/backups/*.
1339
+ # Required. Immutable. A reference to the Backup used as the source from which
1340
+ # this Restore will restore. Note that this Backup must be a sub-resource of the
1341
+ # RestorePlan's backup_plan. Format: projects/*/locations/*/backupPlans/*/
1342
+ # backups/*.
1355
1343
  # Corresponds to the JSON property `backup`
1356
1344
  # @return [String]
1357
1345
  attr_accessor :backup
1358
1346
 
1359
1347
  # Output only. The target cluster into which this Restore will restore data.
1360
- # Possible formats: 1. projects/*/locations/*/clusters/* 2. projects/*/zones/*/
1361
- # clusters/* Inherited from parent RestorePlan's cluster field.
1348
+ # Valid formats: - projects/*/locations/*/clusters/* - projects/*/zones/*/
1349
+ # clusters/* Inherited from parent RestorePlan's cluster value.
1362
1350
  # Corresponds to the JSON property `cluster`
1363
1351
  # @return [String]
1364
1352
  attr_accessor :cluster
1365
1353
 
1366
- # Output only. When the restore operation either successfully completed or
1367
- # failed.
1354
+ # Output only. Timestamp of when the restore operation completed.
1368
1355
  # Corresponds to the JSON property `completeTime`
1369
1356
  # @return [String]
1370
1357
  attr_accessor :complete_time
1371
1358
 
1372
- # Output only. [Output Only] The timestamp when this Restore resource was
1373
- # created - can be converted to and from [RFC3339](https://www.ietf.org/rfc/
1374
- # rfc3339.txt)
1359
+ # Output only. The timestamp when this Restore resource was created.
1375
1360
  # Corresponds to the JSON property `createTime`
1376
1361
  # @return [String]
1377
1362
  attr_accessor :create_time
@@ -1386,13 +1371,13 @@ module Google
1386
1371
  # is strongly suggested that systems make use of the `etag` in the read-modify-
1387
1372
  # write cycle to perform restore updates in order to avoid race conditions: An `
1388
1373
  # etag` is returned in the response to `GetRestore`, and systems are expected to
1389
- # put that etag in the request to `UpdateRestore` to ensure that their change
1390
- # will be applied to the same version.
1374
+ # put that etag in the request to `UpdateRestore` or `DeleteRestore` to ensure
1375
+ # that their change will be applied to the same version of the resource.
1391
1376
  # Corresponds to the JSON property `etag`
1392
1377
  # @return [String]
1393
1378
  attr_accessor :etag
1394
1379
 
1395
- # GCP Labels.
1380
+ # A set of custom labels supplied by user.
1396
1381
  # Corresponds to the JSON property `labels`
1397
1382
  # @return [Hash<String,String>]
1398
1383
  attr_accessor :labels
@@ -1403,17 +1388,18 @@ module Google
1403
1388
  # @return [String]
1404
1389
  attr_accessor :name
1405
1390
 
1406
- # Output only. Number of resources excluded in this restore action.
1391
+ # Output only. Number of resources excluded during the restore execution.
1407
1392
  # Corresponds to the JSON property `resourcesExcludedCount`
1408
1393
  # @return [Fixnum]
1409
1394
  attr_accessor :resources_excluded_count
1410
1395
 
1411
- # Output only. Number of resources failed to be restored in this restore action.
1396
+ # Output only. Number of resources that failed to be restored during the restore
1397
+ # execution.
1412
1398
  # Corresponds to the JSON property `resourcesFailedCount`
1413
1399
  # @return [Fixnum]
1414
1400
  attr_accessor :resources_failed_count
1415
1401
 
1416
- # Output only. Number of resources restored in this restore action.
1402
+ # Output only. Number of resources restored during the restore execution.
1417
1403
  # Corresponds to the JSON property `resourcesRestoredCount`
1418
1404
  # @return [Fixnum]
1419
1405
  attr_accessor :resources_restored_count
@@ -1434,20 +1420,18 @@ module Google
1434
1420
  # @return [String]
1435
1421
  attr_accessor :state_reason
1436
1422
 
1437
- # Output only. [Output Only] Server generated global unique identifier of [UUID](
1438
- # https://en.wikipedia.org/wiki/Universally_unique_identifier) format.
1423
+ # Output only. Server generated global unique identifier of [UUID](https://en.
1424
+ # wikipedia.org/wiki/Universally_unique_identifier) format.
1439
1425
  # Corresponds to the JSON property `uid`
1440
1426
  # @return [String]
1441
1427
  attr_accessor :uid
1442
1428
 
1443
- # Output only. [Output Only] The timestamp when this Restore resource was last
1444
- # updated - can be converted to and from [RFC3339](https://www.ietf.org/rfc/
1445
- # rfc3339.txt)
1429
+ # Output only. The timestamp when this Restore resource was last updated.
1446
1430
  # Corresponds to the JSON property `updateTime`
1447
1431
  # @return [String]
1448
1432
  attr_accessor :update_time
1449
1433
 
1450
- # Output only. Number of volumes restored in this restore action.
1434
+ # Output only. Number of volumes restored during the restore execution.
1451
1435
  # Corresponds to the JSON property `volumesRestoredCount`
1452
1436
  # @return [Fixnum]
1453
1437
  attr_accessor :volumes_restored_count
@@ -1504,8 +1488,7 @@ module Google
1504
1488
 
1505
1489
  # Defines the behavior for handling the situation where sets of namespaced
1506
1490
  # resources being restored already exist in the target cluster. This MUST be set
1507
- # to a value other than NAMESPACED_RESOURCE_RESTORE_MODE_UNSPECIFIED if any
1508
- # namespaced restoration is configured via namespaced_resource_restore_scope .
1491
+ # to a value other than NAMESPACED_RESOURCE_RESTORE_MODE_UNSPECIFIED.
1509
1492
  # Corresponds to the JSON property `namespacedResourceRestoreMode`
1510
1493
  # @return [String]
1511
1494
  attr_accessor :namespaced_resource_restore_mode
@@ -1558,24 +1541,22 @@ module Google
1558
1541
  class RestorePlan
1559
1542
  include Google::Apis::Core::Hashable
1560
1543
 
1561
- # Required. Immutable. The BackupPlan from which Backups may be used as the
1562
- # source for Restores created via this RestorePlan. Format: projects/*/locations/
1563
- # */backupPlans/*.
1544
+ # Required. Immutable. A reference to the BackupPlan from which Backups may be
1545
+ # used as the source for Restores created via this RestorePlan. Format: projects/
1546
+ # */locations/*/backupPlans/*.
1564
1547
  # Corresponds to the JSON property `backupPlan`
1565
1548
  # @return [String]
1566
1549
  attr_accessor :backup_plan
1567
1550
 
1568
1551
  # Required. Immutable. The target cluster into which Restores created via this
1569
1552
  # RestorePlan will restore data. NOTE: the cluster's region must be the same as
1570
- # the RestorePlan. Possible formats: 1. projects/*/locations/*/clusters/* 2.
1571
- # projects/*/zones/*/clusters/*
1553
+ # the RestorePlan. Valid formats: - projects/*/locations/*/clusters/* - projects/
1554
+ # */zones/*/clusters/*
1572
1555
  # Corresponds to the JSON property `cluster`
1573
1556
  # @return [String]
1574
1557
  attr_accessor :cluster
1575
1558
 
1576
- # Output only. [Output Only] The timestamp when this RestorePlan resource was
1577
- # created - can be converted to and from [RFC3339](https://www.ietf.org/rfc/
1578
- # rfc3339.txt)
1559
+ # Output only. The timestamp when this RestorePlan resource was created.
1579
1560
  # Corresponds to the JSON property `createTime`
1580
1561
  # @return [String]
1581
1562
  attr_accessor :create_time
@@ -1590,8 +1571,9 @@ module Google
1590
1571
  # is strongly suggested that systems make use of the `etag` in the read-modify-
1591
1572
  # write cycle to perform restore updates in order to avoid race conditions: An `
1592
1573
  # etag` is returned in the response to `GetRestorePlan`, and systems are
1593
- # expected to put that etag in the request to `UpdateRestorePlan` to ensure that
1594
- # their change will be applied to the same version.
1574
+ # expected to put that etag in the request to `UpdateRestorePlan` or `
1575
+ # DeleteRestorePlan` to ensure that their change will be applied to the same
1576
+ # version of the resource.
1595
1577
  # Corresponds to the JSON property `etag`
1596
1578
  # @return [String]
1597
1579
  attr_accessor :etag
@@ -1601,8 +1583,8 @@ module Google
1601
1583
  # @return [Hash<String,String>]
1602
1584
  attr_accessor :labels
1603
1585
 
1604
- # Output only. [Output Only] The full name of the RestorePlan resource. Format:
1605
- # projects/*/locations/*/restorePlans/*
1586
+ # Output only. The full name of the RestorePlan resource. Format: projects/*/
1587
+ # locations/*/restorePlans/*.
1606
1588
  # Corresponds to the JSON property `name`
1607
1589
  # @return [String]
1608
1590
  attr_accessor :name
@@ -1612,15 +1594,13 @@ module Google
1612
1594
  # @return [Google::Apis::GkebackupV1::RestoreConfig]
1613
1595
  attr_accessor :restore_config
1614
1596
 
1615
- # Output only. [Output Only] Server generated global unique identifier of [UUID](
1616
- # https://en.wikipedia.org/wiki/Universally_unique_identifier) format.
1597
+ # Output only. Server generated global unique identifier of [UUID](https://en.
1598
+ # wikipedia.org/wiki/Universally_unique_identifier) format.
1617
1599
  # Corresponds to the JSON property `uid`
1618
1600
  # @return [String]
1619
1601
  attr_accessor :uid
1620
1602
 
1621
- # Output only. [Output Only] The timestamp when this RestorePlan resource was
1622
- # last updated - can be converted to and from [RFC3339](https://www.ietf.org/rfc/
1623
- # rfc3339.txt)
1603
+ # Output only. The timestamp when this RestorePlan resource was last updated.
1624
1604
  # Corresponds to the JSON property `updateTime`
1625
1605
  # @return [String]
1626
1606
  attr_accessor :update_time
@@ -1644,18 +1624,14 @@ module Google
1644
1624
  end
1645
1625
  end
1646
1626
 
1647
- # RentionPolicy is an inner message type to define: 1. Minimum age for Backups
1648
- # created via this BackupPlan - deletion (either manual or automatic) of Backups
1649
- # younger than this age will be blocked 2. Default maximum age of Backups
1650
- # created via this BackupPlan, after which automatic deletion will occur 3. Lock
1651
- # to disallow any changes to any RetentionPolicy settings
1627
+ # RetentionPolicy defines a Backup retention policy for a BackupPlan.
1652
1628
  class RetentionPolicy
1653
1629
  include Google::Apis::Core::Hashable
1654
1630
 
1655
1631
  # Minimum age for Backups created via this BackupPlan (in days). This field MUST
1656
- # be an integer value between 0-90(inclusive). A Backup created under this
1657
- # BackupPlan will NOT be deletable until it reaches Backup's create_time +
1658
- # backup_delete_lock_days. Updating this field of a BackupPlan does NOT affect
1632
+ # be an integer value between 0-90 (inclusive). A Backup created under this
1633
+ # BackupPlan will NOT be deletable until it reaches Backup's (create_time +
1634
+ # backup_delete_lock_days). Updating this field of a BackupPlan does NOT affect
1659
1635
  # existing Backups under it. Backups created AFTER a successful update will
1660
1636
  # inherit the new value. Default: 0 (no delete blocking)
1661
1637
  # Corresponds to the JSON property `backupDeleteLockDays`
@@ -1664,14 +1640,12 @@ module Google
1664
1640
 
1665
1641
  # The default maximum age of a Backup created via this BackupPlan. This field
1666
1642
  # MUST be an integer value >= 0. If specified, a Backup created under this
1667
- # BackupPlan will be automatically deleted after its age reaches create_time +
1668
- # backup_retain_days. If not specified, Backups created under this BackupPlan
1643
+ # BackupPlan will be automatically deleted after its age reaches (create_time +
1644
+ # backup_retain_days). If not specified, Backups created under this BackupPlan
1669
1645
  # will NOT be subject to automatic deletion. Updating this field does NOT affect
1670
1646
  # existing Backups under it. Backups created AFTER a successful update will
1671
- # automatically pick up the new value. NOTE: Specifying a backup_retain_days
1672
- # smaller than backup_delete_lock_days at creation/updating time will be
1673
- # considered as invalid, and the request will be rejected immediately. Default:
1674
- # 0 (no automatic deletion)
1647
+ # automatically pick up the new value. NOTE: backup_retain_days must be >=
1648
+ # backup_delete_lock_days. Default: 0 (no automatic deletion)
1675
1649
  # Corresponds to the JSON property `backupRetainDays`
1676
1650
  # @return [Fixnum]
1677
1651
  attr_accessor :backup_retain_days
@@ -1701,8 +1675,9 @@ module Google
1701
1675
  class Schedule
1702
1676
  include Google::Apis::Core::Hashable
1703
1677
 
1704
- # A standard cron-style string that defines a repeating schedule for creating
1705
- # Backups via this BackupPlan.
1678
+ # A standard [cron](https://wikipedia.com/wiki/cron) string that defines a
1679
+ # repeating schedule for creating Backups via this BackupPlan. Default (empty):
1680
+ # no automatic backup creation will occur.
1706
1681
  # Corresponds to the JSON property `cronSchedule`
1707
1682
  # @return [String]
1708
1683
  attr_accessor :cron_schedule
@@ -1891,16 +1866,13 @@ module Google
1891
1866
  class VolumeBackup
1892
1867
  include Google::Apis::Core::Hashable
1893
1868
 
1894
- # Output only. [Output Only] The timestamp when the associated underlying volume
1895
- # backup operation completes - can be converted to and from [RFC3339](https://
1896
- # www.ietf.org/rfc/rfc3339.txt)
1869
+ # Output only. The timestamp when the associated underlying volume backup
1870
+ # operation completed.
1897
1871
  # Corresponds to the JSON property `completeTime`
1898
1872
  # @return [String]
1899
1873
  attr_accessor :complete_time
1900
1874
 
1901
- # Output only. [Output Only] The timestamp when this VolumeBackup resource was
1902
- # created - can be converted to and from [RFC3339](https://www.ietf.org/rfc/
1903
- # rfc3339.txt)
1875
+ # Output only. The timestamp when this VolumeBackup resource was created.
1904
1876
  # Corresponds to the JSON property `createTime`
1905
1877
  # @return [String]
1906
1878
  attr_accessor :create_time
@@ -1915,10 +1887,7 @@ module Google
1915
1887
  # help prevent simultaneous updates of a volume backup from overwriting each
1916
1888
  # other. It is strongly suggested that systems make use of the `etag` in the
1917
1889
  # read-modify-write cycle to perform volume backup updates in order to avoid
1918
- # race conditions: An `etag` is returned in the response to `GetVolumeBackup',
1919
- # and systems are expected to put that etag in the request to `
1920
- # UpdateVolumeBackup` to ensure that their change will be applied to the same
1921
- # version.
1890
+ # race conditions.
1922
1891
  # Corresponds to the JSON property `etag`
1923
1892
  # @return [String]
1924
1893
  attr_accessor :etag
@@ -1928,9 +1897,8 @@ module Google
1928
1897
  # @return [String]
1929
1898
  attr_accessor :format
1930
1899
 
1931
- # Output only. [Output Only] The full name of the VolumeBackup resource. Format:
1932
- # projects/*/locations/*/backupPlans/*/backups/*/volumeBackups/* Note that the
1933
- # last segment of the name will have the format: 'pvc-'.
1900
+ # Output only. The full name of the VolumeBackup resource. Format: projects/*/
1901
+ # locations/*/backupPlans/*/backups/*/volumeBackups/*.
1934
1902
  # Corresponds to the JSON property `name`
1935
1903
  # @return [String]
1936
1904
  attr_accessor :name
@@ -1960,22 +1928,19 @@ module Google
1960
1928
  # @return [Fixnum]
1961
1929
  attr_accessor :storage_bytes
1962
1930
 
1963
- # Output only. [Output Only] Server generated global unique identifier of [UUID](
1964
- # https://en.wikipedia.org/wiki/Universally_unique_identifier) format.
1931
+ # Output only. Server generated global unique identifier of [UUID](https://en.
1932
+ # wikipedia.org/wiki/Universally_unique_identifier) format.
1965
1933
  # Corresponds to the JSON property `uid`
1966
1934
  # @return [String]
1967
1935
  attr_accessor :uid
1968
1936
 
1969
- # Output only. [Output Only] The timestamp when this VolumeBackup resource was
1970
- # last updated - can be converted to and from [RFC3339](https://www.ietf.org/rfc/
1971
- # rfc3339.txt)
1937
+ # Output only. The timestamp when this VolumeBackup resource was last updated.
1972
1938
  # Corresponds to the JSON property `updateTime`
1973
1939
  # @return [String]
1974
1940
  attr_accessor :update_time
1975
1941
 
1976
1942
  # Output only. A storage system-specific opaque handle to the underlying volume
1977
- # backup. This field is interpreted by the volume backup and restore drivers
1978
- # running in the GKE cluster and not by the service.
1943
+ # backup.
1979
1944
  # Corresponds to the JSON property `volumeBackupHandle`
1980
1945
  # @return [String]
1981
1946
  attr_accessor :volume_backup_handle
@@ -2007,16 +1972,13 @@ module Google
2007
1972
  class VolumeRestore
2008
1973
  include Google::Apis::Core::Hashable
2009
1974
 
2010
- # Output only. [Output Only] The timestamp when the associated underlying volume
2011
- # restoration completed - can be converted to and from [RFC3339](https://www.
2012
- # ietf.org/rfc/rfc3339.txt)
1975
+ # Output only. The timestamp when the associated underlying volume restoration
1976
+ # completed.
2013
1977
  # Corresponds to the JSON property `completeTime`
2014
1978
  # @return [String]
2015
1979
  attr_accessor :complete_time
2016
1980
 
2017
- # Output only. [Output Only] The timestamp when this VolumeRestore resource was
2018
- # created - can be converted to and from [RFC3339](https://www.ietf.org/rfc/
2019
- # rfc3339.txt)
1981
+ # Output only. The timestamp when this VolumeRestore resource was created.
2020
1982
  # Corresponds to the JSON property `createTime`
2021
1983
  # @return [String]
2022
1984
  attr_accessor :create_time
@@ -2025,22 +1987,18 @@ module Google
2025
1987
  # help prevent simultaneous updates of a volume restore from overwriting each
2026
1988
  # other. It is strongly suggested that systems make use of the `etag` in the
2027
1989
  # read-modify-write cycle to perform volume restore updates in order to avoid
2028
- # race conditions: An `etag` is returned in the response to `GetVolumeRestore',
2029
- # and systems are expected to put that etag in the request to `
2030
- # UpdateVolumeRestore` to ensure that their change will be applied to the same
2031
- # version.
1990
+ # race conditions.
2032
1991
  # Corresponds to the JSON property `etag`
2033
1992
  # @return [String]
2034
1993
  attr_accessor :etag
2035
1994
 
2036
1995
  # Output only. Full name of the VolumeRestore resource. Format: projects/*/
2037
- # locations/*/restorePlans/*/restores/*/volumeRestores/* Note that the last
2038
- # segment of the name will have the format: 'pvc-'.
1996
+ # locations/*/restorePlans/*/restores/*/volumeRestores/*.
2039
1997
  # Corresponds to the JSON property `name`
2040
1998
  # @return [String]
2041
1999
  attr_accessor :name
2042
2000
 
2043
- # Output only. The current state of this VolumeRestore
2001
+ # Output only. The current state of this VolumeRestore.
2044
2002
  # Corresponds to the JSON property `state`
2045
2003
  # @return [String]
2046
2004
  attr_accessor :state
@@ -2056,30 +2014,26 @@ module Google
2056
2014
  # @return [Google::Apis::GkebackupV1::NamespacedName]
2057
2015
  attr_accessor :target_pvc
2058
2016
 
2059
- # Output only. [Output Only] Server generated global unique identifier of [UUID](
2060
- # https://en.wikipedia.org/wiki/Universally_unique_identifier) format.
2017
+ # Output only. Server generated global unique identifier of [UUID](https://en.
2018
+ # wikipedia.org/wiki/Universally_unique_identifier) format.
2061
2019
  # Corresponds to the JSON property `uid`
2062
2020
  # @return [String]
2063
2021
  attr_accessor :uid
2064
2022
 
2065
- # Output only. [Output Only] The timestamp when this VolumeRestore resource was
2066
- # last updated - can be converted to and from [RFC3339](https://www.ietf.org/rfc/
2067
- # rfc3339.txt)
2023
+ # Output only. The timestamp when this VolumeRestore resource was last updated.
2068
2024
  # Corresponds to the JSON property `updateTime`
2069
2025
  # @return [String]
2070
2026
  attr_accessor :update_time
2071
2027
 
2072
2028
  # Output only. The full name of the VolumeBackup from which the volume will be
2073
2029
  # restored. Format: projects/*/locations/*/backupPlans/*/backups/*/volumeBackups/
2074
- # *
2030
+ # *.
2075
2031
  # Corresponds to the JSON property `volumeBackup`
2076
2032
  # @return [String]
2077
2033
  attr_accessor :volume_backup
2078
2034
 
2079
2035
  # Output only. A storage system-specific opaque handler to the underlying volume
2080
- # created for the target PVC from the volume backup. This field is interpreted
2081
- # by the volume backup and restore drivers running in the GKE cluster and not by
2082
- # the service.
2036
+ # created for the target PVC from the volume backup.
2083
2037
  # Corresponds to the JSON property `volumeHandle`
2084
2038
  # @return [String]
2085
2039
  attr_accessor :volume_handle