google-cloud-spanner-admin-database-v1 0.18.0 → 0.19.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -64,7 +64,8 @@ module Google
64
64
  # @return [::Array<::Google::Cloud::Spanner::Admin::Database::V1::EncryptionInfo>]
65
65
  # Output only. For databases that are using customer managed encryption, this
66
66
  # field contains the encryption information for the database, such as
67
- # encryption state and the Cloud KMS key versions that are in use.
67
+ # all Cloud KMS key versions that are in use. The `encryption_status' field
68
+ # inside of each `EncryptionInfo` is not populated.
68
69
  #
69
70
  # For databases that are using Google default or other types of encryption,
70
71
  # this field is empty.
@@ -76,8 +77,8 @@ module Google
76
77
  # Output only. The period in which Cloud Spanner retains all versions of data
77
78
  # for the database. This is the same as the value of version_retention_period
78
79
  # database option set using
79
- # {::Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdmin::Client#update_database_ddl UpdateDatabaseDdl}. Defaults to 1 hour,
80
- # if not set.
80
+ # {::Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdmin::Client#update_database_ddl UpdateDatabaseDdl}.
81
+ # Defaults to 1 hour, if not set.
81
82
  # @!attribute [r] earliest_version_time
82
83
  # @return [::Google::Protobuf::Timestamp]
83
84
  # Output only. Earliest timestamp at which older versions of the data can be
@@ -99,7 +100,9 @@ module Google
99
100
  # @!attribute [rw] enable_drop_protection
100
101
  # @return [::Boolean]
101
102
  # Whether drop protection is enabled for this database. Defaults to false,
102
- # if not set.
103
+ # if not set. For more details, please see how to [prevent accidental
104
+ # database
105
+ # deletion](https://cloud.google.com/spanner/docs/prevent-database-deletion).
103
106
  # @!attribute [r] reconciling
104
107
  # @return [::Boolean]
105
108
  # Output only. If true, the database is being updated. If false, there are no
@@ -132,7 +135,8 @@ module Google
132
135
  end
133
136
  end
134
137
 
135
- # The request for {::Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdmin::Client#list_databases ListDatabases}.
138
+ # The request for
139
+ # {::Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdmin::Client#list_databases ListDatabases}.
136
140
  # @!attribute [rw] parent
137
141
  # @return [::String]
138
142
  # Required. The instance whose databases should be listed.
@@ -144,28 +148,31 @@ module Google
144
148
  # @!attribute [rw] page_token
145
149
  # @return [::String]
146
150
  # If non-empty, `page_token` should contain a
147
- # {::Google::Cloud::Spanner::Admin::Database::V1::ListDatabasesResponse#next_page_token next_page_token} from a
148
- # previous {::Google::Cloud::Spanner::Admin::Database::V1::ListDatabasesResponse ListDatabasesResponse}.
151
+ # {::Google::Cloud::Spanner::Admin::Database::V1::ListDatabasesResponse#next_page_token next_page_token}
152
+ # from a previous
153
+ # {::Google::Cloud::Spanner::Admin::Database::V1::ListDatabasesResponse ListDatabasesResponse}.
149
154
  class ListDatabasesRequest
150
155
  include ::Google::Protobuf::MessageExts
151
156
  extend ::Google::Protobuf::MessageExts::ClassMethods
152
157
  end
153
158
 
154
- # The response for {::Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdmin::Client#list_databases ListDatabases}.
159
+ # The response for
160
+ # {::Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdmin::Client#list_databases ListDatabases}.
155
161
  # @!attribute [rw] databases
156
162
  # @return [::Array<::Google::Cloud::Spanner::Admin::Database::V1::Database>]
157
163
  # Databases that matched the request.
158
164
  # @!attribute [rw] next_page_token
159
165
  # @return [::String]
160
166
  # `next_page_token` can be sent in a subsequent
161
- # {::Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdmin::Client#list_databases ListDatabases} call to fetch more
162
- # of the matching databases.
167
+ # {::Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdmin::Client#list_databases ListDatabases}
168
+ # call to fetch more of the matching databases.
163
169
  class ListDatabasesResponse
164
170
  include ::Google::Protobuf::MessageExts
165
171
  extend ::Google::Protobuf::MessageExts::ClassMethods
166
172
  end
167
173
 
