google-cloud-spanner-admin-database-v1 0.5.1 → 0.6.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (11) hide show
  1. checksums.yaml +4 -4
  2. data/lib/google/cloud/spanner/admin/database/v1/database_admin/client.rb +45 -63
  3. data/lib/google/cloud/spanner/admin/database/v1/version.rb +1 -1
  4. data/lib/google/spanner/admin/database/v1/backup_pb.rb +1 -0
  5. data/lib/google/spanner/admin/database/v1/common_pb.rb +1 -0
  6. data/lib/google/spanner/admin/database/v1/spanner_database_admin_pb.rb +1 -0
  7. data/lib/google/spanner/admin/database/v1/spanner_database_admin_services_pb.rb +12 -16
  8. data/proto_docs/google/spanner/admin/database/v1/backup.rb +45 -66
  9. data/proto_docs/google/spanner/admin/database/v1/common.rb +5 -5
  10. data/proto_docs/google/spanner/admin/database/v1/spanner_database_admin.rb +53 -59
  11. metadata +2 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: c0f8d800d8fbda2c59cdbcc48598426db4256c3d73a7e91a332c77ff5261e21b
4
- data.tar.gz: 8c5b5a77007afe6cb34aa258f0f00d72193222375ebd05f78f2ec8288f7f6ab4
3
+ metadata.gz: e3a91fe2dae20a29fb57719f939afdd13779a56bd274e416f71a6027c51cd7a8
4
+ data.tar.gz: 5a06a7ec4f985cc5c019a24e1e591c9157134f367fe5a2d6a9fb5c8160c35fa6
5
5
  SHA512:
6
- metadata.gz: 3cf8dc8ed45b244188cc0e66aa910a74b2995d9692417a71c9f4ef50cd6690874de37af3e5ea961b3cf4779231b5ecafa0751bb2678e465bc2e21fb97c5237f9
7
- data.tar.gz: 700806a764c5bab53ae34f0041774c978f448404a6bc1d70324d4d911ce91cdde32ee1d9830f440dd17aee2e17bab9ebebbc0250956ce0d0e491234bef4754a2
6
+ metadata.gz: a23ea863cb22ec509a3c8052f0f58e65b357913da7ce1ba34d9a58341b8e621d88e0651d3aab4b1bd8c30786656123ce461d142588084a65e734a1f16755c110
7
+ data.tar.gz: 9001cee8f8548a71aa66065e748dae30ab8c92389aa784998fd548f984b98c2284a12e67508feb1e0a7c276d3307e0aea24b8055b807054e55b0b868850f5e38
data/lib/google/cloud/spanner/admin/database/v1/database_admin/client.rb CHANGED
@@ -301,9 +301,8 @@ module Google
301
301
  # defaults to the server's maximum allowed page size.
302
302
  # @param page_token [::String]
303
303
  # If non-empty, `page_token` should contain a
304
- # {::Google::Cloud::Spanner::Admin::Database::V1::ListDatabasesResponse#next_page_token next_page_token}
305
- # from a previous
306
- # {::Google::Cloud::Spanner::Admin::Database::V1::ListDatabasesResponse ListDatabasesResponse}.
304
+ # {::Google::Cloud::Spanner::Admin::Database::V1::ListDatabasesResponse#next_page_token next_page_token} from a
305
+ # previous {::Google::Cloud::Spanner::Admin::Database::V1::ListDatabasesResponse ListDatabasesResponse}.
307
306
  #
308
307
  # @yield [response, operation] Access the result along with the RPC operation
309
308
  # @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::Spanner::Admin::Database::V1::Database>]
@@ -357,8 +356,8 @@ module Google
357
356
  # have a name of the format `<database_name>/operations/<operation_id>` and
358
357
  # can be used to track preparation of the database. The
359
358
  # {::Google::Longrunning::Operation#metadata metadata} field type is
360
- # {::Google::Cloud::Spanner::Admin::Database::V1::CreateDatabaseMetadata CreateDatabaseMetadata}.
361
- # The {::Google::Longrunning::Operation#response response} field type is
359
+ # {::Google::Cloud::Spanner::Admin::Database::V1::CreateDatabaseMetadata CreateDatabaseMetadata}. The
360
+ # {::Google::Longrunning::Operation#response response} field type is
362
361
  # {::Google::Cloud::Spanner::Admin::Database::V1::Database Database}, if successful.
363
362
  #
364
363
  # @overload create_database(request, options = nil)
@@ -391,8 +390,8 @@ module Google
391
390
  # statements execute atomically with the creation of the database:
392
391
  # if there is an error in any statement, the database is not created.
393
392
  # @param encryption_config [::Google::Cloud::Spanner::Admin::Database::V1::EncryptionConfig, ::Hash]
394
- # Optional. The encryption configuration for the database. If this field is
395
- # not specified, Cloud Spanner will encrypt/decrypt all data at rest using
393
+ # Optional. The encryption configuration for the database. If this field is not
394
+ # specified, Cloud Spanner will encrypt/decrypt all data at rest using
396
395
  # Google default encryption.
397
396
  #
398
397
  # @yield [response, operation] Access the result along with the RPC operation
@@ -515,8 +514,7 @@ module Google
515
514
  # the format `<database_name>/operations/<operation_id>` and can be used to
516
515
  # track execution of the schema change(s). The
517
516
  # {::Google::Longrunning::Operation#metadata metadata} field type is
518
- # {::Google::Cloud::Spanner::Admin::Database::V1::UpdateDatabaseDdlMetadata UpdateDatabaseDdlMetadata}.
519
- # The operation has no response.
517
+ # {::Google::Cloud::Spanner::Admin::Database::V1::UpdateDatabaseDdlMetadata UpdateDatabaseDdlMetadata}. The operation has no response.
520
518
  #
521
519
  # @overload update_database_ddl(request, options = nil)
522
520
  # Pass arguments to `update_database_ddl` via a request object, either of type
@@ -545,20 +543,18 @@ module Google
545
543
  #
546
544
  # Specifying an explicit operation ID simplifies determining
547
545
  # whether the statements were executed in the event that the
548
- # {::Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdmin::Client#update_database_ddl UpdateDatabaseDdl}
549
- # call is replayed, or the return value is otherwise lost: the
550
- # {::Google::Cloud::Spanner::Admin::Database::V1::UpdateDatabaseDdlRequest#database database}
551
- # and `operation_id` fields can be combined to form the
546
+ # {::Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdmin::Client#update_database_ddl UpdateDatabaseDdl} call is replayed,
547
+ # or the return value is otherwise lost: the {::Google::Cloud::Spanner::Admin::Database::V1::UpdateDatabaseDdlRequest#database database} and
548
+ # `operation_id` fields can be combined to form the
552
549
  # {::Google::Longrunning::Operation#name name} of the resulting
553
- # {::Google::Longrunning::Operation longrunning.Operation}:
554
- # `<database>/operations/<operation_id>`.
550
+ # {::Google::Longrunning::Operation longrunning.Operation}: `<database>/operations/<operation_id>`.
555
551
  #
556
552
  # `operation_id` should be unique within the database, and must be
557
553
  # a valid identifier: `[a-z][a-z0-9_]*`. Note that
558
554
  # automatically-generated operation IDs always begin with an
559
555
  # underscore. If the named operation already exists,
560
- # {::Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdmin::Client#update_database_ddl UpdateDatabaseDdl}
561
- # returns `ALREADY_EXISTS`.
556
+ # {::Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdmin::Client#update_database_ddl UpdateDatabaseDdl} returns
557
+ # `ALREADY_EXISTS`.
562
558
  #
