Reference documentation and code samples for the Cloud Key Management Service (KMS) V1 API class Google::Cloud::Kms::V1::DecryptRequest.
Request message for KeyManagementService.Decrypt.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#additional_authenticated_data
def additional_authenticated_data() -> ::String
Returns
- (::String) — Optional. Optional data that must match the data originally supplied in EncryptRequest.additional_authenticated_data.
#additional_authenticated_data=
def additional_authenticated_data=(value) -> ::String
Parameter
- value (::String) — Optional. Optional data that must match the data originally supplied in EncryptRequest.additional_authenticated_data.
Returns
- (::String) — Optional. Optional data that must match the data originally supplied in EncryptRequest.additional_authenticated_data.
#additional_authenticated_data_crc32c
def additional_authenticated_data_crc32c() -> ::Google::Protobuf::Int64Value
Returns
- (::Google::Protobuf::Int64Value) — Optional. An optional CRC32C checksum of the DecryptRequest.additional_authenticated_data. If specified, KeyManagementService will verify the integrity of the received DecryptRequest.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(DecryptRequest.additional_authenticated_data) is equal to DecryptRequest.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.
#additional_authenticated_data_crc32c=
def additional_authenticated_data_crc32c=(value) -> ::Google::Protobuf::Int64Value
Parameter
- value (::Google::Protobuf::Int64Value) — Optional. An optional CRC32C checksum of the DecryptRequest.additional_authenticated_data. If specified, KeyManagementService will verify the integrity of the received DecryptRequest.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(DecryptRequest.additional_authenticated_data) is equal to DecryptRequest.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.
Returns
- (::Google::Protobuf::Int64Value) — Optional. An optional CRC32C checksum of the DecryptRequest.additional_authenticated_data. If specified, KeyManagementService will verify the integrity of the received DecryptRequest.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(DecryptRequest.additional_authenticated_data) is equal to DecryptRequest.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.
#ciphertext
def ciphertext() -> ::String
Returns
- (::String) — Required. The encrypted data originally returned in EncryptResponse.ciphertext.
#ciphertext=
def ciphertext=(value) -> ::String
Parameter
- value (::String) — Required. The encrypted data originally returned in EncryptResponse.ciphertext.
Returns
- (::String) — Required. The encrypted data originally returned in EncryptResponse.ciphertext.
#ciphertext_crc32c
def ciphertext_crc32c() -> ::Google::Protobuf::Int64Value
Returns
- (::Google::Protobuf::Int64Value) — Optional. An optional CRC32C checksum of the DecryptRequest.ciphertext. If specified, KeyManagementService will verify the integrity of the received DecryptRequest.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(DecryptRequest.ciphertext) is equal to DecryptRequest.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. An optional CRC32C checksum of the DecryptRequest.ciphertext. If specified, KeyManagementService will verify the integrity of the received DecryptRequest.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(DecryptRequest.ciphertext) is equal to DecryptRequest.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. An optional CRC32C checksum of the DecryptRequest.ciphertext. If specified, KeyManagementService will verify the integrity of the received DecryptRequest.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(DecryptRequest.ciphertext) is equal to DecryptRequest.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 CryptoKey to use for decryption. The server will choose the appropriate version.
#name=
def name=(value) -> ::String
Parameter
- value (::String) — Required. The resource name of the CryptoKey to use for decryption. The server will choose the appropriate version.
Returns
- (::String) — Required. The resource name of the CryptoKey to use for decryption. The server will choose the appropriate version.