168
- # The request for {::Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdmin::Client#create_database CreateDatabase}.
174
+ # The request for
175
+ # {::Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdmin::Client#create_database CreateDatabase}.
169
176
  # @!attribute [rw] parent
170
177
  # @return [::String]
171
178
  # Required. The name of the instance that will serve the new database.
@@ -185,8 +192,8 @@ module Google
185
192
  # if there is an error in any statement, the database is not created.
186
193
  # @!attribute [rw] encryption_config
187
194
  # @return [::Google::Cloud::Spanner::Admin::Database::V1::EncryptionConfig]
188
- # Optional. The encryption configuration for the database. If this field is not
189
- # specified, Cloud Spanner will encrypt/decrypt all data at rest using
195
+ # Optional. The encryption configuration for the database. If this field is
196
+ # not specified, Cloud Spanner will encrypt/decrypt all data at rest using
190
197
  # Google default encryption.
191
198
  # @!attribute [rw] database_dialect
192
199
  # @return [::Google::Cloud::Spanner::Admin::Database::V1::DatabaseDialect]
@@ -223,7 +230,8 @@ module Google
223
230
  extend ::Google::Protobuf::MessageExts::ClassMethods
224
231
  end
225
232
 
226
- # The request for {::Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdmin::Client#get_database GetDatabase}.
233
+ # The request for
234
+ # {::Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdmin::Client#get_database GetDatabase}.
227
235
  # @!attribute [rw] name
228
236
  # @return [::String]
229
237
  # Required. The name of the requested database. Values are of the form
@@ -283,8 +291,8 @@ module Google
283
291
  # Each batch of statements is assigned a name which can be used with
284
292
  # the Operations API to monitor
285
293
  # progress. See the
286
- # {::Google::Cloud::Spanner::Admin::Database::V1::UpdateDatabaseDdlRequest#operation_id operation_id} field for more
287
- # details.
294
+ # {::Google::Cloud::Spanner::Admin::Database::V1::UpdateDatabaseDdlRequest#operation_id operation_id}
295
+ # field for more details.
288
296
  # @!attribute [rw] database
289
297
  # @return [::String]
290
298
  # Required. The database to update.
@@ -300,18 +308,20 @@ module Google
300
308
  #
301
309
  # Specifying an explicit operation ID simplifies determining
302
310
  # whether the statements were executed in the event that the
303
- # {::Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdmin::Client#update_database_ddl UpdateDatabaseDdl} call is replayed,
304
- # or the return value is otherwise lost: the {::Google::Cloud::Spanner::Admin::Database::V1::UpdateDatabaseDdlRequest#database database} and
305
- # `operation_id` fields can be combined to form the
311
+ # {::Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdmin::Client#update_database_ddl UpdateDatabaseDdl}
312
+ # call is replayed, or the return value is otherwise lost: the
313
+ # {::Google::Cloud::Spanner::Admin::Database::V1::UpdateDatabaseDdlRequest#database database}
314
+ # and `operation_id` fields can be combined to form the
306
315
  # {::Google::Longrunning::Operation#name name} of the resulting
307
- # {::Google::Longrunning::Operation longrunning.Operation}: `<database>/operations/<operation_id>`.
316
+ # {::Google::Longrunning::Operation longrunning.Operation}:
317
+ # `<database>/operations/<operation_id>`.
308
318
  #
309
319
  # `operation_id` should be unique within the database, and must be
310
320
  # a valid identifier: `[a-z][a-z0-9_]*`. Note that
311
321
  # automatically-generated operation IDs always begin with an
312
322
  # underscore. If the named operation already exists,
313
- # {::Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdmin::Client#update_database_ddl UpdateDatabaseDdl} returns
314
- # `ALREADY_EXISTS`.
323
+ # {::Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdmin::Client#update_database_ddl UpdateDatabaseDdl}
324
+ # returns `ALREADY_EXISTS`.
315
325
  # @!attribute [rw] proto_descriptors
316
326
  # @return [::String]
317
327
  # Optional. Proto descriptors used by CREATE/ALTER PROTO BUNDLE statements.
@@ -394,7 +404,8 @@ module Google
394
404
  extend ::Google::Protobuf::MessageExts::ClassMethods
395
405
  end
396
406
 
