Struct EncryptRequest 

#[non_exhaustive]
pub struct EncryptRequest {
    pub name: String,
    pub plaintext: Bytes,
    pub additional_authenticated_data: Bytes,
    pub plaintext_crc32c: Option<Int64Value>,
    pub additional_authenticated_data_crc32c: Option<Int64Value>,
    /* private fields */
}

Request message for KeyManagementService.Encrypt.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

name: 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.

plaintext: Bytes

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.

additional_authenticated_data: Bytes

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, EXTERNAL, and EXTERNAL_VPC 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.

plaintext_crc32c: Option<Int64Value>

Optional. An optional CRC32C checksum of the EncryptRequest.plaintext. If specified, KeyManagementService will verify the integrity of the received EncryptRequest.plaintext 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(EncryptRequest.plaintext) is equal to EncryptRequest.plaintext_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.

additional_authenticated_data_crc32c: Option<Int64Value>

Optional. An optional CRC32C checksum of the EncryptRequest.additional_authenticated_data. If specified, KeyManagementService will verify the integrity of the received EncryptRequest.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(EncryptRequest.additional_authenticated_data) is equal to EncryptRequest.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.

Implementations

impl EncryptRequest

pub fn new() -> Self

Creates a new default instance.

pub fn set_name<T: Into<String>>(self, v: T) -> Self

Sets the value of name.

Example

let x = EncryptRequest::new().set_name("example");

pub fn set_plaintext<T: Into<Bytes>>(self, v: T) -> Self

Sets the value of plaintext.

Example

let x = EncryptRequest::new().set_plaintext(bytes::Bytes::from_static(b"example"));

pub fn set_additional_authenticated_data<T: Into<Bytes>>(self, v: T) -> Self

Sets the value of additional_authenticated_data.

Example

let x = EncryptRequest::new().set_additional_authenticated_data(bytes::Bytes::from_static(b"example"));

pub fn set_plaintext_crc32c<T>(self, v: T) -> Self

where T: Into<Int64Value>,

Sets the value of plaintext_crc32c.

Example

use wkt::Int64Value;
let x = EncryptRequest::new().set_plaintext_crc32c(Int64Value::default()/* use setters */);

pub fn set_or_clear_plaintext_crc32c<T>(self, v: Option<T>) -> Self

where T: Into<Int64Value>,

Sets or clears the value of plaintext_crc32c.

Example

use wkt::Int64Value;
let x = EncryptRequest::new().set_or_clear_plaintext_crc32c(Some(Int64Value::default()/* use setters */));
let x = EncryptRequest::new().set_or_clear_plaintext_crc32c(None::<Int64Value>);

pub fn set_additional_authenticated_data_crc32c<T>(self, v: T) -> Self

where T: Into<Int64Value>,

Sets the value of additional_authenticated_data_crc32c.

Example

use wkt::Int64Value;
let x = EncryptRequest::new().set_additional_authenticated_data_crc32c(Int64Value::default()/* use setters */);

pub fn set_or_clear_additional_authenticated_data_crc32c<T>( self, v: Option<T>, ) -> Self

where T: Into<Int64Value>,

Sets or clears the value of additional_authenticated_data_crc32c.

Example

use wkt::Int64Value;
let x = EncryptRequest::new().set_or_clear_additional_authenticated_data_crc32c(Some(Int64Value::default()/* use setters */));
let x = EncryptRequest::new().set_or_clear_additional_authenticated_data_crc32c(None::<Int64Value>);

Trait Implementations

impl Clone for EncryptRequest

fn clone(&self) -> EncryptRequest

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for EncryptRequest

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for EncryptRequest

fn default() -> EncryptRequest

Returns the “default value” for a type.

impl Message for EncryptRequest

fn typename() -> &'static str

The typename of this message.

impl PartialEq for EncryptRequest

fn eq(&self, other: &EncryptRequest) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for EncryptRequest