Class: Google::Cloud::Kms::V1::EncryptResponse

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/kms/v1/service.rb

Overview

Response message for KeyManagementService.Encrypt.

Instance Attribute Summary collapse

Instance Attribute Details

#ciphertext ⇒ ::String

Returns The encrypted data.

Returns:

  • (::String) —

    The encrypted data.



984
985
986
987
 
# File 'proto_docs/google/cloud/kms/v1/service.rb', line 984

class EncryptResponse
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#ciphertext_crc32c ⇒ ::Google::Protobuf::Int64Value

Returns Integrity verification field. A CRC32C checksum of the returned EncryptResponse.ciphertext. An integrity check of EncryptResponse.ciphertext can be performed by computing the CRC32C checksum of EncryptResponse.ciphertext 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: 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) —

    Integrity verification field. A CRC32C checksum of the returned EncryptResponse.ciphertext. An integrity check of EncryptResponse.ciphertext can be performed by computing the CRC32C checksum of EncryptResponse.ciphertext 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: 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.



984
985
986
987
 
# File 'proto_docs/google/cloud/kms/v1/service.rb', line 984

class EncryptResponse
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#name ⇒ ::String

Returns The resource name of the CryptoKeyVersion used in encryption. Check this field to verify that the intended resource was used for encryption.

Returns:

  • (::String) —

    The resource name of the CryptoKeyVersion used in encryption. Check this field to verify that the intended resource was used for encryption.



984
985
986
987
 
# File 'proto_docs/google/cloud/kms/v1/service.rb', line 984

class EncryptResponse
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#protection_level ⇒ ::Google::Cloud::Kms::V1::ProtectionLevel

Returns The ProtectionLevel of the CryptoKeyVersion used in encryption.

Returns:



984
985
986
987
 
# File 'proto_docs/google/cloud/kms/v1/service.rb', line 984

class EncryptResponse
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#verified_additional_authenticated_data_crc32c ⇒ ::Boolean

Returns Integrity verification field. A flag indicating whether EncryptRequest.additional_authenticated_data_crc32c was received by KeyManagementService and used for the integrity verification of the AAD. A false value of this field indicates either that EncryptRequest.additional_authenticated_data_crc32c was left unset or that it was not delivered to KeyManagementService. If you've set EncryptRequest.additional_authenticated_data_crc32c but this field is still false, discard the response and perform a limited number of retries.

Returns:



984
985
986
987
 
# File 'proto_docs/google/cloud/kms/v1/service.rb', line 984

class EncryptResponse
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#verified_plaintext_crc32c ⇒ ::Boolean

Returns Integrity verification field. A flag indicating whether EncryptRequest.plaintext_crc32c was received by KeyManagementService and used for the integrity verification of the plaintext. A false value of this field indicates either that EncryptRequest.plaintext_crc32c was left unset or that it was not delivered to KeyManagementService. If you've set EncryptRequest.plaintext_crc32c but this field is still false, discard the response and perform a limited number of retries.

Returns:



984
985
986
987
 
# File 'proto_docs/google/cloud/kms/v1/service.rb', line 984

class EncryptResponse
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end