Reference documentation and code samples for the Cloud KMS V1 Client class DecryptResponse.
Response message for KeyManagementService.Decrypt .
Generated from protobuf message google.cloud.kms.v1.DecryptResponse
Namespace
Google \ Cloud \ Kms \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ plaintext
↳ plaintext_crc32c
Google\Protobuf\Int64Value
Integrity verification field. A CRC32C checksum of the returned DecryptResponse.plaintext . An integrity check of DecryptResponse.plaintext can be performed by computing the CRC32C checksum of DecryptResponse.plaintext and comparing your results to this field. Discard the response in case of non-matching checksum values, and perform a limited number of retries. A persistent mismatch may indicate an issue in your computation of the CRC32C checksum. Note: receiving this response message indicates that KeyManagementService is able to successfully decrypt the ciphertext . Note: This field is defined as int64 for reasons of compatibility across different languages. However, it is a non-negative integer, which will never exceed 2^32-1, and can be safely downconverted to uint32 in languages that support this type.
↳ used_primary
bool
Whether the Decryption was performed using the primary key version.
↳ protection_level
getPlaintext
The decrypted data originally supplied in EncryptRequest.plaintext .
string
setPlaintext
The decrypted data originally supplied in EncryptRequest.plaintext .
var
string
$this
getPlaintextCrc32C
Integrity verification field. A CRC32C checksum of the returned DecryptResponse.plaintext .
An integrity check of DecryptResponse.plaintext can be performed by computing the CRC32C checksum of DecryptResponse.plaintext and comparing your results to this field. Discard the response in case of non-matching checksum values, and perform a limited number of retries. A persistent mismatch may indicate an issue in your computation of the CRC32C checksum. Note: receiving this response message indicates that KeyManagementService is able to successfully decrypt the ciphertext . Note: This field is defined as int64 for reasons of compatibility across different languages. However, it is a non-negative integer, which will never exceed 2^32-1, and can be safely downconverted to uint32 in languages that support this type.
hasPlaintextCrc32C
clearPlaintextCrc32C
getPlaintextCrc32CUnwrapped
Returns the unboxed value from getPlaintextCrc32C()
Integrity verification field. A CRC32C checksum of the returned DecryptResponse.plaintext . An integrity check of DecryptResponse.plaintext can be performed by computing the CRC32C checksum of DecryptResponse.plaintext and comparing your results to this field. Discard the response in case of non-matching checksum values, and perform a limited number of retries. A persistent mismatch may indicate an issue in your computation of the CRC32C checksum. Note: receiving this response message indicates that KeyManagementService is able to successfully decrypt the ciphertext . Note: This field is defined as int64 for reasons of compatibility across different languages. However, it is a non-negative integer, which will never exceed 2^32-1, and can be safely downconverted to uint32 in languages that support this type.
int|string|null
setPlaintextCrc32C
Integrity verification field. A CRC32C checksum of the returned DecryptResponse.plaintext .
An integrity check of DecryptResponse.plaintext can be performed by computing the CRC32C checksum of DecryptResponse.plaintext and comparing your results to this field. Discard the response in case of non-matching checksum values, and perform a limited number of retries. A persistent mismatch may indicate an issue in your computation of the CRC32C checksum. Note: receiving this response message indicates that KeyManagementService is able to successfully decrypt the ciphertext . Note: This field is defined as int64 for reasons of compatibility across different languages. However, it is a non-negative integer, which will never exceed 2^32-1, and can be safely downconverted to uint32 in languages that support this type.
$this
setPlaintextCrc32CUnwrapped
Sets the field by wrapping a primitive type in a Google\Protobuf\Int64Value object.
Integrity verification field. A CRC32C checksum of the returned DecryptResponse.plaintext . An integrity check of DecryptResponse.plaintext can be performed by computing the CRC32C checksum of DecryptResponse.plaintext and comparing your results to this field. Discard the response in case of non-matching checksum values, and perform a limited number of retries. A persistent mismatch may indicate an issue in your computation of the CRC32C checksum. Note: receiving this response message indicates that KeyManagementService is able to successfully decrypt the ciphertext . Note: This field is defined as int64 for reasons of compatibility across different languages. However, it is a non-negative integer, which will never exceed 2^32-1, and can be safely downconverted to uint32 in languages that support this type.
var
int|string|null
$this
getUsedPrimary
Whether the Decryption was performed using the primary key version.
bool
setUsedPrimary
Whether the Decryption was performed using the primary key version.
var
bool
$this
getProtectionLevel
The ProtectionLevel of the CryptoKeyVersion used in decryption.
int
setProtectionLevel
The ProtectionLevel of the CryptoKeyVersion used in decryption.
var
int
$this