Struct ImportJob 

#[non_exhaustive]
pub struct ImportJob {
    pub name: String,
    pub import_method: ImportMethod,
    pub protection_level: ProtectionLevel,
    pub create_time: Option<Timestamp>,
    pub generate_time: Option<Timestamp>,
    pub expire_time: Option<Timestamp>,
    pub expire_event_time: Option<Timestamp>,
    pub state: ImportJobState,
    pub public_key: Option<WrappingPublicKey>,
    pub attestation: Option<KeyOperationAttestation>,
    /* private fields */
}

An ImportJob can be used to create CryptoKeys and CryptoKeyVersions using pre-existing key material, generated outside of Cloud KMS.

When an ImportJob is created, Cloud KMS will generate a “wrapping key”, which is a public/private key pair. You use the wrapping key to encrypt (also known as wrap) the pre-existing key material to protect it during the import process. The nature of the wrapping key depends on the choice of import_method. When the wrapping key generation is complete, the state will be set to ACTIVE and the public_key can be fetched. The fetched public key can then be used to wrap your pre-existing key material.

Once the key material is wrapped, it can be imported into a new CryptoKeyVersion in an existing CryptoKey by calling ImportCryptoKeyVersion. Multiple CryptoKeyVersions can be imported with a single ImportJob. Cloud KMS uses the private key portion of the wrapping key to unwrap the key material. Only Cloud KMS has access to the private key.

An ImportJob expires 3 days after it is created. Once expired, Cloud KMS will no longer be able to import or unwrap any key material that was wrapped with the ImportJob’s public key.

For more information, see Importing a 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.

name: String

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

import_method: ImportMethod

Required. Immutable. The wrapping method to be used for incoming key material.

protection_level: ProtectionLevel

Required. Immutable. The protection level of the ImportJob. This must match the protection_level of the version_template on the CryptoKey you attempt to import into.

create_time: Option<Timestamp>

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

generate_time: Option<Timestamp>

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

expire_time: Option<Timestamp>

Output only. The time at which this ImportJob is scheduled for expiration and can no longer be used to import key material.

expire_event_time: Option<Timestamp>

Output only. The time this ImportJob expired. Only present if state is EXPIRED.

state: ImportJobState

Output only. The current state of the ImportJob, indicating if it can be used.

public_key: Option<WrappingPublicKey>

Output only. The public key with which to wrap key material prior to import. Only returned if state is ACTIVE.

attestation: Option<KeyOperationAttestation>

Output only. Statement that was generated and signed by the key creator (for example, an HSM) at key creation time. Use this statement to verify attributes of the key as stored on the HSM, independently of Google. Only present if the chosen ImportMethod is one with a protection level of HSM.

Implementations

impl ImportJob

pub fn new() -> Self

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

Sets the value of name.

pub fn set_import_method<T: Into<ImportMethod>>(self, v: T) -> Self

Sets the value of import_method.

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

Sets the value of protection_level.

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

where T: Into<Timestamp>,

Sets the value of expire_time.

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

where T: Into<Timestamp>,

Sets or clears the value of expire_time.

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

where T: Into<Timestamp>,

Sets the value of expire_event_time.

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

where T: Into<Timestamp>,

Sets or clears the value of expire_event_time.

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

Sets the value of state.

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

where T: Into<WrappingPublicKey>,

Sets the value of public_key.

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

where T: Into<WrappingPublicKey>,

Sets or clears the value of public_key.

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.

Trait Implementations

impl Clone for ImportJob

fn clone(&self) -> ImportJob

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ImportJob

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

Formats the value using the given formatter.

impl Default for ImportJob

fn default() -> ImportJob

Returns the “default value” for a type.

impl Message for ImportJob

fn typename() -> &'static str

The typename of this message.

impl PartialEq for ImportJob

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