google-cloud-spanner-admin-database-v1 0.2.1 → 0.6.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,6 +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.
+            # @!attribute [r] earliest_version_time
+            #   @return [::Google::Protobuf::Timestamp]
+            #     Output only. Earliest timestamp at which older versions of the data can be
+            #     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
@@ -133,6 +164,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
@@ -225,6 +261,16 @@ module Google
             #     Output only. When true, indicates that the operation is throttled e.g
             #     due to resource constraints. When resources become available the operation
             #     will resume and this field will be false again.
+            # @!attribute [rw] progress
+            #   @return [::Array<::Google::Cloud::Spanner::Admin::Database::V1::OperationProgress>]
+            #     The progress of the
+            #     {::Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdmin::Client#update_database_ddl UpdateDatabaseDdl} operations.
+            #     Currently, only index creation statements will have a continuously
+            #     updating progress.
+            #     For non-index creation statements, `progress[i]` will have start time
+            #     and end time populated with commit timestamp of operation,
+            #     as well as a progress of 100% once the operation has completed.
+            #     `progress[i]` is the operation progress for `statements[i]`.
             class UpdateDatabaseDdlMetadata
               include ::Google::Protobuf::MessageExts
               extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -243,6 +289,8 @@ module Google
             # @!attribute [rw] database
             #   @return [::String]
             #     Required. The database whose schema we wish to get.
+            #     Values are of the form
+            #     `projects/<project>/instances/<instance>/databases/<database>`
             class GetDatabaseDdlRequest
               include ::Google::Protobuf::MessageExts
               extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -294,11 +342,11 @@ module Google
             #     Here are a few examples:
             #
             #       * `done:true` - The operation is complete.
-            #       * `(metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.RestoreDatabaseMetadata) AND` <br/>
-            #         `(metadata.source_type:BACKUP) AND` <br/>
-            #         `(metadata.backup_info.backup:backup_howl) AND` <br/>
-            #         `(metadata.name:restored_howl) AND` <br/>
-            #         `(metadata.progress.start_time < \"2018-03-28T14:50:00Z\") AND` <br/>
+            #       * `(metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.RestoreDatabaseMetadata) AND` \
+            #         `(metadata.source_type:BACKUP) AND` \
+            #         `(metadata.backup_info.backup:backup_howl) AND` \
+            #         `(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 database is restored from a backup.
@@ -359,11 +407,52 @@ 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_BACKUP_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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-spanner-admin-database-v1
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.6.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-01-20 00:00:00.000000000 Z
+date: 2021-04-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gapic-common
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '0.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '0.4'
 - !ruby/object:Gem::Dependency
   name: google-cloud-errors
   requirement: !ruby/object:Gem::Requirement
@@ -64,14 +64,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.24.0
+        version: 1.25.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.24.0
+        version: 1.25.1
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -171,7 +171,10 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.9'
 description: Cloud Spanner is a managed, mission-critical, globally consistent and
-  scalable relational database service.
+  scalable relational database service. Note that google-cloud-spanner-admin-database-v1
+  is a version-specific client library. For most uses, we recommend installing the
+  main client library google-cloud-spanner-admin-database instead. See the readme
+  for more details.
 email: googleapis-packages@google.com
 executables: []
 extensions: []
@@ -201,6 +204,7 @@ files:
 - proto_docs/google/iam/v1/policy.rb
 - proto_docs/google/longrunning/operations.rb
 - proto_docs/google/protobuf/any.rb
+- proto_docs/google/protobuf/duration.rb
 - proto_docs/google/protobuf/empty.rb
 - proto_docs/google/protobuf/field_mask.rb
 - proto_docs/google/protobuf/timestamp.rb
@@ -221,14 +225,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.4'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.6
+rubygems_version: 3.2.13
 signing_key: 
 specification_version: 4
 summary: API Client library for the Cloud Spanner Database Admin V1 API