google-cloud-spanner-admin-database-v1 0.3.0 → 0.4.0

data/proto_docs/google/spanner/admin/database/v1/common.rb

@@ -40,6 +40,51 @@ module Google
               include ::Google::Protobuf::MessageExts
               extend ::Google::Protobuf::MessageExts::ClassMethods
             end
+
+            # Encryption configuration for a Cloud Spanner database.
+            # @!attribute [rw] kms_key_name
+            #   @return [::String]
+            #     The Cloud KMS key to be used for encrypting and decrypting
+            #     the database. Values are of the form
+            #     `projects/<project>/locations/<location>/keyRings/<key_ring>/cryptoKeys/<kms_key_name>`.
+            class EncryptionConfig
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+
+            # Encryption information for a Cloud Spanner database or backup.
+            # @!attribute [r] encryption_type
+            #   @return [::Google::Cloud::Spanner::Admin::Database::V1::EncryptionInfo::Type]
+            #     Output only. The type of encryption.
+            # @!attribute [r] encryption_status
+            #   @return [::Google::Rpc::Status]
+            #     Output only. If present, the status of a recent encrypt/decrypt call on
+            #     underlying data for this database or backup. Regardless of status, data is
+            #     always encrypted at rest.
+            # @!attribute [r] kms_key_version
+            #   @return [::String]
+            #     Output only. A Cloud KMS key version that is being used to protect the
+            #     database or backup.
+            class EncryptionInfo
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+
+              # Possible encryption types.
+              module Type
+                # Encryption type was not specified, though data at rest remains encrypted.
+                TYPE_UNSPECIFIED = 0
+
+                # The data is encrypted at rest with a key that is
+                # fully managed by Google. No key version or status will be populated.
+                # This is the default state.
+                GOOGLE_DEFAULT_ENCRYPTION = 1
+
+                # The data is encrypted at rest with a key that is
+                # managed by the customer. The active version of the key. `kms_key_version`
+                # will be populated, and `encryption_status` may be populated.
+                CUSTOMER_MANAGED_ENCRYPTION = 2
+              end
+            end
           end
         end
       end

data/proto_docs/google/spanner/admin/database/v1/spanner_database_admin.rb

@@ -54,17 +54,37 @@ module Google
             #   @return [::Google::Cloud::Spanner::Admin::Database::V1::RestoreInfo]
             #     Output only. Applicable only for restored databases. Contains information
             #     about the restore source.
+            # @!attribute [r] encryption_config
+            #   @return [::Google::Cloud::Spanner::Admin::Database::V1::EncryptionConfig]
+            #     Output only. For databases that are using customer managed encryption, this
+            #     field contains the encryption configuration for the database.
+            #     For databases that are using Google default or other types of encryption,
+            #     this field is empty.
+            # @!attribute [r] encryption_info
+            #   @return [::Array<::Google::Cloud::Spanner::Admin::Database::V1::EncryptionInfo>]
+            #     Output only. For databases that are using customer managed encryption, this
+            #     field contains the encryption information for the database, such as
+            #     encryption state and the Cloud KMS key versions that are in use.
+            #
+            #     For databases that are using Google default or other types of encryption,
+            #     this field is empty.
+            #
+            #     This field is propagated lazily from the backend. There might be a delay
+            #     from when a key version is being used and when it appears in this field.
             # @!attribute [r] version_retention_period
             #   @return [::String]
             #     Output only. The period in which Cloud Spanner retains all versions of data
             #     for the database. This is the same as the value of version_retention_period
             #     database option set using
-            #     {::Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdmin::Client#update_database_ddl UpdateDatabaseDdl}. Defaults to 1 hour,
-            #     if not set.
+            #     {::Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdmin::Client#update_database_ddl UpdateDatabaseDdl}.
+            #     Defaults to 1 hour, if not set.
             # @!attribute [r] earliest_version_time
             #   @return [::Google::Protobuf::Timestamp]
             #     Output only. Earliest timestamp at which older versions of the data can be
-            #     read.
+            #     read. This value is continuously updated by Cloud Spanner and becomes stale
+            #     the moment it is queried. If you are using this value to recover data, make
+            #     sure to account for the time from the moment when the value is queried to
+            #     the moment when you initiate the recovery.
             class Database
               include ::Google::Protobuf::MessageExts
               extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -93,7 +113,8 @@ module Google
               end
             end
 
-            # The request for {::Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdmin::Client#list_databases ListDatabases}.
+            # The request for
+            # {::Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdmin::Client#list_databases ListDatabases}.
             # @!attribute [rw] parent
             #   @return [::String]
             #     Required. The instance whose databases should be listed.
