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

Inherits:

Object

• Object
• Google::Cloud::Kms::V1::EncryptRequest

Defined in:

lib/google/cloud/kms/v1/doc/google/cloud/kms/v1/service.rb

Overview

Request message for KeyManagementService::Encrypt.

Instance Attribute Summary

• #additional_authenticated_data ⇒ String

  Optional data that, if specified, must also be provided during decryption through DecryptRequest#additional_authenticated_data.

• #name ⇒ String

  Required.

• #plaintext ⇒ String

  Required.

Instance Attribute Details

#additional_authenticated_data ⇒ String

Returns Optional data that, if specified, must also be provided during decryption through DecryptRequest#additional_authenticated_data. Must be no larger than 64KiB.

Returns:

• (String) —

  Optional data that, if specified, must also be provided during decryption through DecryptRequest#additional_authenticated_data. Must be no larger than 64KiB.

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

class EncryptRequest; end

#name ⇒ String

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:

• (String) —

  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.

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

class EncryptRequest; end

#plaintext ⇒ String

Returns Required. The data to encrypt. Must be no larger than 64KiB.

Returns:

• (String) —

  Required. The data to encrypt. Must be no larger than 64KiB.

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

class EncryptRequest; end