397
- # The request for {::Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdmin::Client#drop_database DropDatabase}.
407
+ # The request for
408
+ # {::Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdmin::Client#drop_database DropDatabase}.
398
409
  # @!attribute [rw] database
399
410
  # @return [::String]
400
411
  # Required. The database to be dropped.
@@ -403,7 +414,8 @@ module Google
403
414
  extend ::Google::Protobuf::MessageExts::ClassMethods
404
415
  end
405
416
 
406
- # The request for {::Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdmin::Client#get_database_ddl GetDatabaseDdl}.
417
+ # The request for
418
+ # {::Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdmin::Client#get_database_ddl GetDatabaseDdl}.
407
419
  # @!attribute [rw] database
408
420
  # @return [::String]
409
421
  # Required. The database whose schema we wish to get.
@@ -414,7 +426,8 @@ module Google
414
426
  extend ::Google::Protobuf::MessageExts::ClassMethods
415
427
  end
416
428
 
417
- # The response for {::Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdmin::Client#get_database_ddl GetDatabaseDdl}.
429
+ # The response for
430
+ # {::Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdmin::Client#get_database_ddl GetDatabaseDdl}.
418
431
  # @!attribute [rw] statements
419
432
  # @return [::Array<::String>]
420
433
  # A list of formatted DDL statements defining the schema of the database
@@ -453,7 +466,9 @@ module Google
453
466
  # * `name` - The name of the long-running operation
454
467
  # * `done` - False if the operation is in progress, else true.
455
468
  # * `metadata.@type` - the type of metadata. For example, the type string
456
- # for {::Google::Cloud::Spanner::Admin::Database::V1::RestoreDatabaseMetadata RestoreDatabaseMetadata} is
469
+ # for
470
+ # {::Google::Cloud::Spanner::Admin::Database::V1::RestoreDatabaseMetadata RestoreDatabaseMetadata}
471
+ # is
457
472
  # `type.googleapis.com/google.spanner.admin.database.v1.RestoreDatabaseMetadata`.
458
473
  # * `metadata.<field_name>` - any field in metadata.value.
459
474
  # `metadata.@type` must be specified first, if filtering on metadata
@@ -475,7 +490,8 @@ module Google
475
490
  # `(metadata.name:restored_howl) AND` \
476
491
  # `(metadata.progress.start_time < \"2018-03-28T14:50:00Z\") AND` \
477
492
  # `(error:*)` - Return operations where:
478
- # * The operation's metadata type is {::Google::Cloud::Spanner::Admin::Database::V1::RestoreDatabaseMetadata RestoreDatabaseMetadata}.
493
+ # * The operation's metadata type is
494
+ # {::Google::Cloud::Spanner::Admin::Database::V1::RestoreDatabaseMetadata RestoreDatabaseMetadata}.
479
495
  # * The database is restored from a backup.
480
496
  # * The backup name contains "backup_howl".
481
497
  # * The restored database's name contains "restored_howl".
@@ -489,8 +505,9 @@ module Google
489
505
  # @return [::String]
490
506
  # If non-empty, `page_token` should contain a
491
507
  # {::Google::Cloud::Spanner::Admin::Database::V1::ListDatabaseOperationsResponse#next_page_token next_page_token}
492
- # from a previous {::Google::Cloud::Spanner::Admin::Database::V1::ListDatabaseOperationsResponse ListDatabaseOperationsResponse} to the
493
- # same `parent` and with the same `filter`.
508
+ # from a previous
509
+ # {::Google::Cloud::Spanner::Admin::Database::V1::ListDatabaseOperationsResponse ListDatabaseOperationsResponse}
510
+ # to the same `parent` and with the same `filter`.
494
511
  class ListDatabaseOperationsRequest
495
512
  include ::Google::Protobuf::MessageExts
496
513
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -536,12 +553,12 @@ module Google
536
553
  # `projects/<project>/instances/<instance>/backups/<backup>`.
537
554
  # @!attribute [rw] encryption_config
538
555
  # @return [::Google::Cloud::Spanner::Admin::Database::V1::RestoreDatabaseEncryptionConfig]
