Struct CryptoKeyVersion 

#[non_exhaustive]
pub struct CryptoKeyVersion {

    pub name: String,
    pub state: CryptoKeyVersionState,
    pub protection_level: ProtectionLevel,
    pub algorithm: CryptoKeyVersionAlgorithm,
    pub attestation: Option<KeyOperationAttestation>,
    pub create_time: Option<Timestamp>,
    pub generate_time: Option<Timestamp>,
    pub destroy_time: Option<Timestamp>,
    pub destroy_event_time: Option<Timestamp>,
    pub import_job: String,
    pub import_time: Option<Timestamp>,
    pub import_failure_reason: String,
    pub generation_failure_reason: String,
    pub external_destruction_failure_reason: String,
    pub external_protection_level_options: Option<ExternalProtectionLevelOptions>,
    pub reimport_eligible: bool,
    /* private fields */
}

A CryptoKeyVersion represents an individual cryptographic key, and the associated key material.

An ENABLED version can be used for cryptographic operations.

For security reasons, the raw cryptographic key material represented by a CryptoKeyVersion can never be viewed or exported. It can only be used to encrypt, decrypt, or sign data when an authorized user or application invokes Cloud KMS.

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 CryptoKeyVersion in the format projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*.

state: CryptoKeyVersionState

The current state of the CryptoKeyVersion.

protection_level: ProtectionLevel

Output only. The ProtectionLevel describing how crypto operations are performed with this CryptoKeyVersion.

algorithm: CryptoKeyVersionAlgorithm

Output only. The CryptoKeyVersionAlgorithm that this CryptoKeyVersion supports.

attestation: Option<KeyOperationAttestation>

Output only. Statement that was generated and signed by the HSM at key creation time. Use this statement to verify attributes of the key as stored on the HSM, independently of Google. Only provided for key versions with protection_level HSM.

create_time: Option<Timestamp>

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

generate_time: Option<Timestamp>

Output only. The time this CryptoKeyVersion’s key material was generated.

destroy_time: Option<Timestamp>

Output only. The time this CryptoKeyVersion’s key material is scheduled for destruction. Only present if state is DESTROY_SCHEDULED.

destroy_event_time: Option<Timestamp>

Output only. The time this CryptoKeyVersion’s key material was destroyed. Only present if state is DESTROYED.

import_job: String

Output only. The name of the ImportJob used in the most recent import of this CryptoKeyVersion. Only present if the underlying key material was imported.

import_time: Option<Timestamp>

Output only. The time at which this CryptoKeyVersion’s key material was most recently imported.

import_failure_reason: String

Output only. The root cause of the most recent import failure. Only present if state is IMPORT_FAILED.

generation_failure_reason: String

Output only. The root cause of the most recent generation failure. Only present if state is GENERATION_FAILED.

external_destruction_failure_reason: String

Output only. The root cause of the most recent external destruction failure. Only present if state is EXTERNAL_DESTRUCTION_FAILED.

external_protection_level_options: Option<ExternalProtectionLevelOptions>

ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level and EXTERNAL_VPC protection levels.

reimport_eligible: bool

Output only. Whether or not this key version is eligible for reimport, by being specified as a target in ImportCryptoKeyVersionRequest.crypto_key_version.

Implementations

impl CryptoKeyVersion

pub fn new() -> Self

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

Sets the value of name.

pub fn set_state<T: Into<CryptoKeyVersionState>>(self, v: T) -> Self

Sets the value of state.

pub fn set_protection_level<T: Into<ProtectionLevel>>(self, v: T) -> Self

Sets the value of protection_level.

pub fn set_algorithm<T: Into<CryptoKeyVersionAlgorithm>>(self, v: T) -> Self

Sets the value of algorithm.

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

where T: Into<KeyOperationAttestation>,

Sets the value of attestation.

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

where T: Into<KeyOperationAttestation>,

Sets or clears the value of attestation.

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_generate_time<T>(self, v: T) -> Self

where T: Into<Timestamp>,

Sets the value of generate_time.

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

where T: Into<Timestamp>,

Sets or clears the value of generate_time.

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

where T: Into<Timestamp>,

Sets the value of destroy_time.

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

where T: Into<Timestamp>,

Sets or clears the value of destroy_time.

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

where T: Into<Timestamp>,

Sets the value of destroy_event_time.

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

where T: Into<Timestamp>,

Sets or clears the value of destroy_event_time.

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

Sets the value of import_job.

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

where T: Into<Timestamp>,

Sets the value of import_time.

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

where T: Into<Timestamp>,

Sets or clears the value of import_time.

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

Sets the value of import_failure_reason.

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

Sets the value of generation_failure_reason.

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

Sets the value of external_destruction_failure_reason.

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

where T: Into<ExternalProtectionLevelOptions>,

Sets the value of external_protection_level_options.

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

where T: Into<ExternalProtectionLevelOptions>,

Sets or clears the value of external_protection_level_options.

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

Sets the value of reimport_eligible.

Trait Implementations

impl Clone for CryptoKeyVersion

fn clone(&self) -> CryptoKeyVersion

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CryptoKeyVersion

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

Formats the value using the given formatter.

impl Default for CryptoKeyVersion

fn default() -> CryptoKeyVersion

Returns the “default value” for a type.

impl Message for CryptoKeyVersion

fn typename() -> &'static str

The typename of this message.

impl PartialEq for CryptoKeyVersion

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