Struct google_cloudkms1::CryptoKey

pub struct CryptoKey {
    pub labels: Option<HashMap<String, String>>,
    pub name: Option<String>,
    pub rotation_period: Option<String>,
    pub primary: Option<CryptoKeyVersion>,
    pub create_time: Option<String>,
    pub purpose: Option<String>,
    pub version_template: Option<CryptoKeyVersionTemplate>,
    pub next_rotation_time: Option<String>,
}

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

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

Activities

This type is used in activities, which are methods you may call on this type or where this type is involved in. The list links the activity name, along with information about where it is used (one of request and response).

• locations key rings crypto keys get projects (response)
• locations key rings crypto keys update primary version projects (response)
• locations key rings crypto keys create projects (request|response)
• locations key rings crypto keys patch projects (request|response)

Fields

labels: Option<HashMap<String, String>>

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

name: Option<String>

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

rotation_period: Option<String>

next_rotation_time will be advanced by this period when the service automatically rotates a key. Must be at least 24 hours and at most 876,000 hours.

If rotation_period is set, next_rotation_time must also be set.

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

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.

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

create_time: Option<String>

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

purpose: Option<String>

The immutable purpose of this CryptoKey.

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.

next_rotation_time: Option<String>

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.

Trait Implementations

impl ResponseResult for CryptoKey

impl RequestValue for CryptoKey

impl Clone for CryptoKey

fn clone(&self) -> CryptoKey

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for CryptoKey

fn default() -> CryptoKey

Returns the "default value" for a type.

impl Debug for CryptoKey

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

Formats the value using the given formatter.

impl Serialize for CryptoKey

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl<'de> Deserialize<'de> for CryptoKey

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.