563
559
  # @yield [response, operation] Access the result along with the RPC operation
564
560
  # @yieldparam response [::Gapic::Operation]
@@ -987,12 +983,12 @@ module Google
987
983
  # `projects/<project>/instances/<instance>/backups/<backup>/operations/<operation_id>`
988
984
  # and can be used to track creation of the backup. The
989
985
  # {::Google::Longrunning::Operation#metadata metadata} field type is
990
- # {::Google::Cloud::Spanner::Admin::Database::V1::CreateBackupMetadata CreateBackupMetadata}.
991
- # The {::Google::Longrunning::Operation#response response} field type is
992
- # {::Google::Cloud::Spanner::Admin::Database::V1::Backup Backup}, if successful.
993
- # Cancelling the returned operation will stop the creation and delete the
994
- # backup. There can be only one pending backup creation per database. Backup
995
- # creation of different databases can run concurrently.
986
+ # {::Google::Cloud::Spanner::Admin::Database::V1::CreateBackupMetadata CreateBackupMetadata}. The
987
+ # {::Google::Longrunning::Operation#response response} field type is
988
+ # {::Google::Cloud::Spanner::Admin::Database::V1::Backup Backup}, if successful. Cancelling the returned operation will stop the
989
+ # creation and delete the backup.
990
+ # There can be only one pending backup creation per database. Backup creation
991
+ # of different databases can run concurrently.
996
992
  #
997
993
  # @overload create_backup(request, options = nil)
998
994
  # Pass arguments to `create_backup` via a request object, either of type
@@ -1023,11 +1019,11 @@ module Google
1023
1019
  # @param backup [::Google::Cloud::Spanner::Admin::Database::V1::Backup, ::Hash]
1024
1020
  # Required. The backup to create.
1025
1021
  # @param encryption_config [::Google::Cloud::Spanner::Admin::Database::V1::CreateBackupEncryptionConfig, ::Hash]
1026
- # Optional. The encryption configuration used to encrypt the backup. If this
1027
- # field is not specified, the backup will use the same encryption
1028
- # configuration as the database by default, namely
1029
- # {::Google::Cloud::Spanner::Admin::Database::V1::CreateBackupEncryptionConfig#encryption_type encryption_type}
1030
- # = `USE_DATABASE_ENCRYPTION`.
1022
+ # Optional. The encryption configuration used to encrypt the backup. If this field is
1023
+ # not specified, the backup will use the same
1024
+ # encryption configuration as the database by default, namely
1025
+ # {::Google::Cloud::Spanner::Admin::Database::V1::CreateBackupEncryptionConfig#encryption_type encryption_type} =
1026
+ # `USE_DATABASE_ENCRYPTION`.
1031
1027
  #
1032
1028
  # @yield [response, operation] Access the result along with the RPC operation
1033
1029
  # @yieldparam response [::Gapic::Operation]
@@ -1076,8 +1072,7 @@ module Google
1076
1072
  end
1077
1073
 
1078
1074
  ##
1079
- # Gets metadata on a pending or completed
1080
- # {::Google::Cloud::Spanner::Admin::Database::V1::Backup Backup}.
1075
+ # Gets metadata on a pending or completed {::Google::Cloud::Spanner::Admin::Database::V1::Backup Backup}.
1081
1076
  #
1082
1077
  # @overload get_backup(request, options = nil)
1083
1078
  # Pass arguments to `get_backup` via a request object, either of type
@@ -1145,8 +1140,7 @@ module Google
1145
1140
  end
1146
1141
 
1147
1142
  ##
1148
- # Updates a pending or completed
1149
- # {::Google::Cloud::Spanner::Admin::Database::V1::Backup Backup}.
1143
+ # Updates a pending or completed {::Google::Cloud::Spanner::Admin::Database::V1::Backup Backup}.
1150
1144
  #
1151
1145
  # @overload update_backup(request, options = nil)
1152
1146
  # Pass arguments to `update_backup` via a request object, either of type
@@ -1221,8 +1215,7 @@ module Google
1221
1215
  end
1222
1216
 
1223
1217
  ##
1224
- # Deletes a pending or completed
1225
- # {::Google::Cloud::Spanner::Admin::Database::V1::Backup Backup}.
1218
+ # Deletes a pending or completed {::Google::Cloud::Spanner::Admin::Database::V1::Backup Backup}.
1226
1219
  #
1227
1220
  # @overload delete_backup(request, options = nil)
1228
1221
  # Pass arguments to `delete_backup` via a request object, either of type
@@ -1321,9 +1314,7 @@ module Google
1321
1314
  # must be one of: `<`, `>`, `<=`, `>=`, `!=`, `=`, or `:`.
1322
1315
  # Colon `:` is the contains operator. Filter rules are not case sensitive.
1323
1316
  #
1324
- # The following fields in the
1325
- # {::Google::Cloud::Spanner::Admin::Database::V1::Backup Backup} are eligible for
1326
- # filtering:
1317
+ # The following fields in the {::Google::Cloud::Spanner::Admin::Database::V1::Backup Backup} are eligible for filtering:
1327
1318
  #
1328
1319
  # * `name`
1329
1320
  # * `database`
@@ -1355,10 +1346,9 @@ module Google
1355
1346
  # less, defaults to the server's maximum allowed page size.
1356
1347
  # @param page_token [::String]
1357
1348
  # If non-empty, `page_token` should contain a
1358
- # {::Google::Cloud::Spanner::Admin::Database::V1::ListBackupsResponse#next_page_token next_page_token}
1359
- # from a previous
1360
- # {::Google::Cloud::Spanner::Admin::Database::V1::ListBackupsResponse ListBackupsResponse}
1361
- # to the same `parent` and with the same `filter`.
1349
+ # {::Google::Cloud::Spanner::Admin::Database::V1::ListBackupsResponse#next_page_token next_page_token} from a
1350
+ # previous {::Google::Cloud::Spanner::Admin::Database::V1::ListBackupsResponse ListBackupsResponse} to the same `parent` and with the same
1351
+ # `filter`.
1362
1352
  #
1363
1353
  # @yield [response, operation] Access the result along with the RPC operation
1364
1354
  # @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::Spanner::Admin::Database::V1::Backup>]
@@ -1455,12 +1445,12 @@ module Google
1455
1445
  # Name of the backup from which to restore. Values are of the form
1456
1446
  # `projects/<project>/instances/<instance>/backups/<backup>`.
1457
1447
  # @param encryption_config [::Google::Cloud::Spanner::Admin::Database::V1::RestoreDatabaseEncryptionConfig, ::Hash]
1458
- # Optional. An encryption configuration describing the encryption type and
1459
- # key resources in Cloud KMS used to encrypt/decrypt the database to restore
1460
- # to. If this field is not specified, the restored database will use the same
1461
- # encryption configuration as the backup by default, namely
1462
- # {::Google::Cloud::Spanner::Admin::Database::V1::RestoreDatabaseEncryptionConfig#encryption_type encryption_type}
1463
- # = `USE_CONFIG_DEFAULT_OR_BACKUP_ENCRYPTION`.
1448
+ # Optional. An encryption configuration describing the encryption type and key
1449
+ # resources in Cloud KMS used to encrypt/decrypt the database to restore to.
1450
+ # If this field is not specified, the restored database will use
1451
+ # the same encryption configuration as the backup by default, namely
1452
+ # {::Google::Cloud::Spanner::Admin::Database::V1::RestoreDatabaseEncryptionConfig#encryption_type encryption_type} =
1453
+ # `USE_CONFIG_DEFAULT_OR_BACKUP_ENCRYPTION`.
1464
1454
  #