@@ -105,28 +126,31 @@ module Google
             # @!attribute [rw] page_token
             #   @return [::String]
             #     If non-empty, `page_token` should contain a
-            #     {::Google::Cloud::Spanner::Admin::Database::V1::ListDatabasesResponse#next_page_token next_page_token} from a
-            #     previous {::Google::Cloud::Spanner::Admin::Database::V1::ListDatabasesResponse ListDatabasesResponse}.
+            #     {::Google::Cloud::Spanner::Admin::Database::V1::ListDatabasesResponse#next_page_token next_page_token}
+            #     from a previous
+            #     {::Google::Cloud::Spanner::Admin::Database::V1::ListDatabasesResponse ListDatabasesResponse}.
             class ListDatabasesRequest
               include ::Google::Protobuf::MessageExts
               extend ::Google::Protobuf::MessageExts::ClassMethods
             end
 
-            # The response for {::Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdmin::Client#list_databases ListDatabases}.
+            # The response for
+            # {::Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdmin::Client#list_databases ListDatabases}.
             # @!attribute [rw] databases
             #   @return [::Array<::Google::Cloud::Spanner::Admin::Database::V1::Database>]
             #     Databases that matched the request.
             # @!attribute [rw] next_page_token
             #   @return [::String]
             #     `next_page_token` can be sent in a subsequent
-            #     {::Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdmin::Client#list_databases ListDatabases} call to fetch more
-            #     of the matching databases.
+            #     {::Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdmin::Client#list_databases ListDatabases}
+            #     call to fetch more of the matching databases.
             class ListDatabasesResponse
               include ::Google::Protobuf::MessageExts
               extend ::Google::Protobuf::MessageExts::ClassMethods
             end
 
-            # The request for {::Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdmin::Client#create_database CreateDatabase}.
+            # The request for
+            # {::Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdmin::Client#create_database CreateDatabase}.
             # @!attribute [rw] parent
             #   @return [::String]
             #     Required. The name of the instance that will serve the new database.
@@ -144,6 +168,11 @@ module Google
             #     database. Statements can create tables, indexes, etc. These
             #     statements execute atomically with the creation of the database:
             #     if there is an error in any statement, the database is not created.
+            # @!attribute [rw] encryption_config
+            #   @return [::Google::Cloud::Spanner::Admin::Database::V1::EncryptionConfig]
+            #     Optional. The encryption configuration for the database. If this field is
+            #     not specified, Cloud Spanner will encrypt/decrypt all data at rest using
+            #     Google default encryption.
             class CreateDatabaseRequest
               include ::Google::Protobuf::MessageExts
               extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -159,7 +188,8 @@ module Google
               extend ::Google::Protobuf::MessageExts::ClassMethods
             end
 
-            # The request for {::Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdmin::Client#get_database GetDatabase}.
+            # The request for
+            # {::Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdmin::Client#get_database GetDatabase}.
             # @!attribute [rw] name
             #   @return [::String]
             #     Required. The name of the requested database. Values are of the form
@@ -183,8 +213,8 @@ module Google
             # Each batch of statements is assigned a name which can be used with
             # the Operations API to monitor
             # progress. See the
-            # {::Google::Cloud::Spanner::Admin::Database::V1::UpdateDatabaseDdlRequest#operation_id operation_id} field for more
-            # details.
+            # {::Google::Cloud::Spanner::Admin::Database::V1::UpdateDatabaseDdlRequest#operation_id operation_id}
+            # field for more details.
             # @!attribute [rw] database
             #   @return [::String]
             #     Required. The database to update.
@@ -200,18 +230,20 @@ module Google
             #
             #     Specifying an explicit operation ID simplifies determining
             #     whether the statements were executed in the event that the
-            #     {::Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdmin::Client#update_database_ddl UpdateDatabaseDdl} call is replayed,
-            #     or the return value is otherwise lost: the {::Google::Cloud::Spanner::Admin::Database::V1::UpdateDatabaseDdlRequest#database database} and
-            #     `operation_id` fields can be combined to form the
+            #     {::Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdmin::Client#update_database_ddl UpdateDatabaseDdl}
+            #     call is replayed, or the return value is otherwise lost: the
+            #     {::Google::Cloud::Spanner::Admin::Database::V1::UpdateDatabaseDdlRequest#database database}
+            #     and `operation_id` fields can be combined to form the
             #     {::Google::Longrunning::Operation#name name} of the resulting
