Struct CryptoKey 

#[non_exhaustive]
pub struct CryptoKey {
    pub name: String,
    pub primary: Option<CryptoKeyVersion>,
    pub purpose: CryptoKeyPurpose,
    pub create_time: Option<Timestamp>,
    pub next_rotation_time: Option<Timestamp>,
    pub version_template: Option<CryptoKeyVersionTemplate>,
    pub labels: HashMap<String, String>,
    pub import_only: bool,
    pub destroy_scheduled_duration: Option<Duration>,
    pub crypto_key_backend: String,
    pub key_access_justifications_policy: Option<KeyAccessJustificationsPolicy>,
    pub rotation_schedule: Option<RotationSchedule>,
    /* private fields */
}

A CryptoKey represents a logical key that can be used for cryptographic operations.

A CryptoKey is made up of zero or more versions, which represent the actual key material used in cryptographic operations.

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

Output only. The resource name for this CryptoKey in the format projects/*/locations/*/keyRings/*/cryptoKeys/*.

primary: Option<CryptoKeyVersion>

Output only. A copy of the “primary” CryptoKeyVersion that will be used by Encrypt when this CryptoKey is given in EncryptRequest.name.

The CryptoKey’s primary version can be updated via UpdateCryptoKeyPrimaryVersion.

Keys with purpose ENCRYPT_DECRYPT may have a primary. For other keys, this field will be omitted.

purpose: CryptoKeyPurpose

Immutable. The immutable purpose of this CryptoKey.

create_time: Option<Timestamp>

Output only. The time at which this CryptoKey was created.

next_rotation_time: Option<Timestamp>

At next_rotation_time, the Key Management Service will automatically:

1. Create a new version of this CryptoKey.
2. Mark the new version as primary.

Key rotations performed manually via CreateCryptoKeyVersion and UpdateCryptoKeyPrimaryVersion do not affect next_rotation_time.

Keys with purpose ENCRYPT_DECRYPT support automatic rotation. For other keys, this field must be omitted.

version_template: Option<CryptoKeyVersionTemplate>

A template describing settings for new CryptoKeyVersion instances. The properties of new CryptoKeyVersion instances created by either CreateCryptoKeyVersion or auto-rotation are controlled by this template.

labels: HashMap<String, String>

Labels with user-defined metadata. For more information, see Labeling Keys.

import_only: bool

Immutable. Whether this key may contain imported versions only.

destroy_scheduled_duration: Option<Duration>

Immutable. The period of time that versions of this key spend in the DESTROY_SCHEDULED state before transitioning to DESTROYED. If not specified at creation time, the default duration is 30 days.

crypto_key_backend: String

Immutable. The resource name of the backend environment where the key material for all CryptoKeyVersions associated with this CryptoKey reside and where all related cryptographic operations are performed. Only applicable if CryptoKeyVersions have a ProtectionLevel of EXTERNAL_VPC, with the resource name in the format projects/*/locations/*/ekmConnections/*. Note, this list is non-exhaustive and may apply to additional ProtectionLevels in the future.

key_access_justifications_policy: Option<KeyAccessJustificationsPolicy>

Optional. The policy used for Key Access Justifications Policy Enforcement. If this field is present and this key is enrolled in Key Access Justifications Policy Enforcement, the policy will be evaluated in encrypt, decrypt, and sign operations, and the operation will fail if rejected by the policy. The policy is defined by specifying zero or more allowed justification codes. https://cloud.google.com/assured-workloads/key-access-justifications/docs/justification-codes By default, this field is absent, and all justification codes are allowed.

rotation_schedule: Option<RotationSchedule>

Controls the rate of automatic rotation.

Implementations

impl CryptoKey

pub fn new() -> Self

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

Sets the value of name.

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

where T: Into<CryptoKeyVersion>,

Sets the value of primary.

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

where T: Into<CryptoKeyVersion>,

Sets or clears the value of primary.

pub fn set_purpose<T: Into<CryptoKeyPurpose>>(self, v: T) -> Self

Sets the value of purpose.

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

where T: Into<Timestamp>,

Sets the value of create_time.

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

where T: Into<Timestamp>,

Sets or clears the value of create_time.

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

where T: Into<Timestamp>,

Sets the value of next_rotation_time.

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

where T: Into<Timestamp>,

Sets or clears the value of next_rotation_time.

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

where T: Into<CryptoKeyVersionTemplate>,

Sets the value of version_template.

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

where T: Into<CryptoKeyVersionTemplate>,

Sets or clears the value of version_template.

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

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

Sets the value of labels.

pub fn set_import_only<T: Into<bool>>(self, v: T) -> Self

Sets the value of import_only.

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

where T: Into<Duration>,

Sets the value of destroy_scheduled_duration.

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

where T: Into<Duration>,

Sets or clears the value of destroy_scheduled_duration.

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

Sets the value of crypto_key_backend.

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

where T: Into<KeyAccessJustificationsPolicy>,

Sets the value of key_access_justifications_policy.

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

where T: Into<KeyAccessJustificationsPolicy>,

Sets or clears the value of key_access_justifications_policy.

pub fn set_rotation_schedule<T: Into<Option<RotationSchedule>>>( self, v: T, ) -> Self

Sets the value of rotation_schedule.

Note that all the setters affecting rotation_schedule are mutually exclusive.

pub fn rotation_period(&self) -> Option<&Box<Duration>>

The value of rotation_schedule if it holds a RotationPeriod, None if the field is not set or holds a different branch.

pub fn set_rotation_period<T: Into<Box<Duration>>>(self, v: T) -> Self

Sets the value of rotation_schedule to hold a RotationPeriod.

Note that all the setters affecting rotation_schedule are mutually exclusive.

Trait Implementations

impl Clone for CryptoKey

fn clone(&self) -> CryptoKey

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CryptoKey

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

Formats the value using the given formatter.

impl Default for CryptoKey

fn default() -> CryptoKey

Returns the “default value” for a type.

impl Message for CryptoKey

fn typename() -> &'static str

The typename of this message.

impl PartialEq for CryptoKey

fn eq(&self, other: &CryptoKey) -> 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 CryptoKey