Cloud Spanner V1 Client - Class EncryptionInfo (2.6.0)

Reference documentation and code samples for the Cloud Spanner V1 Client class EncryptionInfo.

Encryption information for a Cloud Spanner database or backup.

Generated from protobuf message google.spanner.admin.database.v1.EncryptionInfo

Namespace

Google \ Cloud \ Spanner \ Admin \ Database \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ encryption_type int

Output only. The type of encryption.
↳ encryption_status 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.
↳ kms_key_version string

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

getEncryptionType

Output only. The type of encryption.

Returns
Type Description
int Enum of type Type.

setEncryptionType

Output only. The type of encryption.

Parameter
Name Description
var int

Enum of type Type.

Returns
Type Description
$this

getEncryptionStatus

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

hasEncryptionStatus

clearEncryptionStatus

setEncryptionStatus

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.

Parameter
Name Description
var Google\Rpc\Status
Returns
Type Description
$this

getKmsKeyVersion

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

Returns
Type Description
string

setKmsKeyVersion

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

Parameter
Name Description
var string
Returns
Type Description
$this