Reference documentation and code samples for the Cloud KMS V1 Client class RawDecryptRequest.
Request message for KeyManagementService.RawDecrypt .
Generated from protobuf message google.cloud.kms.v1.RawDecryptRequest
Namespace
Google \ Cloud \ Kms \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ name
↳ ciphertext
↳ additional_authenticated_data
string
Optional. Optional data that must match the data originally supplied in RawEncryptRequest.additional_authenticated_data .
↳ initialization_vector
string
Required. The initialization vector (IV) used during encryption, which must match the data originally provided in RawEncryptResponse.initialization_vector .
↳ tag_length
int
The length of the authentication tag that is appended to the end of the ciphertext. If unspecified (0), the default value for the key's algorithm will be used (for AES-GCM, the default value is 16).
↳ ciphertext_crc32c
Google\Protobuf\Int64Value
Optional. An optional CRC32C checksum of the RawDecryptRequest.ciphertext . If specified, KeyManagementService will verify the integrity of the received ciphertext using this checksum. KeyManagementService will report an error if the checksum verification fails. If you receive a checksum error, your client should verify that CRC32C(ciphertext) is equal to ciphertext_crc32c, and if so, 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.
↳ additional_authenticated_data_crc32c
Google\Protobuf\Int64Value
Optional. An optional CRC32C checksum of the RawDecryptRequest.additional_authenticated_data . If specified, KeyManagementService will verify the integrity of the received additional_authenticated_data using this checksum. KeyManagementService will report an error if the checksum verification fails. If you receive a checksum error, your client should verify that CRC32C(additional_authenticated_data) is equal to additional_authenticated_data_crc32c, and if so, 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
Optional. An optional CRC32C checksum of the RawDecryptRequest.initialization_vector . If specified, KeyManagementService will verify the integrity of the received initialization_vector using this checksum. KeyManagementService will report an error if the checksum verification fails. If you receive a checksum error, your client should verify that CRC32C(initialization_vector) is equal to initialization_vector_crc32c, and if so, 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.
getName
Required. The resource name of the CryptoKeyVersion to use for decryption.
string
setName
Required. The resource name of the CryptoKeyVersion to use for decryption.
var
string
$this
getCiphertext
Required. The encrypted data originally returned in RawEncryptResponse.ciphertext .
string
setCiphertext
Required. The encrypted data originally returned in RawEncryptResponse.ciphertext .
var
string
$this
getAdditionalAuthenticatedData
Optional. Optional data that must match the data originally supplied in RawEncryptRequest.additional_authenticated_data .
string
setAdditionalAuthenticatedData
Optional. Optional data that must match the data originally supplied in RawEncryptRequest.additional_authenticated_data .
var
string
$this
getInitializationVector
Required. The initialization vector (IV) used during encryption, which must match the data originally provided in RawEncryptResponse.initialization_vector .
string
setInitializationVector
Required. The initialization vector (IV) used during encryption, which must match the data originally provided in RawEncryptResponse.initialization_vector .
var
string
$this
getTagLength
The length of the authentication tag that is appended to the end of the ciphertext. If unspecified (0), the default value for the key's algorithm will be used (for AES-GCM, the default value is 16).
int
setTagLength
The length of the authentication tag that is appended to the end of the ciphertext. If unspecified (0), the default value for the key's algorithm will be used (for AES-GCM, the default value is 16).
var
int
$this
getCiphertextCrc32C
Optional. An optional CRC32C checksum of the RawDecryptRequest.ciphertext .
If specified, KeyManagementService will verify the integrity of the received ciphertext using this checksum. KeyManagementService will report an error if the checksum verification fails. If you receive a checksum error, your client should verify that CRC32C(ciphertext) is equal to ciphertext_crc32c, and if so, 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()
Optional. An optional CRC32C checksum of the RawDecryptRequest.ciphertext . If specified, KeyManagementService will verify the integrity of the received ciphertext using this checksum. KeyManagementService will report an error if the checksum verification fails. If you receive a checksum error, your client should verify that CRC32C(ciphertext) is equal to ciphertext_crc32c, and if so, 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
Optional. An optional CRC32C checksum of the RawDecryptRequest.ciphertext .
If specified, KeyManagementService will verify the integrity of the received ciphertext using this checksum. KeyManagementService will report an error if the checksum verification fails. If you receive a checksum error, your client should verify that CRC32C(ciphertext) is equal to ciphertext_crc32c, and if so, 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.
Optional. An optional CRC32C checksum of the RawDecryptRequest.ciphertext . If specified, KeyManagementService will verify the integrity of the received ciphertext using this checksum. KeyManagementService will report an error if the checksum verification fails. If you receive a checksum error, your client should verify that CRC32C(ciphertext) is equal to ciphertext_crc32c, and if so, 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
getAdditionalAuthenticatedDataCrc32C
Optional. An optional CRC32C checksum of the RawDecryptRequest.additional_authenticated_data .
If specified, KeyManagementService will verify the integrity of the received additional_authenticated_data using this checksum. KeyManagementService will report an error if the checksum verification fails. If you receive a checksum error, your client should verify that CRC32C(additional_authenticated_data) is equal to additional_authenticated_data_crc32c, and if so, 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.
hasAdditionalAuthenticatedDataCrc32C
clearAdditionalAuthenticatedDataCrc32C
getAdditionalAuthenticatedDataCrc32CUnwrapped
Returns the unboxed value from getAdditionalAuthenticatedDataCrc32C()
Optional. An optional CRC32C checksum of the RawDecryptRequest.additional_authenticated_data . If specified, KeyManagementService will verify the integrity of the received additional_authenticated_data using this checksum. KeyManagementService will report an error if the checksum verification fails. If you receive a checksum error, your client should verify that CRC32C(additional_authenticated_data) is equal to additional_authenticated_data_crc32c, and if so, 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
setAdditionalAuthenticatedDataCrc32C
Optional. An optional CRC32C checksum of the RawDecryptRequest.additional_authenticated_data .
If specified, KeyManagementService will verify the integrity of the received additional_authenticated_data using this checksum. KeyManagementService will report an error if the checksum verification fails. If you receive a checksum error, your client should verify that CRC32C(additional_authenticated_data) is equal to additional_authenticated_data_crc32c, and if so, 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
setAdditionalAuthenticatedDataCrc32CUnwrapped
Sets the field by wrapping a primitive type in a Google\Protobuf\Int64Value object.
Optional. An optional CRC32C checksum of the RawDecryptRequest.additional_authenticated_data . If specified, KeyManagementService will verify the integrity of the received additional_authenticated_data using this checksum. KeyManagementService will report an error if the checksum verification fails. If you receive a checksum error, your client should verify that CRC32C(additional_authenticated_data) is equal to additional_authenticated_data_crc32c, and if so, 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
getInitializationVectorCrc32C
Optional. An optional CRC32C checksum of the RawDecryptRequest.initialization_vector .
If specified, KeyManagementService will verify the integrity of the received initialization_vector using this checksum. KeyManagementService will report an error if the checksum verification fails. If you receive a checksum error, your client should verify that CRC32C(initialization_vector) is equal to initialization_vector_crc32c, and if so, 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.
hasInitializationVectorCrc32C
clearInitializationVectorCrc32C
getInitializationVectorCrc32CUnwrapped
Returns the unboxed value from getInitializationVectorCrc32C()
Optional. An optional CRC32C checksum of the RawDecryptRequest.initialization_vector . If specified, KeyManagementService will verify the integrity of the received initialization_vector using this checksum. KeyManagementService will report an error if the checksum verification fails. If you receive a checksum error, your client should verify that CRC32C(initialization_vector) is equal to initialization_vector_crc32c, and if so, 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
setInitializationVectorCrc32C
Optional. An optional CRC32C checksum of the RawDecryptRequest.initialization_vector .
If specified, KeyManagementService will verify the integrity of the received initialization_vector using this checksum. KeyManagementService will report an error if the checksum verification fails. If you receive a checksum error, your client should verify that CRC32C(initialization_vector) is equal to initialization_vector_crc32c, and if so, 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
setInitializationVectorCrc32CUnwrapped
Sets the field by wrapping a primitive type in a Google\Protobuf\Int64Value object.
Optional. An optional CRC32C checksum of the RawDecryptRequest.initialization_vector . If specified, KeyManagementService will verify the integrity of the received initialization_vector using this checksum. KeyManagementService will report an error if the checksum verification fails. If you receive a checksum error, your client should verify that CRC32C(initialization_vector) is equal to initialization_vector_crc32c, and if so, 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