539
- # Optional. An encryption configuration describing the encryption type and key
540
- # resources in Cloud KMS used to encrypt/decrypt the database to restore to.
541
- # If this field is not specified, the restored database will use
542
- # the same encryption configuration as the backup by default, namely
543
- # {::Google::Cloud::Spanner::Admin::Database::V1::RestoreDatabaseEncryptionConfig#encryption_type encryption_type} =
544
- # `USE_CONFIG_DEFAULT_OR_BACKUP_ENCRYPTION`.
556
+ # Optional. An encryption configuration describing the encryption type and
557
+ # key resources in Cloud KMS used to encrypt/decrypt the database to restore
558
+ # to. If this field is not specified, the restored database will use the same
559
+ # encryption configuration as the backup by default, namely
560
+ # {::Google::Cloud::Spanner::Admin::Database::V1::RestoreDatabaseEncryptionConfig#encryption_type encryption_type}
561
+ # = `USE_CONFIG_DEFAULT_OR_BACKUP_ENCRYPTION`.
545
562
  class RestoreDatabaseRequest
546
563
  include ::Google::Protobuf::MessageExts
547
564
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -553,11 +570,28 @@ module Google
553
570
  # Required. The encryption type of the restored database.
554
571
  # @!attribute [rw] kms_key_name
555
572
  # @return [::String]
556
- # Optional. The Cloud KMS key that will be used to encrypt/decrypt the restored
557
- # database. This field should be set only when
558
- # {::Google::Cloud::Spanner::Admin::Database::V1::RestoreDatabaseEncryptionConfig#encryption_type encryption_type} is
559
- # `CUSTOMER_MANAGED_ENCRYPTION`. Values are of the form
573
+ # Optional. The Cloud KMS key that will be used to encrypt/decrypt the
574
+ # restored database. This field should be set only when
575
+ # {::Google::Cloud::Spanner::Admin::Database::V1::RestoreDatabaseEncryptionConfig#encryption_type encryption_type}
576
+ # is `CUSTOMER_MANAGED_ENCRYPTION`. Values are of the form
577
+ # `projects/<project>/locations/<location>/keyRings/<key_ring>/cryptoKeys/<kms_key_name>`.
578
+ # @!attribute [rw] kms_key_names
579
+ # @return [::Array<::String>]
580
+ # Optional. Specifies the KMS configuration for the one or more keys used to
581
+ # encrypt the database. Values are of the form
560
582
  # `projects/<project>/locations/<location>/keyRings/<key_ring>/cryptoKeys/<kms_key_name>`.
583
+ #
584
+ # The keys referenced by kms_key_names must fully cover all
585
+ # regions of the database instance configuration. Some examples:
586
+ # * For single region database instance configs, specify a single regional
587
+ # location KMS key.
588
+ # * For multi-regional database instance configs of type GOOGLE_MANAGED,
589
+ # either specify a multi-regional location KMS key or multiple regional
590
+ # location KMS keys that cover all regions in the instance config.
591
+ # * For a database instance config of type USER_MANAGED, please specify only
592
+ # regional location KMS keys to cover each region in the instance config.
593
+ # Multi-regional location KMS keys are not supported for USER_MANAGED
594
+ # instance configs.
561
595
  class RestoreDatabaseEncryptionConfig
562
596
  include ::Google::Protobuf::MessageExts
563
597
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -568,7 +602,8 @@ module Google
568
602
  ENCRYPTION_TYPE_UNSPECIFIED = 0
569
603
 
570
604
  # This is the default option when
571
- # {::Google::Cloud::Spanner::Admin::Database::V1::RestoreDatabaseEncryptionConfig encryption_config} is not specified.
605
+ # {::Google::Cloud::Spanner::Admin::Database::V1::RestoreDatabaseEncryptionConfig encryption_config}
606
+ # is not specified.
572
607
  USE_CONFIG_DEFAULT_OR_BACKUP_ENCRYPTION = 1
573
608
 
574
609
  # Use Google default encryption.
@@ -608,7 +643,8 @@ module Google
608
643
  # operation completed despite cancellation. On successful cancellation,
609
644
  # the operation is not deleted; instead, it becomes an operation with
610
645
  # an {::Google::Longrunning::Operation#error Operation.error} value with a
611
- # {::Google::Rpc::Status#code google.rpc.Status.code} of 1, corresponding to `Code.CANCELLED`.
646
+ # {::Google::Rpc::Status#code google.rpc.Status.code} of 1, corresponding to
647
+ # `Code.CANCELLED`.
612
648
  # @!attribute [rw] optimize_database_operation_name
