Reference documentation and code samples for the Cloud KMS V1 Client class EncryptResponse.
Response message for KeyManagementService.Encrypt .
Generated from protobuf message google.cloud.kms.v1.EncryptResponse
Namespace
Google \ Cloud \ Kms \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ name
string
The resource name of the CryptoKeyVersion used in encryption. Check this field to verify that the intended resource was used for encryption.
↳ ciphertext
string
The encrypted data.
↳ ciphertext_crc32c
Google\Protobuf\Int64Value
Integrity verification field. A CRC32C checksum of the returned EncryptResponse.ciphertext . An integrity check of EncryptResponse.ciphertext can be performed by computing the CRC32C checksum of EncryptResponse.ciphertext 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: 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.
↳ verified_plaintext_crc32c
bool
Integrity verification field. A flag indicating whether EncryptRequest.plaintext_crc32c was received by KeyManagementService and used for the integrity verification of the plaintext . A false value of this field indicates either that EncryptRequest.plaintext_crc32c was left unset or that it was not delivered to KeyManagementService . If you've set EncryptRequest.plaintext_crc32c but this field is still false, discard the response and perform a limited number of retries.
↳ verified_additional_authenticated_data_crc32c
bool
Integrity verification field. A flag indicating whether EncryptRequest.additional_authenticated_data_crc32c was received by KeyManagementService and used for the integrity verification of the AAD . A false value of this field indicates either that EncryptRequest.additional_authenticated_data_crc32c was left unset or that it was not delivered to KeyManagementService . If you've set EncryptRequest.additional_authenticated_data_crc32c but this field is still false, discard the response and perform a limited number of retries.
↳ protection_level
getName
The resource name of the CryptoKeyVersion used in encryption. Check this field to verify that the intended resource was used for encryption.
string
setName
The resource name of the CryptoKeyVersion used in encryption. Check this field to verify that the intended resource was used for encryption.
var
string
$this
getCiphertext
The encrypted data.
string
setCiphertext
The encrypted data.
var
string
$this
getCiphertextCrc32C
Integrity verification field. A CRC32C checksum of the returned EncryptResponse.ciphertext .
An integrity check of EncryptResponse.ciphertext can be performed by computing the CRC32C checksum of EncryptResponse.ciphertext 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: 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.
hasCiphertextCrc32C
clearCiphertextCrc32C
getCiphertextCrc32CUnwrapped
Returns the unboxed value from getCiphertextCrc32C()
Integrity verification field. A CRC32C checksum of the returned EncryptResponse.ciphertext . An integrity check of EncryptResponse.ciphertext can be performed by computing the CRC32C checksum of EncryptResponse.ciphertext 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: 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
setCiphertextCrc32C
Integrity verification field. A CRC32C checksum of the returned EncryptResponse.ciphertext .
An integrity check of EncryptResponse.ciphertext can be performed by computing the CRC32C checksum of EncryptResponse.ciphertext 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: 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
setCiphertextCrc32CUnwrapped
Sets the field by wrapping a primitive type in a Google\Protobuf\Int64Value object.
Integrity verification field. A CRC32C checksum of the returned EncryptResponse.ciphertext . An integrity check of EncryptResponse.ciphertext can be performed by computing the CRC32C checksum of EncryptResponse.ciphertext 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: 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
getVerifiedPlaintextCrc32C
Integrity verification field. A flag indicating whether EncryptRequest.plaintext_crc32c was received by KeyManagementService and used for the integrity verification of the plaintext . A false value of this field indicates either that EncryptRequest.plaintext_crc32c was left unset or that it was not delivered to KeyManagementService . If you've set EncryptRequest.plaintext_crc32c but this field is still false, discard the response and perform a limited number of retries.
bool
setVerifiedPlaintextCrc32C
Integrity verification field. A flag indicating whether EncryptRequest.plaintext_crc32c was received by KeyManagementService and used for the integrity verification of the plaintext . A false value of this field indicates either that EncryptRequest.plaintext_crc32c was left unset or that it was not delivered to KeyManagementService . If you've set EncryptRequest.plaintext_crc32c but this field is still false, discard the response and perform a limited number of retries.
var
bool
$this
getVerifiedAdditionalAuthenticatedDataCrc32C
Integrity verification field. A flag indicating whether EncryptRequest.additional_authenticated_data_crc32c was received by KeyManagementService and used for the integrity verification of the AAD . A false value of this field indicates either that EncryptRequest.additional_authenticated_data_crc32c was left unset or that it was not delivered to KeyManagementService . If you've set EncryptRequest.additional_authenticated_data_crc32c but this field is still false, discard the response and perform a limited number of retries.
bool
setVerifiedAdditionalAuthenticatedDataCrc32C
Integrity verification field. A flag indicating whether EncryptRequest.additional_authenticated_data_crc32c was received by KeyManagementService and used for the integrity verification of the AAD . A false value of this field indicates either that EncryptRequest.additional_authenticated_data_crc32c was left unset or that it was not delivered to KeyManagementService . If you've set EncryptRequest.additional_authenticated_data_crc32c but this field is still false, discard the response and perform a limited number of retries.
var
bool
$this
getProtectionLevel
The ProtectionLevel of the CryptoKeyVersion used in encryption.
int
setProtectionLevel
The ProtectionLevel of the CryptoKeyVersion used in encryption.
var
int
$this
