Struct cloud_storage::hmac_key::HmacKey

pub struct HmacKey {
    pub kind: String,
    pub metadata: HmacMeta,
    pub secret: String,
}

The HmacKey resource represents an HMAC key within Cloud Storage. The resource consists of a secret and HmacMeta. HMAC keys can be used as credentials for service accounts. For more information, see HMAC Keys.

Note that the HmacKey resource is only returned when you use HmacKey::create. Other methods, such as HmacKey::read, return the metadata portion of the HMAC key resource.

Fields

kind: String

The kind of item this is. For HMAC keys, this is always storage#hmacKey.

metadata: HmacMeta

HMAC key metadata.

secret: String

HMAC secret key material.

Implementations

impl HmacKey

pub async fn create() -> Result<Self>

Creates a new HMAC key for the specified service account.

The authenticated user must have storage.hmacKeys.create permission for the project in which the key will be created.

For general information about HMAC keys in Cloud Storage, see HMAC Keys.

Example

use cloud_storage::hmac_key::HmacKey;

let hmac_key = HmacKey::create().await?;

pub fn create_sync() -> Result<Self>

The synchronous equivalent of HmacKey::create.

Features

This function requires that the feature flag sync is enabled in Cargo.toml.

pub async fn list() -> Result<Vec<HmacMeta>>

Retrieves a list of HMAC keys matching the criteria. Since the HmacKey is secret, this does not return a HmacKey, but a HmacMeta. This is a redacted version of a HmacKey, but with the secret data omitted.

The authenticated user must have storage.hmacKeys.list permission for the project in which the key exists.

For general information about HMAC keys in Cloud Storage, see HMAC Keys.

Example

use cloud_storage::hmac_key::HmacKey;

let all_hmac_keys = HmacKey::list().await?;

pub fn list_sync() -> Result<Vec<HmacMeta>>

The synchronous equivalent of HmacKey::list.

Features

This function requires that the feature flag sync is enabled in Cargo.toml.

pub async fn read(access_id: &str) -> Result<HmacMeta>

Retrieves an HMAC key’s metadata. Since the HmacKey is secret, this does not return a HmacKey, but a HmacMeta. This is a redacted version of a HmacKey, but with the secret data omitted.

The authenticated user must have storage.hmacKeys.get permission for the project in which the key exists.

For general information about HMAC keys in Cloud Storage, see HMAC Keys.

Example

use cloud_storage::hmac_key::HmacKey;

let key = HmacKey::read("some identifier").await?;

pub fn read_sync(access_id: &str) -> Result<HmacMeta>

The synchronous equivalent of HmacKey::read.

Features

This function requires that the feature flag sync is enabled in Cargo.toml.

pub async fn update(access_id: &str, state: HmacState) -> Result<HmacMeta>

Updates the state of an HMAC key. See the HMAC Key resource descriptor for valid states. Since the HmacKey is secret, this does not return a HmacKey, but a HmacMeta. This is a redacted version of a HmacKey, but with the secret data omitted.

The authenticated user must have storage.hmacKeys.update permission for the project in which the key exists.

For general information about HMAC keys in Cloud Storage, see HMAC Keys.

Example

use cloud_storage::hmac_key::{HmacKey, HmacState};

let key = HmacKey::update("your key", HmacState::Active).await?;

pub fn update_sync(access_id: &str, state: HmacState) -> Result<HmacMeta>

The synchronous equivalent of HmacKey::update.

Features

This function requires that the feature flag sync is enabled in Cargo.toml.

pub async fn delete(access_id: &str) -> Result<()>

Deletes an HMAC key. Note that a key must be set to Inactive first.

The authenticated user must have storage.hmacKeys.delete permission for the project in which the key exists.

For general information about HMAC keys in Cloud Storage, see HMAC Keys.

Example

use cloud_storage::hmac_key::{HmacKey, HmacState};

let key = HmacKey::update("your key", HmacState::Inactive).await?; // this is required.
HmacKey::delete(&key.access_id).await?;

pub fn delete_sync(access_id: &str) -> Result<()>

The synchronous equivalent of HmacKey::delete.

Trait Implementations

impl Debug for HmacKey

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for HmacKey

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

Deserialize this value from the given Serde deserializer.

impl PartialEq<HmacKey> for HmacKey

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Serialize for HmacKey

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

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for HmacKey