1465
1455
  # @yield [response, operation] Access the result along with the RPC operation
1466
1456
  # @yieldparam response [::Gapic::Operation]
@@ -1551,9 +1541,7 @@ module Google
1551
1541
  # * `name` - The name of the long-running operation
1552
1542
  # * `done` - False if the operation is in progress, else true.
1553
1543
  # * `metadata.@type` - the type of metadata. For example, the type string
1554
- # for
1555
- # {::Google::Cloud::Spanner::Admin::Database::V1::RestoreDatabaseMetadata RestoreDatabaseMetadata}
1556
- # is
1544
+ # for {::Google::Cloud::Spanner::Admin::Database::V1::RestoreDatabaseMetadata RestoreDatabaseMetadata} is
1557
1545
  # `type.googleapis.com/google.spanner.admin.database.v1.RestoreDatabaseMetadata`.
1558
1546
  # * `metadata.<field_name>` - any field in metadata.value.
1559
1547
  # * `error` - Error associated with the long-running operation.
@@ -1573,8 +1561,7 @@ module Google
1573
1561
  # `(metadata.name:restored_howl) AND` \
1574
1562
  # `(metadata.progress.start_time < \"2018-03-28T14:50:00Z\") AND` \
1575
1563
  # `(error:*)` - Return operations where:
1576
- # * The operation's metadata type is
1577
- # {::Google::Cloud::Spanner::Admin::Database::V1::RestoreDatabaseMetadata RestoreDatabaseMetadata}.
1564
+ # * The operation's metadata type is {::Google::Cloud::Spanner::Admin::Database::V1::RestoreDatabaseMetadata RestoreDatabaseMetadata}.
1578
1565
  # * The database is restored from a backup.
1579
1566
  # * The backup name contains "backup_howl".
1580
1567
  # * The restored database's name contains "restored_howl".
@@ -1586,9 +1573,8 @@ module Google
1586
1573
  # @param page_token [::String]
1587
1574
  # If non-empty, `page_token` should contain a
1588
1575
  # {::Google::Cloud::Spanner::Admin::Database::V1::ListDatabaseOperationsResponse#next_page_token next_page_token}
1589
- # from a previous
1590
- # {::Google::Cloud::Spanner::Admin::Database::V1::ListDatabaseOperationsResponse ListDatabaseOperationsResponse}
1591
- # to the same `parent` and with the same `filter`.
1576
+ # from a previous {::Google::Cloud::Spanner::Admin::Database::V1::ListDatabaseOperationsResponse ListDatabaseOperationsResponse} to the
1577
+ # same `parent` and with the same `filter`.
1592
1578
  #
1593
1579
  # @yield [response, operation] Access the result along with the RPC operation
1594
1580
  # @yieldparam response [::Gapic::PagedEnumerable<::Gapic::Operation>]
@@ -1682,9 +1668,7 @@ module Google
1682
1668
  # * `name` - The name of the long-running operation
1683
1669
  # * `done` - False if the operation is in progress, else true.
1684
1670
  # * `metadata.@type` - the type of metadata. For example, the type string
1685
- # for
1686
- # {::Google::Cloud::Spanner::Admin::Database::V1::CreateBackupMetadata CreateBackupMetadata}
1687
- # is
1671
+ # for {::Google::Cloud::Spanner::Admin::Database::V1::CreateBackupMetadata CreateBackupMetadata} is
1688
1672
  # `type.googleapis.com/google.spanner.admin.database.v1.CreateBackupMetadata`.
1689
1673
  # * `metadata.<field_name>` - any field in metadata.value.
1690
1674
  # * `error` - Error associated with the long-running operation.
@@ -1704,8 +1688,7 @@ module Google
1704
1688
  # `(metadata.name:howl) AND` \
1705
1689
  # `(metadata.progress.start_time < \"2018-03-28T14:50:00Z\") AND` \
1706
1690
  # `(error:*)` - Returns operations where:
1707
- # * The operation's metadata type is
1708
- # {::Google::Cloud::Spanner::Admin::Database::V1::CreateBackupMetadata CreateBackupMetadata}.
1691
+ # * The operation's metadata type is {::Google::Cloud::Spanner::Admin::Database::V1::CreateBackupMetadata CreateBackupMetadata}.
1709
1692
  # * The backup name contains the string "howl".
1710
1693
  # * The operation started before 2018-03-28T14:50:00Z.
1711
1694
  # * The operation resulted in an error.
@@ -1715,9 +1698,8 @@ module Google
1715
1698
  # @param page_token [::String]
1716
1699
  # If non-empty, `page_token` should contain a
1717
1700
  # {::Google::Cloud::Spanner::Admin::Database::V1::ListBackupOperationsResponse#next_page_token next_page_token}
1718
- # from a previous
1719
- # {::Google::Cloud::Spanner::Admin::Database::V1::ListBackupOperationsResponse ListBackupOperationsResponse}
1720
- # to the same `parent` and with the same `filter`.
1701
+ # from a previous {::Google::Cloud::Spanner::Admin::Database::V1::ListBackupOperationsResponse ListBackupOperationsResponse} to the
1702
+ # same `parent` and with the same `filter`.
1721
1703
  #
1722
1704
  # @yield [response, operation] Access the result along with the RPC operation
1723
1705
  # @yieldparam response [::Gapic::PagedEnumerable<::Gapic::Operation>]
data/lib/google/cloud/spanner/admin/database/v1/version.rb CHANGED
@@ -23,7 +23,7 @@ module Google
23
23
  module Admin
24
24
  module Database
25
25
  module V1
26
- VERSION = "0.5.1"
26
+ VERSION = "0.6.0"
27
27
  end
28
28
  end
29
29
  end
data/lib/google/spanner/admin/database/v1/backup_pb.rb CHANGED
@@ -9,6 +9,7 @@ require 'google/longrunning/operations_pb'
9
9
  require 'google/protobuf/field_mask_pb'
10
10
  require 'google/protobuf/timestamp_pb'
11
11
  require 'google/spanner/admin/database/v1/common_pb'
12
+ require 'google/api/annotations_pb'
12
13
  Google::Protobuf::DescriptorPool.generated_pool.build do
13
14
  add_file("google/spanner/admin/database/v1/backup.proto", :syntax => :proto3) do
14
15
  add_message "google.spanner.admin.database.v1.Backup" do
data/lib/google/spanner/admin/database/v1/common_pb.rb CHANGED
@@ -7,6 +7,7 @@ require 'google/api/field_behavior_pb'
7
7
  require 'google/api/resource_pb'
8
8
  require 'google/protobuf/timestamp_pb'
9
9
  require 'google/rpc/status_pb'
10
+ require 'google/api/annotations_pb'
10
11
  Google::Protobuf::DescriptorPool.generated_pool.build do
11
12
  add_file("google/spanner/admin/database/v1/common.proto", :syntax => :proto3) do
12
13
  add_message "google.spanner.admin.database.v1.OperationProgress" do
data/lib/google/spanner/admin/database/v1/spanner_database_admin_pb.rb CHANGED
@@ -69,6 +69,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
69
69
  repeated :statements, :string, 2
70
70
  repeated :commit_timestamps, :message, 3, "google.protobuf.Timestamp"
71
71
  optional :throttled, :bool, 4
72
+ repeated :progress, :message, 5, "google.spanner.admin.database.v1.OperationProgress"
72
73
  end
73
74
  add_message "google.spanner.admin.database.v1.DropDatabaseRequest" do
74
75
  optional :database, :string, 1
