Reference documentation and code samples for the Data Loss Prevention V2 Client class CryptoKey.
This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by Cloud Key Management Service (Cloud KMS).
When using Cloud KMS to wrap or unwrap a DEK, be sure to set an appropriate IAM policy on the KEK to ensure an attacker cannot unwrap the DEK.
Generated from protobuf message google.privacy.dlp.v2.CryptoKey
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ transient |
Google\Cloud\Dlp\V2\TransientCryptoKey
Transient crypto key |
↳ unwrapped |
Google\Cloud\Dlp\V2\UnwrappedCryptoKey
Unwrapped crypto key |
↳ kms_wrapped |
Google\Cloud\Dlp\V2\KmsWrappedCryptoKey
Key wrapped using Cloud KMS |
getTransient
Transient crypto key
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Dlp\V2\TransientCryptoKey|null | |
hasTransient
setTransient
Transient crypto key
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Dlp\V2\TransientCryptoKey
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getUnwrapped
Unwrapped crypto key
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Dlp\V2\UnwrappedCryptoKey|null | |
hasUnwrapped
setUnwrapped
Unwrapped crypto key
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Dlp\V2\UnwrappedCryptoKey
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getKmsWrapped
Key wrapped using Cloud KMS
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Dlp\V2\KmsWrappedCryptoKey|null | |
hasKmsWrapped
setKmsWrapped
Key wrapped using Cloud KMS
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Dlp\V2\KmsWrappedCryptoKey
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getSource
| Returns | |
|---|---|
| Type | Description |
string | |