Struct CmekConfig 

#[non_exhaustive]
pub struct CmekConfig {
    pub kms_key_name: String,
    pub active_key_version: Vec<String>,
    /* private fields */
}

The CMEK (Customer Managed Encryption Key) configuration for a Firestore database. If not present, the database is secured by the default Google encryption key.

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.

kms_key_name: String

Required. Only keys in the same location as this database are allowed to be used for encryption.

For Firestore’s nam5 multi-region, this corresponds to Cloud KMS multi-region us. For Firestore’s eur3 multi-region, this corresponds to Cloud KMS multi-region europe. See https://cloud.google.com/kms/docs/locations.

The expected format is projects/{project_id}/locations/{kms_location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}.

active_key_version: Vec<String>

Output only. Currently in-use KMS key versions. During key rotation, there can be multiple in-use key versions.

The expected format is projects/{project_id}/locations/{kms_location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{key_version}.

Implementations

impl CmekConfig

pub fn new() -> Self

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

Sets the value of kms_key_name.

Example

let x = CmekConfig::new().set_kms_key_name("example");

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

where T: IntoIterator<Item = V>, V: Into<String>,

Sets the value of active_key_version.

Example

let x = CmekConfig::new().set_active_key_version(["a", "b", "c"]);

Trait Implementations

impl Clone for CmekConfig

fn clone(&self) -> CmekConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CmekConfig

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

Formats the value using the given formatter.

impl Default for CmekConfig

fn default() -> CmekConfig

Returns the “default value” for a type.

impl Message for CmekConfig

fn typename() -> &'static str

The typename of this message.

impl PartialEq for CmekConfig

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for CmekConfig