data/lib/google/spanner/admin/database/v1/spanner_database_admin_services_pb.rb CHANGED
@@ -47,8 +47,8 @@ module Google
47
47
  # have a name of the format `<database_name>/operations/<operation_id>` and
48
48
  # can be used to track preparation of the database. The
49
49
  # [metadata][google.longrunning.Operation.metadata] field type is
50
- # [CreateDatabaseMetadata][google.spanner.admin.database.v1.CreateDatabaseMetadata].
51
- # The [response][google.longrunning.Operation.response] field type is
50
+ # [CreateDatabaseMetadata][google.spanner.admin.database.v1.CreateDatabaseMetadata]. The
51
+ # [response][google.longrunning.Operation.response] field type is
52
52
  # [Database][google.spanner.admin.database.v1.Database], if successful.
53
53
  rpc :CreateDatabase, ::Google::Cloud::Spanner::Admin::Database::V1::CreateDatabaseRequest, ::Google::Longrunning::Operation
54
54
  # Gets the state of a Cloud Spanner database.
@@ -59,8 +59,7 @@ module Google
59
59
  # the format `<database_name>/operations/<operation_id>` and can be used to
60
60
  # track execution of the schema change(s). The
61
61
  # [metadata][google.longrunning.Operation.metadata] field type is
62
- # [UpdateDatabaseDdlMetadata][google.spanner.admin.database.v1.UpdateDatabaseDdlMetadata].
63
- # The operation has no response.
62
+ # [UpdateDatabaseDdlMetadata][google.spanner.admin.database.v1.UpdateDatabaseDdlMetadata]. The operation has no response.
64
63
  rpc :UpdateDatabaseDdl, ::Google::Cloud::Spanner::Admin::Database::V1::UpdateDatabaseDdlRequest, ::Google::Longrunning::Operation
65
64
  # Drops (aka deletes) a Cloud Spanner database.
66
65
  # Completed backups for the database will be retained according to their
@@ -104,21 +103,18 @@ module Google
104
103
  # `projects/<project>/instances/<instance>/backups/<backup>/operations/<operation_id>`
105
104
  # and can be used to track creation of the backup. The
106
105
  # [metadata][google.longrunning.Operation.metadata] field type is
107
- # [CreateBackupMetadata][google.spanner.admin.database.v1.CreateBackupMetadata].
108
- # The [response][google.longrunning.Operation.response] field type is
109
- # [Backup][google.spanner.admin.database.v1.Backup], if successful.
110
- # Cancelling the returned operation will stop the creation and delete the
111
- # backup. There can be only one pending backup creation per database. Backup
112
- # creation of different databases can run concurrently.
106
+ # [CreateBackupMetadata][google.spanner.admin.database.v1.CreateBackupMetadata]. The
107
+ # [response][google.longrunning.Operation.response] field type is
108
+ # [Backup][google.spanner.admin.database.v1.Backup], if successful. Cancelling the returned operation will stop the
109
+ # creation and delete the backup.
110
+ # There can be only one pending backup creation per database. Backup creation
111
+ # of different databases can run concurrently.
113
112
  rpc :CreateBackup, ::Google::Cloud::Spanner::Admin::Database::V1::CreateBackupRequest, ::Google::Longrunning::Operation
114
- # Gets metadata on a pending or completed
115
- # [Backup][google.spanner.admin.database.v1.Backup].
113
+ # Gets metadata on a pending or completed [Backup][google.spanner.admin.database.v1.Backup].
116
114
  rpc :GetBackup, ::Google::Cloud::Spanner::Admin::Database::V1::GetBackupRequest, ::Google::Cloud::Spanner::Admin::Database::V1::Backup
117
- # Updates a pending or completed
118
- # [Backup][google.spanner.admin.database.v1.Backup].
115
+ # Updates a pending or completed [Backup][google.spanner.admin.database.v1.Backup].
119
116
  rpc :UpdateBackup, ::Google::Cloud::Spanner::Admin::Database::V1::UpdateBackupRequest, ::Google::Cloud::Spanner::Admin::Database::V1::Backup
120
- # Deletes a pending or completed
121
- # [Backup][google.spanner.admin.database.v1.Backup].
117
+ # Deletes a pending or completed [Backup][google.spanner.admin.database.v1.Backup].
122
118
  rpc :DeleteBackup, ::Google::Cloud::Spanner::Admin::Database::V1::DeleteBackupRequest, ::Google::Protobuf::Empty
123
119
  # Lists completed and pending backups.
124
120
  # Backups returned are ordered by `create_time` in descending order,
data/proto_docs/google/spanner/admin/database/v1/backup.rb CHANGED
@@ -26,10 +26,10 @@ module Google
26
26
  # A backup of a Cloud Spanner database.
27
27
  # @!attribute [rw] database
28
28
  # @return [::String]
29
- # Required for the
30
- # {::Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdmin::Client#create_backup CreateBackup}
31
- # operation. Name of the database from which this backup was created. This
32
- # needs to be in the same instance as the backup. Values are of the form
29
+ # Required for the {::Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdmin::Client#create_backup CreateBackup} operation.
30
+ # Name of the database from which this backup was
31
+ # created. This needs to be in the same instance as the backup.
32
+ # Values are of the form
33
33
  # `projects/<project>/instances/<instance>/databases/<database>`.
34
34
  # @!attribute [rw] version_time
35
35
  # @return [::Google::Protobuf::Timestamp]
@@ -39,8 +39,7 @@ module Google
39
39
  # backup.
40
40
  # @!attribute [rw] expire_time
41
41
  # @return [::Google::Protobuf::Timestamp]
42
- # Required for the
43
- # {::Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdmin::Client#create_backup CreateBackup}
42
+ # Required for the {::Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdmin::Client#create_backup CreateBackup}
44
43
  # operation. The expiration time of the backup, with microseconds
45
44
  # granularity that must be at least 6 hours and at most 366 days
46
45
  # from the time the CreateBackup request is processed. Once the `expire_time`
@@ -48,11 +47,8 @@ module Google
48
47
  # Spanner to free the resources used by the backup.
49
48
  # @!attribute [rw] name
50
49
  # @return [::String]
51
- # Output only for the
52
- # {::Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdmin::Client#create_backup CreateBackup}
53
- # operation. Required for the
54
- # {::Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdmin::Client#update_backup UpdateBackup}
55
- # operation.
50
+ # Output only for the {::Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdmin::Client#create_backup CreateBackup} operation.
51
+ # Required for the {::Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdmin::Client#update_backup UpdateBackup} operation.
56
52
  #
57
53
  # A globally unique identifier for the backup which cannot be
58
54
  # changed. Values are of the form
@@ -66,8 +62,7 @@ module Google
66
62
  # `projects/<project>/instances/<instance>`.
67
63
  # @!attribute [r] create_time
68
64
  # @return [::Google::Protobuf::Timestamp]
69
- # Output only. The time the
70
- # {::Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdmin::Client#create_backup CreateBackup}
65
+ # Output only. The time the {::Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdmin::Client#create_backup CreateBackup}
71
66
  # request is received. If the request does not specify `version_time`, the
72
67
  # `version_time` of the backup will be equivalent to the `create_time`.
73
68
  # @!attribute [r] size_bytes
@@ -106,8 +101,7 @@ module Google
106
101
  end
107
102
  end
108
103
 
109
- # The request for
110
- # {::Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdmin::Client#create_backup CreateBackup}.
104
+ # The request for {::Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdmin::Client#create_backup CreateBackup}.
111
105
  # @!attribute [rw] parent
112
106
  # @return [::String]
113
107
  # Required. The name of the instance in which the backup will be