-            #     {::Google::Longrunning::Operation longrunning.Operation}: `<database>/operations/<operation_id>`.
+            #     {::Google::Longrunning::Operation longrunning.Operation}:
+            #     `<database>/operations/<operation_id>`.
             #
             #     `operation_id` should be unique within the database, and must be
             #     a valid identifier: `[a-z][a-z0-9_]*`. Note that
             #     automatically-generated operation IDs always begin with an
             #     underscore. If the named operation already exists,
-            #     {::Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdmin::Client#update_database_ddl UpdateDatabaseDdl} returns
-            #     `ALREADY_EXISTS`.
+            #     {::Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdmin::Client#update_database_ddl UpdateDatabaseDdl}
+            #     returns `ALREADY_EXISTS`.
             class UpdateDatabaseDdlRequest
               include ::Google::Protobuf::MessageExts
               extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -241,7 +273,8 @@ module Google
               extend ::Google::Protobuf::MessageExts::ClassMethods
             end
 
-            # The request for {::Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdmin::Client#drop_database DropDatabase}.
+            # The request for
+            # {::Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdmin::Client#drop_database DropDatabase}.
             # @!attribute [rw] database
             #   @return [::String]
             #     Required. The database to be dropped.
@@ -250,7 +283,8 @@ module Google
               extend ::Google::Protobuf::MessageExts::ClassMethods
             end
 
-            # The request for {::Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdmin::Client#get_database_ddl GetDatabaseDdl}.
+            # The request for
+            # {::Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdmin::Client#get_database_ddl GetDatabaseDdl}.
             # @!attribute [rw] database
             #   @return [::String]
             #     Required. The database whose schema we wish to get.
@@ -261,7 +295,8 @@ module Google
               extend ::Google::Protobuf::MessageExts::ClassMethods
             end
 
-            # The response for {::Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdmin::Client#get_database_ddl GetDatabaseDdl}.
+            # The response for
+            # {::Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdmin::Client#get_database_ddl GetDatabaseDdl}.
             # @!attribute [rw] statements
             #   @return [::Array<::String>]
             #     A list of formatted DDL statements defining the schema of the database
@@ -293,7 +328,9 @@ module Google
             #       * `name` - The name of the long-running operation
             #       * `done` - False if the operation is in progress, else true.
             #       * `metadata.@type` - the type of metadata. For example, the type string
-            #          for {::Google::Cloud::Spanner::Admin::Database::V1::RestoreDatabaseMetadata RestoreDatabaseMetadata} is
+            #          for
+            #          {::Google::Cloud::Spanner::Admin::Database::V1::RestoreDatabaseMetadata RestoreDatabaseMetadata}
+            #          is
             #          `type.googleapis.com/google.spanner.admin.database.v1.RestoreDatabaseMetadata`.
             #       * `metadata.<field_name>` - any field in metadata.value.
             #       * `error` - Error associated with the long-running operation.
@@ -313,7 +350,8 @@ module Google
             #         `(metadata.name:restored_howl) AND` \
             #         `(metadata.progress.start_time < \"2018-03-28T14:50:00Z\") AND` \
             #         `(error:*)` - Return operations where:
-            #         * The operation's metadata type is {::Google::Cloud::Spanner::Admin::Database::V1::RestoreDatabaseMetadata RestoreDatabaseMetadata}.
+            #         * The operation's metadata type is
+            #         {::Google::Cloud::Spanner::Admin::Database::V1::RestoreDatabaseMetadata RestoreDatabaseMetadata}.
             #         * The database is restored from a backup.
             #         * The backup name contains "backup_howl".
             #         * The restored database's name contains "restored_howl".
@@ -327,8 +365,9 @@ module Google
             #   @return [::String]
             #     If non-empty, `page_token` should contain a
             #     {::Google::Cloud::Spanner::Admin::Database::V1::ListDatabaseOperationsResponse#next_page_token next_page_token}
-            #     from a previous {::Google::Cloud::Spanner::Admin::Database::V1::ListDatabaseOperationsResponse ListDatabaseOperationsResponse} to the
-            #     same `parent` and with the same `filter`.
+            #     from a previous
+            #     {::Google::Cloud::Spanner::Admin::Database::V1::ListDatabaseOperationsResponse ListDatabaseOperationsResponse}
+            #     to the same `parent` and with the same `filter`.
             class ListDatabaseOperationsRequest
               include ::Google::Protobuf::MessageExts
               extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -372,11 +411,53 @@ module Google
             #   @return [::String]
             #     Name of the backup from which to restore.  Values are of the form
             #     `projects/<project>/instances/<instance>/backups/<backup>`.
