Cloud Bigtable V2 Client - Class EncryptionInfo (1.24.1)

Reference documentation and code samples for the Cloud Bigtable V2 Client class EncryptionInfo.

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.

Generated from protobuf message google.bigtable.admin.v2.EncryptionInfo

Namespace

Google \ Cloud \ Bigtable \ Admin \ V2

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ encryption_type int

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

↳ encryption_status 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.

↳ kms_key_version 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.

getEncryptionType

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

Returns
TypeDescription
int

setEncryptionType

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

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getEncryptionStatus

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
TypeDescription
Google\Rpc\Status|null

hasEncryptionStatus

clearEncryptionStatus

setEncryptionStatus

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.

Parameter
NameDescription
var Google\Rpc\Status
Returns
TypeDescription
$this

getKmsKeyVersion

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
TypeDescription
string

setKmsKeyVersion

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this