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

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

Overview

Encryption information for a Cloud Spanner database or backup.

Defined Under Namespace

Modules: Type

Instance Attribute Summary collapse

Instance Attribute Details

#encryption_status ⇒ ::Google::Rpc::Status (readonly)

Returns 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.

Returns:

  • (::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.



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'proto_docs/google/spanner/admin/database/v1/common.rb', line 85

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

#encryption_type ⇒ ::Google::Cloud::Spanner::Admin::Database::V1::EncryptionInfo::Type (readonly)

Returns Output only. The type of encryption.

Returns:



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'proto_docs/google/spanner/admin/database/v1/common.rb', line 85

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

#kms_key_version ⇒ ::String (readonly)

Returns Output only. A Cloud KMS key version that is being used to protect the database or backup.

Returns:

  • (::String) —

    Output only. A Cloud KMS key version that is being used to protect the database or backup.



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'proto_docs/google/spanner/admin/database/v1/common.rb', line 85

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