Cloud Key Management Service (KMS) V1 API - Class Google::Cloud::Kms::V1::EncryptRequest (v0.23.0)

Reference documentation and code samples for the Cloud Key Management Service (KMS) V1 API class Google::Cloud::Kms::V1::EncryptRequest.

Request message for KeyManagementService.Encrypt.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#additional_authenticated_data

def additional_authenticated_data() -> ::String
Returns

#additional_authenticated_data=

def additional_authenticated_data=(value) -> ::String
Parameter
Returns

#additional_authenticated_data_crc32c

def additional_authenticated_data_crc32c() -> ::Google::Protobuf::Int64Value
Returns

#additional_authenticated_data_crc32c=

def additional_authenticated_data_crc32c=(value) -> ::Google::Protobuf::Int64Value
Parameter
Returns

#name

def name() -> ::String
Returns

#name=

def name=(value) -> ::String
Parameter
Returns

#plaintext

def plaintext() -> ::String
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, EXTERNAL, and EXTERNAL_VPC 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.

#plaintext=

def plaintext=(value) -> ::String
Parameter
  • value (::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, EXTERNAL, and EXTERNAL_VPC 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, EXTERNAL, and EXTERNAL_VPC 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.

#plaintext_crc32c

def plaintext_crc32c() -> ::Google::Protobuf::Int64Value
Returns

#plaintext_crc32c=

def plaintext_crc32c=(value) -> ::Google::Protobuf::Int64Value
Parameter
Returns