+            # @!attribute [rw] encryption_config
+            #   @return [::Google::Cloud::Spanner::Admin::Database::V1::RestoreDatabaseEncryptionConfig]
+            #     Optional. An encryption configuration describing the encryption type and
+            #     key resources in Cloud KMS used to encrypt/decrypt the database to restore
+            #     to. If this field is not specified, the restored database will use the same
+            #     encryption configuration as the backup by default, namely
+            #     {::Google::Cloud::Spanner::Admin::Database::V1::RestoreDatabaseEncryptionConfig#encryption_type encryption_type}
+            #     = `USE_CONFIG_DEFAULT_OR_DATABASE_ENCRYPTION`.
             class RestoreDatabaseRequest
               include ::Google::Protobuf::MessageExts
               extend ::Google::Protobuf::MessageExts::ClassMethods
             end
 
+            # Encryption configuration for the restored database.
+            # @!attribute [rw] encryption_type
+            #   @return [::Google::Cloud::Spanner::Admin::Database::V1::RestoreDatabaseEncryptionConfig::EncryptionType]
+            #     Required. The encryption type of the restored database.
+            # @!attribute [rw] kms_key_name
+            #   @return [::String]
+            #     Optional. The Cloud KMS key that will be used to encrypt/decrypt the
+            #     restored database. This field should be set only when
+            #     {::Google::Cloud::Spanner::Admin::Database::V1::RestoreDatabaseEncryptionConfig#encryption_type encryption_type}
+            #     is `CUSTOMER_MANAGED_ENCRYPTION`. Values are of the form
+            #     `projects/<project>/locations/<location>/keyRings/<key_ring>/cryptoKeys/<kms_key_name>`.
+            class RestoreDatabaseEncryptionConfig
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+
+              # Encryption types for the database to be restored.
+              module EncryptionType
+                # Unspecified. Do not use.
+                ENCRYPTION_TYPE_UNSPECIFIED = 0
+
+                # This is the default option when
+                # {::Google::Cloud::Spanner::Admin::Database::V1::RestoreDatabaseEncryptionConfig encryption_config}
+                # is not specified.
+                USE_CONFIG_DEFAULT_OR_BACKUP_ENCRYPTION = 1
+
+                # Use Google default encryption.
+                GOOGLE_DEFAULT_ENCRYPTION = 2
+
+                # Use customer managed encryption. If specified, `kms_key_name` must
+                # must contain a valid Cloud KMS key.
+                CUSTOMER_MANAGED_ENCRYPTION = 3
+              end
+            end
+
             # Metadata type for the long-running operation returned by
             # {::Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdmin::Client#restore_database RestoreDatabase}.
             # @!attribute [rw] name
@@ -405,7 +486,8 @@ module Google
             #     operation completed despite cancellation. On successful cancellation,
             #     the operation is not deleted; instead, it becomes an operation with
             #     an {::Google::Longrunning::Operation#error Operation.error} value with a
-            #     {::Google::Rpc::Status#code google.rpc.Status.code} of 1, corresponding to `Code.CANCELLED`.
+            #     {::Google::Rpc::Status#code google.rpc.Status.code} of 1, corresponding to
+            #     `Code.CANCELLED`.
             # @!attribute [rw] optimize_database_operation_name
             #   @return [::String]
             #     If exists, the name of the long-running operation that will be used to
@@ -415,10 +497,10 @@ module Google
             #     `projects/<project>/instances/<instance>/databases/<database>/operations/<operation>`
             #     where the <database> is the name of database being created and restored to.
             #     The metadata type of the  long-running operation is
-            #     {::Google::Cloud::Spanner::Admin::Database::V1::OptimizeRestoredDatabaseMetadata OptimizeRestoredDatabaseMetadata}. This long-running operation will be
-            #     automatically created by the system after the RestoreDatabase long-running
-            #     operation completes successfully. This operation will not be created if the
-            #     restore was not successful.
+            #     {::Google::Cloud::Spanner::Admin::Database::V1::OptimizeRestoredDatabaseMetadata OptimizeRestoredDatabaseMetadata}.
+            #     This long-running operation will be automatically created by the system
+            #     after the RestoreDatabase long-running operation completes successfully.
+            #     This operation will not be created if the restore was not successful.
             class RestoreDatabaseMetadata
               include ::Google::Protobuf::MessageExts
               extend ::Google::Protobuf::MessageExts::ClassMethods

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-spanner-admin-database-v1
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-02-02 00:00:00.000000000 Z
+date: 2021-02-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gapic-common