Class: Google::Cloud::Kms::V1::EncryptRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/google/cloud/kms/v1/doc/google/cloud/kms/v1/service.rb

Overview

Request message for KeyManagementService::Encrypt.

Instance Attribute Summary collapse

Instance Attribute Details

#additional_authenticated_dataString

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

Returns:

  • (String)

    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.


271
# File 'lib/google/cloud/kms/v1/doc/google/cloud/kms/v1/service.rb', line 271

class EncryptRequest; end

#nameString

Returns Required. The resource name of the CryptoKey or CryptoKeyVersion to use for encryption.

If a CryptoKey is specified, the server will use its primary version.

Returns:


271
# File 'lib/google/cloud/kms/v1/doc/google/cloud/kms/v1/service.rb', line 271

class EncryptRequest; end

#plaintextString

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

Returns:

  • (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.


271
# File 'lib/google/cloud/kms/v1/doc/google/cloud/kms/v1/service.rb', line 271

class EncryptRequest; end