Reference documentation and code samples for the Cloud Key Management Service (KMS) V1 API class Google::Cloud::Kms::V1::DecapsulateRequest.
Request message for KeyManagementService.Decapsulate.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#ciphertext
def ciphertext() -> ::String
Returns
- (::String) — Required. The ciphertext produced from encapsulation with the named CryptoKeyVersion public key(s).
#ciphertext=
def ciphertext=(value) -> ::String
Parameter
- value (::String) — Required. The ciphertext produced from encapsulation with the named CryptoKeyVersion public key(s).
Returns
- (::String) — Required. The ciphertext produced from encapsulation with the named CryptoKeyVersion public key(s).
#ciphertext_crc32c
def ciphertext_crc32c() -> ::Google::Protobuf::Int64Value
Returns
- (::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.
#ciphertext_crc32c=
def ciphertext_crc32c=(value) -> ::Google::Protobuf::Int64Value
Parameter
- value (::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.
Returns
- (::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.
#name
def name() -> ::String
Returns
- (::String) — Required. The resource name of the CryptoKeyVersion to use for decapsulation.
#name=
def name=(value) -> ::String
Parameter
- value (::String) — Required. The resource name of the CryptoKeyVersion to use for decapsulation.
Returns
- (::String) — Required. The resource name of the CryptoKeyVersion to use for decapsulation.