Reference documentation and code samples for the Cloud KMS V1 Client class DecapsulateRequest.
Request message for KeyManagementService.Decapsulate .
Generated from protobuf message google.cloud.kms.v1.DecapsulateRequest
Namespace
Google \ Cloud \ Kms \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ name
↳ ciphertext
string
Required. The ciphertext produced from encapsulation with the named CryptoKeyVersion public key(s).
↳ ciphertext_crc32c
Google\Protobuf\Int64Value
Optional. A CRC32C checksum of the DecapsulateRequest.ciphertext . If specified, KeyManagementService will verify the integrity of the received DecapsulateRequest.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( DecapsulateRequest.ciphertext ) is equal to DecapsulateRequest.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.
getName
Required. The resource name of the CryptoKeyVersion to use for decapsulation.
string
setName
Required. The resource name of the CryptoKeyVersion to use for decapsulation.
var
string
$this
getCiphertext
Required. The ciphertext produced from encapsulation with the named CryptoKeyVersion public key(s).
string
setCiphertext
Required. The ciphertext produced from encapsulation with the named CryptoKeyVersion public key(s).
var
string
$this
getCiphertextCrc32C
Optional. A CRC32C checksum of the DecapsulateRequest.ciphertext .
If specified, KeyManagementService will verify the integrity of the received DecapsulateRequest.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( DecapsulateRequest.ciphertext ) is equal to DecapsulateRequest.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. A CRC32C checksum of the DecapsulateRequest.ciphertext . If specified, KeyManagementService will verify the integrity of the received DecapsulateRequest.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( DecapsulateRequest.ciphertext ) is equal to DecapsulateRequest.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. A CRC32C checksum of the DecapsulateRequest.ciphertext .
If specified, KeyManagementService will verify the integrity of the received DecapsulateRequest.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( DecapsulateRequest.ciphertext ) is equal to DecapsulateRequest.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. A CRC32C checksum of the DecapsulateRequest.ciphertext . If specified, KeyManagementService will verify the integrity of the received DecapsulateRequest.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( DecapsulateRequest.ciphertext ) is equal to DecapsulateRequest.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
