Reference documentation and code samples for the Cloud Key Management Service (KMS) V1 API class Google::Cloud::Kms::V1::DecapsulateResponse.
Response message for KeyManagementService.Decapsulate.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#name
def name() -> ::String
Returns
- (::String) — The resource name of the CryptoKeyVersion used for decapsulation. Check this field to verify that the intended resource was used for decapsulation.
#name=
def name=(value) -> ::String
Parameter
- value (::String) — The resource name of the CryptoKeyVersion used for decapsulation. Check this field to verify that the intended resource was used for decapsulation.
Returns
- (::String) — The resource name of the CryptoKeyVersion used for decapsulation. Check this field to verify that the intended resource was used for decapsulation.
#protection_level
def protection_level() -> ::Google::Cloud::Kms::V1::ProtectionLevel
Returns
- (::Google::Cloud::Kms::V1::ProtectionLevel) — The ProtectionLevel of the CryptoKeyVersion used in decapsulation.
#protection_level=
def protection_level=(value) -> ::Google::Cloud::Kms::V1::ProtectionLevel
Parameter
- value (::Google::Cloud::Kms::V1::ProtectionLevel) — The ProtectionLevel of the CryptoKeyVersion used in decapsulation.
Returns
- (::Google::Cloud::Kms::V1::ProtectionLevel) — The ProtectionLevel of the CryptoKeyVersion used in decapsulation.
#shared_secret
def shared_secret() -> ::String
Returns
- (::String) — The decapsulated shared_secret originally encapsulated with the matching public key.
#shared_secret=
def shared_secret=(value) -> ::String
Parameter
- value (::String) — The decapsulated shared_secret originally encapsulated with the matching public key.
Returns
- (::String) — The decapsulated shared_secret originally encapsulated with the matching public key.
#shared_secret_crc32c
def shared_secret_crc32c() -> ::Integer
Returns
- (::Integer) — Integrity verification field. A CRC32C checksum of the returned DecapsulateResponse.shared_secret. An integrity check of DecapsulateResponse.shared_secret can be performed by computing the CRC32C checksum of DecapsulateResponse.shared_secret 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.
#shared_secret_crc32c=
def shared_secret_crc32c=(value) -> ::Integer
Parameter
- value (::Integer) — Integrity verification field. A CRC32C checksum of the returned DecapsulateResponse.shared_secret. An integrity check of DecapsulateResponse.shared_secret can be performed by computing the CRC32C checksum of DecapsulateResponse.shared_secret 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.
Returns
- (::Integer) — Integrity verification field. A CRC32C checksum of the returned DecapsulateResponse.shared_secret. An integrity check of DecapsulateResponse.shared_secret can be performed by computing the CRC32C checksum of DecapsulateResponse.shared_secret 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.
#verified_ciphertext_crc32c
def verified_ciphertext_crc32c() -> ::Boolean
Returns
- (::Boolean) — Integrity verification field. A flag indicating whether DecapsulateRequest.ciphertext_crc32c was received by KeyManagementService and used for the integrity verification of the ciphertext. A false value of this field indicates either that DecapsulateRequest.ciphertext_crc32c was left unset or that it was not delivered to KeyManagementService. If you've set DecapsulateRequest.ciphertext_crc32c but this field is still false, discard the response and perform a limited number of retries.
#verified_ciphertext_crc32c=
def verified_ciphertext_crc32c=(value) -> ::Boolean
Parameter
- value (::Boolean) — Integrity verification field. A flag indicating whether DecapsulateRequest.ciphertext_crc32c was received by KeyManagementService and used for the integrity verification of the ciphertext. A false value of this field indicates either that DecapsulateRequest.ciphertext_crc32c was left unset or that it was not delivered to KeyManagementService. If you've set DecapsulateRequest.ciphertext_crc32c but this field is still false, discard the response and perform a limited number of retries.
Returns
- (::Boolean) — Integrity verification field. A flag indicating whether DecapsulateRequest.ciphertext_crc32c was received by KeyManagementService and used for the integrity verification of the ciphertext. A false value of this field indicates either that DecapsulateRequest.ciphertext_crc32c was left unset or that it was not delivered to KeyManagementService. If you've set DecapsulateRequest.ciphertext_crc32c but this field is still false, discard the response and perform a limited number of retries.