Class: Google::Cloud::Spanner::Admin::Database::V1::RestoreDatabaseEncryptionConfig

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/spanner/admin/database/v1/spanner_database_admin.rb

Overview

Encryption configuration for the restored database.

Defined Under Namespace

Modules: EncryptionType

Instance Attribute Summary collapse

Instance Attribute Details

#encryption_type ⇒ ::Google::Cloud::Spanner::Admin::Database::V1::RestoreDatabaseEncryptionConfig::EncryptionType

Returns Required. The encryption type of the restored database.

Returns:



561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
 
# File 'proto_docs/google/spanner/admin/database/v1/spanner_database_admin.rb', line 561

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

#kms_key_name ⇒ ::String

Returns Optional. The Cloud KMS key that will be used to encrypt/decrypt the restored database. This field should be set only when encryption_type is CUSTOMER_MANAGED_ENCRYPTION. Values are of the form projects/<project>/locations/<location>/keyRings/<key_ring>/cryptoKeys/<kms_key_name>.

Returns:

  • (::String) —

    Optional. The Cloud KMS key that will be used to encrypt/decrypt the restored database. This field should be set only when encryption_type is CUSTOMER_MANAGED_ENCRYPTION. Values are of the form projects/<project>/locations/<location>/keyRings/<key_ring>/cryptoKeys/<kms_key_name>.



561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
 
# File 'proto_docs/google/spanner/admin/database/v1/spanner_database_admin.rb', line 561

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