@@ -126,11 +120,11 @@ module Google
126
120
  # Required. The backup to create.
127
121
  # @!attribute [rw] encryption_config
128
122
  # @return [::Google::Cloud::Spanner::Admin::Database::V1::CreateBackupEncryptionConfig]
129
- # Optional. The encryption configuration used to encrypt the backup. If this
130
- # field is not specified, the backup will use the same encryption
131
- # configuration as the database by default, namely
132
- # {::Google::Cloud::Spanner::Admin::Database::V1::CreateBackupEncryptionConfig#encryption_type encryption_type}
133
- # = `USE_DATABASE_ENCRYPTION`.
123
+ # Optional. The encryption configuration used to encrypt the backup. If this field is
124
+ # not specified, the backup will use the same
125
+ # encryption configuration as the database by default, namely
126
+ # {::Google::Cloud::Spanner::Admin::Database::V1::CreateBackupEncryptionConfig#encryption_type encryption_type} =
127
+ # `USE_DATABASE_ENCRYPTION`.
134
128
  class CreateBackupRequest
135
129
  include ::Google::Protobuf::MessageExts
136
130
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -147,8 +141,7 @@ module Google
147
141
  # @!attribute [rw] progress
148
142
  # @return [::Google::Cloud::Spanner::Admin::Database::V1::OperationProgress]
149
143
  # The progress of the
150
- # {::Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdmin::Client#create_backup CreateBackup}
151
- # operation.
144
+ # {::Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdmin::Client#create_backup CreateBackup} operation.
152
145
  # @!attribute [rw] cancel_time
153
146
  # @return [::Google::Protobuf::Timestamp]
154
147
  # The time at which cancellation of this operation was received.
@@ -168,8 +161,7 @@ module Google
168
161
  extend ::Google::Protobuf::MessageExts::ClassMethods
169
162
  end
170
163
 
171
- # The request for
172
- # {::Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdmin::Client#update_backup UpdateBackup}.
164
+ # The request for {::Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdmin::Client#update_backup UpdateBackup}.
173
165
  # @!attribute [rw] backup
174
166
  # @return [::Google::Cloud::Spanner::Admin::Database::V1::Backup]
175
167
  # Required. The backup to update. `backup.name`, and the fields to be updated
@@ -188,8 +180,7 @@ module Google
188
180
  extend ::Google::Protobuf::MessageExts::ClassMethods
189
181
  end
190
182
 
191
- # The request for
192
- # {::Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdmin::Client#get_backup GetBackup}.
183
+ # The request for {::Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdmin::Client#get_backup GetBackup}.
193
184
  # @!attribute [rw] name
194
185
  # @return [::String]
195
186
  # Required. Name of the backup.
@@ -200,8 +191,7 @@ module Google
200
191
  extend ::Google::Protobuf::MessageExts::ClassMethods
201
192
  end
202
193
 
203
- # The request for
204
- # {::Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdmin::Client#delete_backup DeleteBackup}.
194
+ # The request for {::Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdmin::Client#delete_backup DeleteBackup}.
205
195
  # @!attribute [rw] name
206
196
  # @return [::String]
207
197
  # Required. Name of the backup to delete.
@@ -212,8 +202,7 @@ module Google
212
202
  extend ::Google::Protobuf::MessageExts::ClassMethods
213
203
  end
214
204
 
215
- # The request for
216
- # {::Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdmin::Client#list_backups ListBackups}.
205
+ # The request for {::Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdmin::Client#list_backups ListBackups}.
217
206
  # @!attribute [rw] parent
218
207
  # @return [::String]
219
208
  # Required. The instance to list backups from. Values are of the
@@ -228,9 +217,7 @@ module Google
228
217
  # must be one of: `<`, `>`, `<=`, `>=`, `!=`, `=`, or `:`.
229
218
  # Colon `:` is the contains operator. Filter rules are not case sensitive.
230
219
  #
231
- # The following fields in the
232
- # {::Google::Cloud::Spanner::Admin::Database::V1::Backup Backup} are eligible for
233
- # filtering:
220
+ # The following fields in the {::Google::Cloud::Spanner::Admin::Database::V1::Backup Backup} are eligible for filtering:
234
221
  #
235
222
  # * `name`
236
223
  # * `database`
@@ -264,17 +251,15 @@ module Google
264
251
  # @!attribute [rw] page_token
265
252
  # @return [::String]
266
253
  # If non-empty, `page_token` should contain a
267
- # {::Google::Cloud::Spanner::Admin::Database::V1::ListBackupsResponse#next_page_token next_page_token}
268
- # from a previous
269
- # {::Google::Cloud::Spanner::Admin::Database::V1::ListBackupsResponse ListBackupsResponse}
270
- # to the same `parent` and with the same `filter`.
254
+ # {::Google::Cloud::Spanner::Admin::Database::V1::ListBackupsResponse#next_page_token next_page_token} from a
255
+ # previous {::Google::Cloud::Spanner::Admin::Database::V1::ListBackupsResponse ListBackupsResponse} to the same `parent` and with the same
256
+ # `filter`.
271
257
  class ListBackupsRequest
272
258
  include ::Google::Protobuf::MessageExts
273
259
  extend ::Google::Protobuf::MessageExts::ClassMethods
274
260
  end
275
261
 
276
- # The response for
277
- # {::Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdmin::Client#list_backups ListBackups}.
262
+ # The response for {::Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdmin::Client#list_backups ListBackups}.
278
263
  # @!attribute [rw] backups
279
264
  # @return [::Array<::Google::Cloud::Spanner::Admin::Database::V1::Backup>]
280
265
  # The list of matching backups. Backups returned are ordered by `create_time`
@@ -282,8 +267,8 @@ module Google
282
267
  # @!attribute [rw] next_page_token
283
268
  # @return [::String]
284
269
  # `next_page_token` can be sent in a subsequent
285
- # {::Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdmin::Client#list_backups ListBackups}
286
- # call to fetch more of the matching backups.
270
+ # {::Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdmin::Client#list_backups ListBackups} call to fetch more
271
+ # of the matching backups.
287
272
  class ListBackupsResponse
288
273
  include ::Google::Protobuf::MessageExts
289
274
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -311,9 +296,7 @@ module Google
311
296
  # * `name` - The name of the long-running operation
312
297
  # * `done` - False if the operation is in progress, else true.
313
298
  # * `metadata.@type` - the type of metadata. For example, the type string
314
- # for
315
- # {::Google::Cloud::Spanner::Admin::Database::V1::CreateBackupMetadata CreateBackupMetadata}
316
- # is
299
+ # for {::Google::Cloud::Spanner::Admin::Database::V1::CreateBackupMetadata CreateBackupMetadata} is
317
300
  # `type.googleapis.com/google.spanner.admin.database.v1.CreateBackupMetadata`.
318
301
  # * `metadata.<field_name>` - any field in metadata.value.
319
302
  # * `error` - Error associated with the long-running operation.
@@ -333,8 +316,7 @@ module Google
333
316
  # `(metadata.name:howl) AND` \
334
317
  # `(metadata.progress.start_time < \"2018-03-28T14:50:00Z\") AND` \
335
318
  # `(error:*)` - Returns operations where:
336
- # * The operation's metadata type is
337
- # {::Google::Cloud::Spanner::Admin::Database::V1::CreateBackupMetadata CreateBackupMetadata}.
319
+ # * The operation's metadata type is {::Google::Cloud::Spanner::Admin::Database::V1::CreateBackupMetadata CreateBackupMetadata}.
338
320
  # * The backup name contains the string "howl".
339
321
  # * The operation started before 2018-03-28T14:50:00Z.
