Class: Google::Cloud::Bigtable::Admin::V2::EncryptionInfo

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/bigtable/admin/v2/table.rb

Overview

Encryption information for a given resource. If this resource is protected with customer managed encryption, the in-use Cloud Key Management Service (Cloud KMS) key version is specified along with its status.

Defined Under Namespace

Modules: EncryptionType

Instance Attribute Summary collapse

Instance Attribute Details

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

Returns Output only. The status of encrypt/decrypt calls on underlying data for this resource. Regardless of status, the existing data is always encrypted at rest.

Returns:

  • (::Google::Rpc::Status) —

    Output only. The status of encrypt/decrypt calls on underlying data for this resource. Regardless of status, the existing data is always encrypted at rest.



374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
 
# File 'proto_docs/google/bigtable/admin/v2/table.rb', line 374

class EncryptionInfo
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Possible encryption types for a resource.
  module EncryptionType
    # Encryption type was not specified, though data at rest remains encrypted.
    ENCRYPTION_TYPE_UNSPECIFIED = 0

    # The data backing this resource 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 backing this resource is encrypted at rest with a key that is
    # managed by the customer.
    # The in-use version of the key and its status are populated for
    # CMEK-protected tables.
    # CMEK-protected backups are pinned to the key version that was in use at
    # the time the backup was taken. This key version is populated but its
    # status is not tracked and is reported as `UNKNOWN`.
    CUSTOMER_MANAGED_ENCRYPTION = 2
  end
end

#encryption_type ⇒ ::Google::Cloud::Bigtable::Admin::V2::EncryptionInfo::EncryptionType (readonly)

Returns Output only. The type of encryption used to protect this resource.

Returns:



374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
 
# File 'proto_docs/google/bigtable/admin/v2/table.rb', line 374

class EncryptionInfo
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Possible encryption types for a resource.
  module EncryptionType
    # Encryption type was not specified, though data at rest remains encrypted.
    ENCRYPTION_TYPE_UNSPECIFIED = 0

    # The data backing this resource 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 backing this resource is encrypted at rest with a key that is
    # managed by the customer.
    # The in-use version of the key and its status are populated for
    # CMEK-protected tables.
    # CMEK-protected backups are pinned to the key version that was in use at
    # the time the backup was taken. This key version is populated but its
    # status is not tracked and is reported as `UNKNOWN`.
    CUSTOMER_MANAGED_ENCRYPTION = 2
  end
end

#kms_key_version ⇒ ::String (readonly)

Returns Output only. The version of the Cloud KMS key specified in the parent cluster that is in use for the data underlying this table.

Returns:

  • (::String) —

    Output only. The version of the Cloud KMS key specified in the parent cluster that is in use for the data underlying this table.



374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
 
# File 'proto_docs/google/bigtable/admin/v2/table.rb', line 374

class EncryptionInfo
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Possible encryption types for a resource.
  module EncryptionType
    # Encryption type was not specified, though data at rest remains encrypted.
    ENCRYPTION_TYPE_UNSPECIFIED = 0

    # The data backing this resource 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 backing this resource is encrypted at rest with a key that is
    # managed by the customer.
    # The in-use version of the key and its status are populated for
    # CMEK-protected tables.
    # CMEK-protected backups are pinned to the key version that was in use at
    # the time the backup was taken. This key version is populated but its
    # status is not tracked and is reported as `UNKNOWN`.
    CUSTOMER_MANAGED_ENCRYPTION = 2
  end
end