Struct DecryptRequest 

#[non_exhaustive]
pub struct DecryptRequest {
    pub name: String,
    pub ciphertext: Bytes,
    pub additional_authenticated_data: Bytes,
    pub ciphertext_crc32c: Option<Int64Value>,
    pub additional_authenticated_data_crc32c: Option<Int64Value>,
    /* private fields */
}

Request message for KeyManagementService.Decrypt.

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 to use for decryption. The server will choose the appropriate version.

ciphertext: Bytes

Required. The encrypted data originally returned in EncryptResponse.ciphertext.

additional_authenticated_data: Bytes

Optional. Optional data that must match the data originally supplied in EncryptRequest.additional_authenticated_data.

ciphertext_crc32c: Option<Int64Value>

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

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 = DecryptRequest::new().set_name(format!("projects/{project_id}/locations/{location_id}/keyRings/{key_ring_id}/cryptoKeys/{crypto_key_id}"));

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

Sets the value of ciphertext.

Example

let x = DecryptRequest::new().set_ciphertext(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 = DecryptRequest::new().set_additional_authenticated_data(bytes::Bytes::from_static(b"example"));

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

where T: Into<Int64Value>,

Sets the value of ciphertext_crc32c.

Example

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

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

where T: Into<Int64Value>,

Sets or clears the value of ciphertext_crc32c.

Example

use wkt::Int64Value;
let x = DecryptRequest::new().set_or_clear_ciphertext_crc32c(Some(Int64Value::default()/* use setters */));
let x = DecryptRequest::new().set_or_clear_ciphertext_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 = DecryptRequest::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 = DecryptRequest::new().set_or_clear_additional_authenticated_data_crc32c(Some(Int64Value::default()/* use setters */));
let x = DecryptRequest::new().set_or_clear_additional_authenticated_data_crc32c(None::<Int64Value>);

Trait Implementations

impl Clone for DecryptRequest

fn clone(&self) -> DecryptRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DecryptRequest

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

Formats the value using the given formatter.

impl Default for DecryptRequest

fn default() -> DecryptRequest

Returns the “default value” for a type.

impl Message for DecryptRequest

fn typename() -> &'static str

The typename of this message.

impl PartialEq for DecryptRequest

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for DecryptRequest