340
322
  # * The operation resulted in an error.
@@ -346,9 +328,8 @@ module Google
346
328
  # @return [::String]
347
329
  # If non-empty, `page_token` should contain a
348
330
  # {::Google::Cloud::Spanner::Admin::Database::V1::ListBackupOperationsResponse#next_page_token next_page_token}
349
- # from a previous
350
- # {::Google::Cloud::Spanner::Admin::Database::V1::ListBackupOperationsResponse ListBackupOperationsResponse}
351
- # to the same `parent` and with the same `filter`.
331
+ # from a previous {::Google::Cloud::Spanner::Admin::Database::V1::ListBackupOperationsResponse ListBackupOperationsResponse} to the
332
+ # same `parent` and with the same `filter`.
352
333
  class ListBackupOperationsRequest
353
334
  include ::Google::Protobuf::MessageExts
354
335
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -362,11 +343,11 @@ module Google
362
343
  # operations][google.longrunning.Operation]. Each operation's name will be
363
344
  # prefixed by the backup's name and the operation's
364
345
  # {::Google::Longrunning::Operation#metadata metadata} will be of type
365
- # {::Google::Cloud::Spanner::Admin::Database::V1::CreateBackupMetadata CreateBackupMetadata}.
366
- # Operations returned include those that are pending or have
367
- # completed/failed/canceled within the last 7 days. Operations returned are
368
- # ordered by `operation.metadata.value.progress.start_time` in descending
369
- # order starting from the most recently started operation.
346
+ # {::Google::Cloud::Spanner::Admin::Database::V1::CreateBackupMetadata CreateBackupMetadata}. Operations returned include those that are
347
+ # pending or have completed/failed/canceled within the last 7 days.
348
+ # Operations returned are ordered by
349
+ # `operation.metadata.value.progress.start_time` in descending order starting
350
+ # from the most recently started operation.
370
351
  # @!attribute [rw] next_page_token
371
352
  # @return [::String]
372
353
  # `next_page_token` can be sent in a subsequent
@@ -385,14 +366,13 @@ module Google
385
366
  # @return [::Google::Protobuf::Timestamp]
386
367
  # The backup contains an externally consistent copy of `source_database` at
387
368
  # the timestamp specified by `version_time`. If the
388
- # {::Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdmin::Client#create_backup CreateBackup}
389
- # request did not specify `version_time`, the `version_time` of the backup is
390
- # equivalent to the `create_time`.
369
+ # {::Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdmin::Client#create_backup CreateBackup} request did not specify
370
+ # `version_time`, the `version_time` of the backup is equivalent to the
371
+ # `create_time`.
391
372
  # @!attribute [rw] create_time
392
373
  # @return [::Google::Protobuf::Timestamp]
393
- # The time the
394
- # {::Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdmin::Client#create_backup CreateBackup}
395
- # request was received.
374
+ # The time the {::Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdmin::Client#create_backup CreateBackup} request was
375
+ # received.
396
376
  # @!attribute [rw] source_database
397
377
  # @return [::String]
398
378
  # Name of the database the backup was created from.
@@ -409,8 +389,8 @@ module Google
409
389
  # @return [::String]
410
390
  # Optional. The Cloud KMS key that will be used to protect the backup.
411
391
  # This field should be set only when
412
- # {::Google::Cloud::Spanner::Admin::Database::V1::CreateBackupEncryptionConfig#encryption_type encryption_type}
413
- # is `CUSTOMER_MANAGED_ENCRYPTION`. Values are of the form
392
+ # {::Google::Cloud::Spanner::Admin::Database::V1::CreateBackupEncryptionConfig#encryption_type encryption_type} is
393
+ # `CUSTOMER_MANAGED_ENCRYPTION`. Values are of the form
414
394
  # `projects/<project>/locations/<location>/keyRings/<key_ring>/cryptoKeys/<kms_key_name>`.
415
395
  class CreateBackupEncryptionConfig
416
396
  include ::Google::Protobuf::MessageExts
@@ -423,10 +403,9 @@ module Google
423
403
 
424
404
  # Use the same encryption configuration as the database. This is the
425
405
  # default option when
426
- # {::Google::Cloud::Spanner::Admin::Database::V1::CreateBackupEncryptionConfig encryption_config}
427
- # is empty. For example, if the database is using
428
- # `Customer_Managed_Encryption`, the backup will be using the same Cloud
429
- # KMS key as the database.
406
+ # {::Google::Cloud::Spanner::Admin::Database::V1::CreateBackupEncryptionConfig encryption_config} is empty.
407
+ # For example, if the database is using `Customer_Managed_Encryption`, the
408
+ # backup will be using the same Cloud KMS key as the database.
430
409
  USE_DATABASE_ENCRYPTION = 1
431
410
 
432
411
  # Use Google default encryption.
data/proto_docs/google/spanner/admin/database/v1/common.rb CHANGED
@@ -58,13 +58,13 @@ module Google
58
58
  # Output only. The type of encryption.
59
59
  # @!attribute [r] encryption_status
60
60
  # @return [::Google::Rpc::Status]
61
- # Output only. If present, the status of a recent encrypt/decrypt call on
62
- # underlying data for this database or backup. Regardless of status, data is
63
- # always encrypted at rest.
61
+ # Output only. If present, the status of a recent encrypt/decrypt call on underlying data
62
+ # for this database or backup. Regardless of status, data is always encrypted
63
+ # at rest.
64
64
  # @!attribute [r] kms_key_version
65
65
  # @return [::String]
66
- # Output only. A Cloud KMS key version that is being used to protect the
67
- # database or backup.
66
+ # Output only. A Cloud KMS key version that is being used to protect the database or
67
+ # backup.
68
68
  class EncryptionInfo
69
69
  include ::Google::Protobuf::MessageExts
70
70
  extend ::Google::Protobuf::MessageExts::ClassMethods
data/proto_docs/google/spanner/admin/database/v1/spanner_database_admin.rb CHANGED
@@ -76,8 +76,8 @@ module Google
76
76
  # Output only. The period in which Cloud Spanner retains all versions of data
77
77
  # for the database. This is the same as the value of version_retention_period
78
78
  # database option set using
79
- # {::Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdmin::Client#update_database_ddl UpdateDatabaseDdl}.
80
- # Defaults to 1 hour, if not set.
79
+ # {::Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdmin::Client#update_database_ddl UpdateDatabaseDdl}. Defaults to 1 hour,
80
+ # if not set.
81
81
  # @!attribute [r] earliest_version_time
82
82
  # @return [::Google::Protobuf::Timestamp]
83
83
  # Output only. Earliest timestamp at which older versions of the data can be
@@ -113,8 +113,7 @@ module Google
113
113
  end
114
114
  end
115
115
 
116
- # The request for
117
- # {::Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdmin::Client#list_databases ListDatabases}.
116
+ # The request for {::Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdmin::Client#list_databases ListDatabases}.
118
117
  # @!attribute [rw] parent
119
118
  # @return [::String]
120
119
  # Required. The instance whose databases should be listed.
@@ -126,31 +125,28 @@ module Google
126
125
  # @!attribute [rw] page_token
127
126
  # @return [::String]
128
127
  # If non-empty, `page_token` should contain a
129
- # {::Google::Cloud::Spanner::Admin::Database::V1::ListDatabasesResponse#next_page_token next_page_token}
130
- # from a previous
131
- # {::Google::Cloud::Spanner::Admin::Database::V1::ListDatabasesResponse ListDatabasesResponse}.
128
+ # {::Google::Cloud::Spanner::Admin::Database::V1::ListDatabasesResponse#next_page_token next_page_token} from a
129
+ # previous {::Google::Cloud::Spanner::Admin::Database::V1::ListDatabasesResponse ListDatabasesResponse}.
132
130
  class ListDatabasesRequest
