Struct cloud_storage::sync::HmacKeyClient

pub struct HmacKeyClient<'a>(_);

Operations on HmacKeys.

Implementations

impl<'a> HmacKeyClient<'a>

pub fn create(&self) -> Result<HmacKey>

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::sync::Client;
use cloud_storage::hmac_key::HmacKey;

let client = Client::new()?;
let hmac_key = client.hmac_key().create()?;

pub fn list(&self) -> 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::sync::Client;
use cloud_storage::hmac_key::HmacKey;

let client = Client::new()?;
let all_hmac_keys = client.hmac_key().list()?;

pub fn read(&self, 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::sync::Client;
use cloud_storage::hmac_key::HmacKey;

let client = Client::new()?;
let key = client.hmac_key().read("some identifier")?;

pub fn update(&self, 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::sync::Client;
use cloud_storage::hmac_key::{HmacKey, HmacState};

let client = Client::new()?;
let key = client.hmac_key().update("your key", HmacState::Active)?;

pub fn delete(&self, 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::sync::Client;
use cloud_storage::hmac_key::{HmacKey, HmacState};

let client = Client::new()?;
let key = client.hmac_key().update("your key", HmacState::Inactive)?; // this is required.
client.hmac_key().delete(&key.access_id)?;

Trait Implementations

impl<'a> Debug for HmacKeyClient<'a>

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

Formats the value using the given formatter.