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
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.
Generated from protobuf field .google.spanner.admin.database.v1.EncryptionInfo.Type encryption_type = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
int | |
setEncryptionType
Output only. The type of encryption.
Generated from protobuf field .google.spanner.admin.database.v1.EncryptionInfo.Type encryption_type = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| 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.
Generated from protobuf field .google.rpc.Status encryption_status = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| 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.
Generated from protobuf field .google.rpc.Status encryption_status = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| 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.
Generated from protobuf field string kms_key_version = 2 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = {
| Returns | |
|---|---|
| Type | Description |
string | |
setKmsKeyVersion
Output only. A Cloud KMS key version that is being used to protect the database or backup.
Generated from protobuf field string kms_key_version = 2 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = {
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |