Reference documentation and code samples for the Cloud KMS V1 Client class RawEncryptResponse.
Response message for KeyManagementService.RawEncrypt.
Generated from protobuf message google.cloud.kms.v1.RawEncryptResponse
Namespace
Google \ Cloud \ Kms \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ ciphertext |
string
The encrypted data. In the case of AES-GCM, the authentication tag is the tag_length bytes at the end of this field. |
↳ initialization_vector |
string
The initialization vector (IV) generated by the service during encryption. This value must be stored and provided in RawDecryptRequest.initialization_vector at decryption time. |
↳ tag_length |
int
The length of the authentication tag that is appended to the end of the ciphertext. |
↳ ciphertext_crc32c |
Google\Protobuf\Int64Value
Integrity verification field. A CRC32C checksum of the returned RawEncryptResponse.ciphertext. An integrity check of ciphertext can be performed by computing the CRC32C checksum of 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. |
↳ initialization_vector_crc32c |
Google\Protobuf\Int64Value
Integrity verification field. A CRC32C checksum of the returned RawEncryptResponse.initialization_vector. An integrity check of initialization_vector can be performed by computing the CRC32C checksum of initialization_vector 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 RawEncryptRequest.plaintext_crc32c was received by KeyManagementService and used for the integrity verification of the plaintext. A false value of this field indicates either that RawEncryptRequest.plaintext_crc32c was left unset or that it was not delivered to KeyManagementService. If you've set RawEncryptRequest.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 RawEncryptRequest.additional_authenticated_data_crc32c was received by KeyManagementService and used for the integrity verification of additional_authenticated_data. A false value of this field indicates either that // RawEncryptRequest.additional_authenticated_data_crc32c was left unset or that it was not delivered to KeyManagementService. If you've set RawEncryptRequest.additional_authenticated_data_crc32c but this field is still false, discard the response and perform a limited number of retries. |
↳ verified_initialization_vector_crc32c |
bool
Integrity verification field. A flag indicating whether RawEncryptRequest.initialization_vector_crc32c was received by KeyManagementService and used for the integrity verification of initialization_vector. A false value of this field indicates either that RawEncryptRequest.initialization_vector_crc32c was left unset or that it was not delivered to KeyManagementService. If you've set RawEncryptRequest.initialization_vector_crc32c but this field is still false, discard the response and perform a limited number of retries. |
↳ name |
string
The resource name of the CryptoKeyVersion used in encryption. Check this field to verify that the intended resource was used for encryption. |
↳ protection_level |
int
The ProtectionLevel of the CryptoKeyVersion used in encryption. |
getCiphertext
The encrypted data. In the case of AES-GCM, the authentication tag is the tag_length bytes at the end of this field.
| Returns | |
|---|---|
| Type | Description |
string |
|
setCiphertext
The encrypted data. In the case of AES-GCM, the authentication tag is the tag_length bytes at the end of this field.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getInitializationVector
The initialization vector (IV) generated by the service during encryption. This value must be stored and provided in RawDecryptRequest.initialization_vector at decryption time.
| Returns | |
|---|---|
| Type | Description |
string |
|
setInitializationVector
The initialization vector (IV) generated by the service during encryption. This value must be stored and provided in RawDecryptRequest.initialization_vector at decryption time.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getTagLength
The length of the authentication tag that is appended to the end of the ciphertext.
| Returns | |
|---|---|
| Type | Description |
int |
|
setTagLength
The length of the authentication tag that is appended to the end of the ciphertext.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCiphertextCrc32C
Integrity verification field. A CRC32C checksum of the returned RawEncryptResponse.ciphertext.
An integrity check of ciphertext can be performed by computing the CRC32C checksum of 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.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Int64Value|null |
|
hasCiphertextCrc32C
clearCiphertextCrc32C
getCiphertextCrc32CValue
Returns the unboxed value from getCiphertextCrc32C()
Integrity verification field. A CRC32C checksum of the returned RawEncryptResponse.ciphertext. An integrity check of ciphertext can be performed by computing the CRC32C checksum of 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.
| Returns | |
|---|---|
| Type | Description |
int|string|null |
|
setCiphertextCrc32C
Integrity verification field. A CRC32C checksum of the returned RawEncryptResponse.ciphertext.
An integrity check of ciphertext can be performed by computing the CRC32C checksum of 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.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Int64Value
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
setCiphertextCrc32CValue
Sets the field by wrapping a primitive type in a Google\Protobuf\Int64Value object.
Integrity verification field. A CRC32C checksum of the returned RawEncryptResponse.ciphertext. An integrity check of ciphertext can be performed by computing the CRC32C checksum of 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.
| Parameter | |
|---|---|
| Name | Description |
var |
int|string|null
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getInitializationVectorCrc32C
Integrity verification field. A CRC32C checksum of the returned RawEncryptResponse.initialization_vector.
An integrity check of initialization_vector can be performed by computing the CRC32C checksum of initialization_vector 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.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Int64Value|null |
|
hasInitializationVectorCrc32C
clearInitializationVectorCrc32C
getInitializationVectorCrc32CValue
Returns the unboxed value from getInitializationVectorCrc32C()
Integrity verification field. A CRC32C checksum of the returned RawEncryptResponse.initialization_vector. An integrity check of initialization_vector can be performed by computing the CRC32C checksum of initialization_vector 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.
| Returns | |
|---|---|
| Type | Description |
int|string|null |
|
setInitializationVectorCrc32C
Integrity verification field. A CRC32C checksum of the returned RawEncryptResponse.initialization_vector.
An integrity check of initialization_vector can be performed by computing the CRC32C checksum of initialization_vector 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.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Int64Value
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
setInitializationVectorCrc32CValue
Sets the field by wrapping a primitive type in a Google\Protobuf\Int64Value object.
Integrity verification field. A CRC32C checksum of the returned RawEncryptResponse.initialization_vector. An integrity check of initialization_vector can be performed by computing the CRC32C checksum of initialization_vector 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.
| Parameter | |
|---|---|
| Name | Description |
var |
int|string|null
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getVerifiedPlaintextCrc32C
Integrity verification field. A flag indicating whether RawEncryptRequest.plaintext_crc32c was received by KeyManagementService and used for the integrity verification of the plaintext. A false value of this field indicates either that RawEncryptRequest.plaintext_crc32c was left unset or that it was not delivered to KeyManagementService. If you've set RawEncryptRequest.plaintext_crc32c but this field is still false, discard the response and perform a limited number of retries.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setVerifiedPlaintextCrc32C
Integrity verification field. A flag indicating whether RawEncryptRequest.plaintext_crc32c was received by KeyManagementService and used for the integrity verification of the plaintext. A false value of this field indicates either that RawEncryptRequest.plaintext_crc32c was left unset or that it was not delivered to KeyManagementService. If you've set RawEncryptRequest.plaintext_crc32c but this field is still false, discard the response and perform a limited number of retries.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getVerifiedAdditionalAuthenticatedDataCrc32C
Integrity verification field. A flag indicating whether RawEncryptRequest.additional_authenticated_data_crc32c was received by KeyManagementService and used for the integrity verification of additional_authenticated_data. A false value of this field indicates either that // RawEncryptRequest.additional_authenticated_data_crc32c was left unset or that it was not delivered to KeyManagementService. If you've set RawEncryptRequest.additional_authenticated_data_crc32c but this field is still false, discard the response and perform a limited number of retries.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setVerifiedAdditionalAuthenticatedDataCrc32C
Integrity verification field. A flag indicating whether RawEncryptRequest.additional_authenticated_data_crc32c was received by KeyManagementService and used for the integrity verification of additional_authenticated_data. A false value of this field indicates either that // RawEncryptRequest.additional_authenticated_data_crc32c was left unset or that it was not delivered to KeyManagementService. If you've set RawEncryptRequest.additional_authenticated_data_crc32c but this field is still false, discard the response and perform a limited number of retries.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getVerifiedInitializationVectorCrc32C
Integrity verification field. A flag indicating whether RawEncryptRequest.initialization_vector_crc32c was received by KeyManagementService and used for the integrity verification of initialization_vector. A false value of this field indicates either that RawEncryptRequest.initialization_vector_crc32c was left unset or that it was not delivered to KeyManagementService. If you've set RawEncryptRequest.initialization_vector_crc32c but this field is still false, discard the response and perform a limited number of retries.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setVerifiedInitializationVectorCrc32C
Integrity verification field. A flag indicating whether RawEncryptRequest.initialization_vector_crc32c was received by KeyManagementService and used for the integrity verification of initialization_vector. A false value of this field indicates either that RawEncryptRequest.initialization_vector_crc32c was left unset or that it was not delivered to KeyManagementService. If you've set RawEncryptRequest.initialization_vector_crc32c but this field is still false, discard the response and perform a limited number of retries.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getName
The resource name of the CryptoKeyVersion used in encryption. Check this field to verify that the intended resource was used for encryption.
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
The resource name of the CryptoKeyVersion used in encryption. Check this field to verify that the intended resource was used for encryption.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getProtectionLevel
The ProtectionLevel of the CryptoKeyVersion used in encryption.
| Returns | |
|---|---|
| Type | Description |
int |
|
setProtectionLevel
The ProtectionLevel of the CryptoKeyVersion used in encryption.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|