133
131
  include ::Google::Protobuf::MessageExts
134
132
  extend ::Google::Protobuf::MessageExts::ClassMethods
135
133
  end
136
134
 
137
- # The response for
138
- # {::Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdmin::Client#list_databases ListDatabases}.
135
+ # The response for {::Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdmin::Client#list_databases ListDatabases}.
139
136
  # @!attribute [rw] databases
140
137
  # @return [::Array<::Google::Cloud::Spanner::Admin::Database::V1::Database>]
141
138
  # Databases that matched the request.
142
139
  # @!attribute [rw] next_page_token
143
140
  # @return [::String]
144
141
  # `next_page_token` can be sent in a subsequent
145
- # {::Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdmin::Client#list_databases ListDatabases}
146
- # call to fetch more of the matching databases.
142
+ # {::Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdmin::Client#list_databases ListDatabases} call to fetch more
143
+ # of the matching databases.
147
144
  class ListDatabasesResponse
148
145
  include ::Google::Protobuf::MessageExts
149
146
  extend ::Google::Protobuf::MessageExts::ClassMethods
150
147
  end
151
148
 
152
- # The request for
153
- # {::Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdmin::Client#create_database CreateDatabase}.
149
+ # The request for {::Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdmin::Client#create_database CreateDatabase}.
154
150
  # @!attribute [rw] parent
155
151
  # @return [::String]
156
152
  # Required. The name of the instance that will serve the new database.
@@ -170,8 +166,8 @@ module Google
170
166
  # if there is an error in any statement, the database is not created.
171
167
  # @!attribute [rw] encryption_config
172
168
  # @return [::Google::Cloud::Spanner::Admin::Database::V1::EncryptionConfig]
173
- # Optional. The encryption configuration for the database. If this field is
174
- # not specified, Cloud Spanner will encrypt/decrypt all data at rest using
169
+ # Optional. The encryption configuration for the database. If this field is not
170
+ # specified, Cloud Spanner will encrypt/decrypt all data at rest using
175
171
  # Google default encryption.
176
172
  class CreateDatabaseRequest
177
173
  include ::Google::Protobuf::MessageExts
@@ -188,8 +184,7 @@ module Google
188
184
  extend ::Google::Protobuf::MessageExts::ClassMethods
189
185
  end
190
186
 
191
- # The request for
192
- # {::Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdmin::Client#get_database GetDatabase}.
187
+ # The request for {::Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdmin::Client#get_database GetDatabase}.
193
188
  # @!attribute [rw] name
194
189
  # @return [::String]
195
190
  # Required. The name of the requested database. Values are of the form
@@ -213,8 +208,8 @@ module Google
213
208
  # Each batch of statements is assigned a name which can be used with
214
209
  # the Operations API to monitor
215
210
  # progress. See the
216
- # {::Google::Cloud::Spanner::Admin::Database::V1::UpdateDatabaseDdlRequest#operation_id operation_id}
217
- # field for more details.
211
+ # {::Google::Cloud::Spanner::Admin::Database::V1::UpdateDatabaseDdlRequest#operation_id operation_id} field for more
212
+ # details.
218
213
  # @!attribute [rw] database
219
214
  # @return [::String]
220
215
  # Required. The database to update.
@@ -230,20 +225,18 @@ module Google
230
225
  #
231
226
  # Specifying an explicit operation ID simplifies determining
232
227
  # whether the statements were executed in the event that the
233
- # {::Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdmin::Client#update_database_ddl UpdateDatabaseDdl}
234
- # call is replayed, or the return value is otherwise lost: the
235
- # {::Google::Cloud::Spanner::Admin::Database::V1::UpdateDatabaseDdlRequest#database database}
236
- # and `operation_id` fields can be combined to form the
228
+ # {::Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdmin::Client#update_database_ddl UpdateDatabaseDdl} call is replayed,
229
+ # or the return value is otherwise lost: the {::Google::Cloud::Spanner::Admin::Database::V1::UpdateDatabaseDdlRequest#database database} and
230
+ # `operation_id` fields can be combined to form the
237
231
  # {::Google::Longrunning::Operation#name name} of the resulting
238
- # {::Google::Longrunning::Operation longrunning.Operation}:
239
- # `<database>/operations/<operation_id>`.
232
+ # {::Google::Longrunning::Operation longrunning.Operation}: `<database>/operations/<operation_id>`.
240
233
  #
241
234
  # `operation_id` should be unique within the database, and must be
242
235
  # a valid identifier: `[a-z][a-z0-9_]*`. Note that
243
236
  # automatically-generated operation IDs always begin with an
244
237
  # underscore. If the named operation already exists,
245
- # {::Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdmin::Client#update_database_ddl UpdateDatabaseDdl}
246
- # returns `ALREADY_EXISTS`.
238
+ # {::Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdmin::Client#update_database_ddl UpdateDatabaseDdl} returns
239
+ # `ALREADY_EXISTS`.
247
240
  class UpdateDatabaseDdlRequest
248
241
  include ::Google::Protobuf::MessageExts
249
242
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -268,13 +261,22 @@ module Google
268
261
  # Output only. When true, indicates that the operation is throttled e.g
269
262
  # due to resource constraints. When resources become available the operation
270
263
  # will resume and this field will be false again.
264
+ # @!attribute [rw] progress
265
+ # @return [::Array<::Google::Cloud::Spanner::Admin::Database::V1::OperationProgress>]
266
+ # The progress of the
267
+ # {::Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdmin::Client#update_database_ddl UpdateDatabaseDdl} operations.
268
+ # Currently, only index creation statements will have a continuously
269
+ # updating progress.
270
+ # For non-index creation statements, `progress[i]` will have start time
271
+ # and end time populated with commit timestamp of operation,
272
+ # as well as a progress of 100% once the operation has completed.
273
+ # `progress[i]` is the operation progress for `statements[i]`.
271
274
  class UpdateDatabaseDdlMetadata
272
275
  include ::Google::Protobuf::MessageExts
273
276
  extend ::Google::Protobuf::MessageExts::ClassMethods
274
277
  end
275
278
 
276
- # The request for
277
- # {::Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdmin::Client#drop_database DropDatabase}.
279
+ # The request for {::Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdmin::Client#drop_database DropDatabase}.
278
280
  # @!attribute [rw] database
279
281
  # @return [::String]
280
282
  # Required. The database to be dropped.
@@ -283,8 +285,7 @@ module Google
283
285
  extend ::Google::Protobuf::MessageExts::ClassMethods
284
286
  end
285
287
 
286
- # The request for
287
- # {::Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdmin::Client#get_database_ddl GetDatabaseDdl}.
288
+ # The request for {::Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdmin::Client#get_database_ddl GetDatabaseDdl}.
288
289
  # @!attribute [rw] database
289
290
  # @return [::String]
290
291
  # Required. The database whose schema we wish to get.
@@ -295,8 +296,7 @@ module Google
295
296
  extend ::Google::Protobuf::MessageExts::ClassMethods
296
297
  end
297
298
 
298
- # The response for
299
- # {::Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdmin::Client#get_database_ddl GetDatabaseDdl}.
299
+ # The response for {::Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdmin::Client#get_database_ddl GetDatabaseDdl}.
300
300
  # @!attribute [rw] statements
301
301
  # @return [::Array<::String>]
302
302
  # A list of formatted DDL statements defining the schema of the database
@@ -328,9 +328,7 @@ module Google
328
328
  # * `name` - The name of the long-running operation