613
649
  # @return [::String]
614
650
  # If exists, the name of the long-running operation that will be used to
@@ -618,10 +654,10 @@ module Google
618
654
  # `projects/<project>/instances/<instance>/databases/<database>/operations/<operation>`
619
655
  # where the <database> is the name of database being created and restored to.
620
656
  # The metadata type of the long-running operation is
621
- # {::Google::Cloud::Spanner::Admin::Database::V1::OptimizeRestoredDatabaseMetadata OptimizeRestoredDatabaseMetadata}. This long-running operation will be
622
- # automatically created by the system after the RestoreDatabase long-running
623
- # operation completes successfully. This operation will not be created if the
624
- # restore was not successful.
657
+ # {::Google::Cloud::Spanner::Admin::Database::V1::OptimizeRestoredDatabaseMetadata OptimizeRestoredDatabaseMetadata}.
658
+ # This long-running operation will be automatically created by the system
659
+ # after the RestoreDatabase long-running operation completes successfully.
660
+ # This operation will not be created if the restore was not successful.
625
661
  class RestoreDatabaseMetadata
626
662
  include ::Google::Protobuf::MessageExts
627
663
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -646,21 +682,20 @@ module Google
646
682
  # @!attribute [rw] name
647
683
  # @return [::String]
648
684
  # Required. The name of the database role. Values are of the form
649
- # `projects/<project>/instances/<instance>/databases/<database>/databaseRoles/
650
- # \\{role}`, where `<role>` is as specified in the `CREATE ROLE`
651
- # DDL statement. This name can be passed to Get/Set IAMPolicy methods to
652
- # identify the database role.
685
+ # `projects/<project>/instances/<instance>/databases/<database>/databaseRoles/<role>`
686
+ # where `<role>` is as specified in the `CREATE ROLE` DDL statement.
653
687
  class DatabaseRole
654
688
  include ::Google::Protobuf::MessageExts
655
689
  extend ::Google::Protobuf::MessageExts::ClassMethods
656
690
  end
657
691
 
658
- # The request for {::Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdmin::Client#list_database_roles ListDatabaseRoles}.
692
+ # The request for
693
+ # {::Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdmin::Client#list_database_roles ListDatabaseRoles}.
659
694
  # @!attribute [rw] parent
660
695
  # @return [::String]
661
696
  # Required. The database whose roles should be listed.
662
697
  # Values are of the form
663
- # `projects/<project>/instances/<instance>/databases/<database>/databaseRoles`.
698
+ # `projects/<project>/instances/<instance>/databases/<database>`.
664
699
  # @!attribute [rw] page_size
665
700
  # @return [::Integer]
666
701
  # Number of database roles to be returned in the response. If 0 or less,
@@ -668,14 +703,16 @@ module Google
668
703
  # @!attribute [rw] page_token
669
704
  # @return [::String]
670
705
  # If non-empty, `page_token` should contain a
671
- # {::Google::Cloud::Spanner::Admin::Database::V1::ListDatabaseRolesResponse#next_page_token next_page_token} from a
672
- # previous {::Google::Cloud::Spanner::Admin::Database::V1::ListDatabaseRolesResponse ListDatabaseRolesResponse}.
706
+ # {::Google::Cloud::Spanner::Admin::Database::V1::ListDatabaseRolesResponse#next_page_token next_page_token}
707
+ # from a previous
708
+ # {::Google::Cloud::Spanner::Admin::Database::V1::ListDatabaseRolesResponse ListDatabaseRolesResponse}.
673
709
  class ListDatabaseRolesRequest
674
710
  include ::Google::Protobuf::MessageExts
675
711
  extend ::Google::Protobuf::MessageExts::ClassMethods
676
712
  end
677
713
 
678
- # The response for {::Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdmin::Client#list_database_roles ListDatabaseRoles}.
714
+ # The response for
715
+ # {::Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdmin::Client#list_database_roles ListDatabaseRoles}.
679
716
  # @!attribute [rw] database_roles
680
717
  # @return [::Array<::Google::Cloud::Spanner::Admin::Database::V1::DatabaseRole>]
681
718
  # Database roles that matched the request.
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.18.0
4
+ version: 0.19.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: 2024-02-26 00:00:00.000000000 Z
11
+ date: 2024-05-15 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: gapic-common