Class: Google::Apis::CloudkmsV1::DecryptResponse

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
lib/google/apis/cloudkms_v1/classes.rb,
lib/google/apis/cloudkms_v1/representations.rb,
lib/google/apis/cloudkms_v1/representations.rb

Overview

Response message for KeyManagementService.Decrypt.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ DecryptResponse

Returns a new instance of DecryptResponse.



710
711
712
 
# File 'lib/google/apis/cloudkms_v1/classes.rb', line 710

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#plaintext ⇒ String

The decrypted data originally supplied in EncryptRequest.plaintext. Corresponds to the JSON property plaintext NOTE: Values are automatically base64 encoded/decoded in the client library.

Returns:

  • (String) 


681
682
683
 
# File 'lib/google/apis/cloudkms_v1/classes.rb', line 681

def plaintext
  @plaintext
end

#plaintext_crc32c ⇒ Fixnum

Integrity verification field. A CRC32C checksum of the returned DecryptResponse.plaintext. An integrity check of DecryptResponse.plaintext can be performed by computing the CRC32C checksum of DecryptResponse.plaintext 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. NOTE: This field is in Beta. Corresponds to the JSON property plaintextCrc32c

Returns:

  • (Fixnum) 


697
698
699
 
# File 'lib/google/apis/cloudkms_v1/classes.rb', line 697

def plaintext_crc32c
  @plaintext_crc32c
end

#protection_level ⇒ String

The ProtectionLevel of the CryptoKeyVersion used in decryption. Corresponds to the JSON property protectionLevel

Returns:

  • (String) 


702
703
704
 
# File 'lib/google/apis/cloudkms_v1/classes.rb', line 702

def protection_level
  @protection_level
end

#used_primary ⇒ Boolean Also known as: used_primary?

Whether the Decryption was performed using the primary key version. Corresponds to the JSON property usedPrimary

Returns:

  • (Boolean) 


707
708
709
 
# File 'lib/google/apis/cloudkms_v1/classes.rb', line 707

def used_primary
  @used_primary
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



715
716
717
718
719
720
 
# File 'lib/google/apis/cloudkms_v1/classes.rb', line 715

def update!(**args)
  @plaintext = args[:plaintext] if args.key?(:plaintext)
  @plaintext_crc32c = args[:plaintext_crc32c] if args.key?(:plaintext_crc32c)
  @protection_level = args[:protection_level] if args.key?(:protection_level)
  @used_primary = args[:used_primary] if args.key?(:used_primary)
end