329
329
  # * `done` - False if the operation is in progress, else true.
330
330
  # * `metadata.@type` - the type of metadata. For example, the type string
331
- # for
332
- # {::Google::Cloud::Spanner::Admin::Database::V1::RestoreDatabaseMetadata RestoreDatabaseMetadata}
333
- # is
331
+ # for {::Google::Cloud::Spanner::Admin::Database::V1::RestoreDatabaseMetadata RestoreDatabaseMetadata} is
334
332
  # `type.googleapis.com/google.spanner.admin.database.v1.RestoreDatabaseMetadata`.
335
333
  # * `metadata.<field_name>` - any field in metadata.value.
336
334
  # * `error` - Error associated with the long-running operation.
@@ -350,8 +348,7 @@ module Google
350
348
  # `(metadata.name:restored_howl) AND` \
351
349
  # `(metadata.progress.start_time < \"2018-03-28T14:50:00Z\") AND` \
352
350
  # `(error:*)` - Return operations where:
353
- # * The operation's metadata type is
354
- # {::Google::Cloud::Spanner::Admin::Database::V1::RestoreDatabaseMetadata RestoreDatabaseMetadata}.
351
+ # * The operation's metadata type is {::Google::Cloud::Spanner::Admin::Database::V1::RestoreDatabaseMetadata RestoreDatabaseMetadata}.
355
352
  # * The database is restored from a backup.
356
353
  # * The backup name contains "backup_howl".
357
354
  # * The restored database's name contains "restored_howl".
@@ -365,9 +362,8 @@ module Google
365
362
  # @return [::String]
366
363
  # If non-empty, `page_token` should contain a
367
364
  # {::Google::Cloud::Spanner::Admin::Database::V1::ListDatabaseOperationsResponse#next_page_token next_page_token}
368
- # from a previous
369
- # {::Google::Cloud::Spanner::Admin::Database::V1::ListDatabaseOperationsResponse ListDatabaseOperationsResponse}
370
- # to the same `parent` and with the same `filter`.
365
+ # from a previous {::Google::Cloud::Spanner::Admin::Database::V1::ListDatabaseOperationsResponse ListDatabaseOperationsResponse} to the
366
+ # same `parent` and with the same `filter`.
371
367
  class ListDatabaseOperationsRequest
372
368
  include ::Google::Protobuf::MessageExts
373
369
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -413,12 +409,12 @@ module Google
413
409
  # `projects/<project>/instances/<instance>/backups/<backup>`.
414
410
  # @!attribute [rw] encryption_config
415
411
  # @return [::Google::Cloud::Spanner::Admin::Database::V1::RestoreDatabaseEncryptionConfig]
416
- # Optional. An encryption configuration describing the encryption type and
417
- # key resources in Cloud KMS used to encrypt/decrypt the database to restore
418
- # to. If this field is not specified, the restored database will use the same
419
- # encryption configuration as the backup by default, namely
420
- # {::Google::Cloud::Spanner::Admin::Database::V1::RestoreDatabaseEncryptionConfig#encryption_type encryption_type}
421
- # = `USE_CONFIG_DEFAULT_OR_BACKUP_ENCRYPTION`.
412
+ # Optional. An encryption configuration describing the encryption type and key
413
+ # resources in Cloud KMS used to encrypt/decrypt the database to restore to.
414
+ # If this field is not specified, the restored database will use
415
+ # the same encryption configuration as the backup by default, namely
416
+ # {::Google::Cloud::Spanner::Admin::Database::V1::RestoreDatabaseEncryptionConfig#encryption_type encryption_type} =
417
+ # `USE_CONFIG_DEFAULT_OR_BACKUP_ENCRYPTION`.
422
418
  class RestoreDatabaseRequest
423
419
  include ::Google::Protobuf::MessageExts
424
420
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -430,10 +426,10 @@ module Google
430
426
  # Required. The encryption type of the restored database.
431
427
  # @!attribute [rw] kms_key_name
432
428
  # @return [::String]
433
- # Optional. The Cloud KMS key that will be used to encrypt/decrypt the
434
- # restored database. This field should be set only when
435
- # {::Google::Cloud::Spanner::Admin::Database::V1::RestoreDatabaseEncryptionConfig#encryption_type encryption_type}
436
- # is `CUSTOMER_MANAGED_ENCRYPTION`. Values are of the form
429
+ # Optional. The Cloud KMS key that will be used to encrypt/decrypt the restored
430
+ # database. This field should be set only when
431
+ # {::Google::Cloud::Spanner::Admin::Database::V1::RestoreDatabaseEncryptionConfig#encryption_type encryption_type} is
432
+ # `CUSTOMER_MANAGED_ENCRYPTION`. Values are of the form
437
433
  # `projects/<project>/locations/<location>/keyRings/<key_ring>/cryptoKeys/<kms_key_name>`.
438
434
  class RestoreDatabaseEncryptionConfig
439
435
  include ::Google::Protobuf::MessageExts
@@ -445,8 +441,7 @@ module Google
445
441
  ENCRYPTION_TYPE_UNSPECIFIED = 0
446
442
 
447
443
  # This is the default option when
448
- # {::Google::Cloud::Spanner::Admin::Database::V1::RestoreDatabaseEncryptionConfig encryption_config}
449
- # is not specified.
444
+ # {::Google::Cloud::Spanner::Admin::Database::V1::RestoreDatabaseEncryptionConfig encryption_config} is not specified.
450
445
  USE_CONFIG_DEFAULT_OR_BACKUP_ENCRYPTION = 1
451
446
 
452
447
  # Use Google default encryption.
@@ -486,8 +481,7 @@ module Google
486
481
  # operation completed despite cancellation. On successful cancellation,
487
482
  # the operation is not deleted; instead, it becomes an operation with
488
483
  # an {::Google::Longrunning::Operation#error Operation.error} value with a
489
- # {::Google::Rpc::Status#code google.rpc.Status.code} of 1, corresponding to
490
- # `Code.CANCELLED`.
484
+ # {::Google::Rpc::Status#code google.rpc.Status.code} of 1, corresponding to `Code.CANCELLED`.
491
485
  # @!attribute [rw] optimize_database_operation_name
492
486
  # @return [::String]
493
487
  # If exists, the name of the long-running operation that will be used to
@@ -497,10 +491,10 @@ module Google
497
491
  # `projects/<project>/instances/<instance>/databases/<database>/operations/<operation>`
498
492
  # where the <database> is the name of database being created and restored to.
499
493
  # The metadata type of the long-running operation is
500
- # {::Google::Cloud::Spanner::Admin::Database::V1::OptimizeRestoredDatabaseMetadata OptimizeRestoredDatabaseMetadata}.
501
- # This long-running operation will be automatically created by the system
502
- # after the RestoreDatabase long-running operation completes successfully.
503
- # This operation will not be created if the restore was not successful.
494
+ # {::Google::Cloud::Spanner::Admin::Database::V1::OptimizeRestoredDatabaseMetadata OptimizeRestoredDatabaseMetadata}. This long-running operation will be
495
+ # automatically created by the system after the RestoreDatabase long-running
496
+ # operation completes successfully. This operation will not be created if the
497
+ # restore was not successful.
504
498
  class RestoreDatabaseMetadata
505
499
  include ::Google::Protobuf::MessageExts
506
500
  extend ::Google::Protobuf::MessageExts::ClassMethods
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-cloud-spanner-admin-database-v1
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.5.1
4
+ version: 0.6.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2021-04-05 00:00:00.000000000 Z
11
+ date: 2021-04-23 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: gapic-common