Class: Google::Cloud::Kms::V1::DecryptRequest

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

Overview

Request message for KeyManagementService.Decrypt.

Instance Attribute Summary collapse

Instance Attribute Details

#additional_authenticated_data ⇒ ::String

Returns Optional. Optional data that must match the data originally supplied in EncryptRequest.additional_authenticated_data.

Returns:



528
529
530
531
 
# File 'proto_docs/google/cloud/kms/v1/service.rb', line 528

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

#additional_authenticated_data_crc32c ⇒ ::Google::Protobuf::Int64Value

Returns 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.

NOTE: This field is in Beta.

Returns:



528
529
530
531
 
# File 'proto_docs/google/cloud/kms/v1/service.rb', line 528

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

#ciphertext ⇒ ::String

Returns Required. The encrypted data originally returned in EncryptResponse.ciphertext.

Returns:



528
529
530
531
 
# File 'proto_docs/google/cloud/kms/v1/service.rb', line 528

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

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

Returns 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.

NOTE: This field is in Beta.

Returns:



528
529
530
531
 
# File 'proto_docs/google/cloud/kms/v1/service.rb', line 528

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

#name ⇒ ::String

Returns 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.



528
529
530
531
 
# File 'proto_docs/google/cloud/kms/v1/service.rb', line 528

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