Class: Google::Apis::CloudkmsV1::EncryptRequest

Inherits:

Object

• Object
• Google::Apis::CloudkmsV1::EncryptRequest

Includes:

Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport

Defined in:

generated/google/apis/cloudkms_v1/classes.rb,
generated/google/apis/cloudkms_v1/representations.rb,
generated/google/apis/cloudkms_v1/representations.rb

Overview

Request message for KeyManagementService.Encrypt.

Instance Attribute Summary

• #additional_authenticated_data ⇒ String

  Optional.

• #plaintext ⇒ String

  Required.

Instance Method Summary

• #initialize(**args) ⇒ EncryptRequest constructor

  A new instance of EncryptRequest.

• #update!(**args) ⇒ Object

  Update properties of this object.

Methods included from Google::Apis::Core::JsonObjectSupport

#to_json

Methods included from Google::Apis::Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ EncryptRequest

Returns a new instance of EncryptRequest.

# File 'generated/google/apis/cloudkms_v1/classes.rb', line 669

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

Instance Attribute Details

#additional_authenticated_data ⇒ String

Optional. Optional data that, if specified, must also be provided during decryption through DecryptRequest.additional_authenticated_data. The maximum size depends on the key version's protection_level. For SOFTWARE keys, the AAD must be no larger than 64KiB. For HSM keys, the combined length of the plaintext and additional_authenticated_data fields must be no larger than 8KiB. Corresponds to the JSON property additionalAuthenticatedData NOTE: Values are automatically base64 encoded/decoded in the client library.

Returns:

• (String)

# File 'generated/google/apis/cloudkms_v1/classes.rb', line 655

def additional_authenticated_data
  @additional_authenticated_data
end

#plaintext ⇒ String

Required. The data to encrypt. Must be no larger than 64KiB. The maximum size depends on the key version's protection_level. For SOFTWARE keys, the plaintext must be no larger than 64KiB. For HSM keys, the combined length of the plaintext and additional_authenticated_data fields must be no larger than 8KiB. Corresponds to the JSON property plaintext NOTE: Values are automatically base64 encoded/decoded in the client library.

Returns:

• (String)

# File 'generated/google/apis/cloudkms_v1/classes.rb', line 667

def plaintext
  @plaintext
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object

# File 'generated/google/apis/cloudkms_v1/classes.rb', line 674

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