该 google-cloudkms1 库允许访问 Google Cloud KMS 服务的所有功能。

此文档是从 Cloud KMS crate 版本 5.0.5+20240621 生成的，其中 20240621 是由 mako 代码生成器 v5.0.5 构建的 cloudkms:v1 架构的确切修订版本。

有关 Cloud KMS v1 API 的所有其他信息，请参阅 官方文档网站。

特性

轻松从中央 中心 处理以下 资源 ...

• 文件夹
• 获取自动密钥配置 和 更新自动密钥配置
• 项目
• locations ekm config get iam policy, locations ekm config set iam policy, locations ekm config test iam permissions, locations ekm connections create, locations ekm connections get, locations ekm connections get iam policy, locations ekm connections list, locations ekm connections patch, locations ekm connections set iam policy, locations ekm connections test iam permissions, locations ekm connections verify connectivity, locations generate random bytes, locations get, locations get ekm config, locations key handles create, locations key handles get, locations key handles list, locations key rings create, locations key rings crypto keys create, locations key rings crypto keys crypto key versions asymmetric decrypt, locations key rings crypto keys crypto key versions asymmetric sign, locations key rings crypto keys crypto key versions create, locations key rings crypto keys crypto key versions destroy, locations key rings crypto keys crypto key versions get, locations key rings crypto keys crypto key versions get public key, locations key rings crypto keys crypto key versions import, locations key rings crypto keys crypto key versions list, locations key rings crypto keys crypto key versions mac sign, locations key rings crypto keys crypto key versions mac verify, locations key rings crypto keys crypto key versions patch, locations key rings crypto keys crypto key versions raw decrypt, locations key rings crypto keys crypto key versions raw encrypt, locations key rings crypto keys crypto key versions restore, locations key rings crypto keys decrypt, locations key rings crypto keys encrypt, locations key rings crypto keys get, locations key rings crypto keys get iam policy, locations key rings crypto keys list, locations key rings crypto keys patch, locations key rings crypto keys set iam policy, locations key rings crypto keys test iam permissions, locations key rings crypto keys update primary version, locations key rings get, locations key rings get iam policy, locations key rings import jobs create, locations key rings import jobs get, locations key rings import jobs get iam policy, locations key rings import jobs list, locations key rings import jobs set iam policy, locations key rings import jobs test iam permissions, locations key rings list, locations key rings set iam policy, locations key rings test iam permissions, locations list, locations operations get, locations update ekm config and show effective autokey config

库结构

API 结构为以下主要项

• 中心
  • 一个中央对象，用于维护状态并允许访问所有 活动
  • 创建 方法构建器，这些构建器反过来又允许访问单个 调用构建器
• 资源
  • 主要类型，您可以将 活动 应用到这些类型上
  • 一组属性和 部分
  • 部分
    • 一组属性
    • 永远不会直接在 活动 中使用
• 活动
  • 应用于 资源 的操作

所有 结构 都带有适用的特性和标记，以进一步分类它们并简化浏览。

一般来说，您可以像这样调用 活动

let r = hub.resource().activity(...).doit().await

或具体地 ...

let r = hub.projects().locations_ekm_config_get_iam_policy(...).doit().await
let r = hub.projects().locations_ekm_config_set_iam_policy(...).doit().await
let r = hub.projects().locations_ekm_connections_get_iam_policy(...).doit().await
let r = hub.projects().locations_ekm_connections_set_iam_policy(...).doit().await
let r = hub.projects().locations_key_rings_crypto_keys_get_iam_policy(...).doit().await
let r = hub.projects().locations_key_rings_crypto_keys_set_iam_policy(...).doit().await
let r = hub.projects().locations_key_rings_import_jobs_get_iam_policy(...).doit().await
let r = hub.projects().locations_key_rings_import_jobs_set_iam_policy(...).doit().await
let r = hub.projects().locations_key_rings_get_iam_policy(...).doit().await
let r = hub.projects().locations_key_rings_set_iam_policy(...).doit().await

资源 resource() 和活动 activity(...) 调用创建了 构建器。第二个处理 Activities，支持各种方法来配置即将进行的操作（此处未显示）。它被设计成必须立即指定所有必需的参数（即 (...)），而所有可选的参数则可以根据需要 逐步构建。doit() 方法执行与服务器实际的通信并返回相应的结果。

用法

设置您的项目

要使用此库，您需要将以下行放入您的 Cargo.toml 文件中

[dependencies]
google-cloudkms1 = "*"
serde = "^1.0"
serde_json = "^1.0"

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_cloudkms1 as cloudkms1;
use cloudkms1::{Result, Error};
use std::default::Default;
use cloudkms1::{CloudKMS, oauth2, hyper, hyper_rustls, chrono, FieldMask};

// Get an ApplicationSecret instance by some means. It contains the `client_id` and 
// `client_secret`, among other things.
let secret: oauth2::ApplicationSecret = Default::default();
// Instantiate the authenticator. It will choose a suitable authentication flow for you, 
// unless you replace  `None` with the desired Flow.
// Provide your own `AuthenticatorDelegate` to adjust the way it operates and get feedback about 
// what's going on. You probably want to bring in your own `TokenStorage` to persist tokens and
// retrieve them from storage.
let auth = oauth2::InstalledFlowAuthenticator::builder(
        secret,
        oauth2::InstalledFlowReturnMethod::HTTPRedirect,
    ).build().await.unwrap();
let mut hub = CloudKMS::new(hyper::Client::builder().build(hyper_rustls::HttpsConnectorBuilder::new().with_native_roots().unwrap().https_or_http().enable_http1().build()), auth);
// You can configure optional parameters by calling the respective setters at will, and
// execute the final call using `doit()`.
// Values shown here are possibly random and not representative !
let result = hub.projects().locations_ekm_config_get_iam_policy("resource")
             .options_requested_policy_version(-33)
             .doit().await;

match result {
    Err(e) => match e {
        // The Error enum provides details about what exactly happened.
        // You can also just use its `Debug`, `Display` or `Error` traits
         Error::HttpError(_)
        |Error::Io(_)
        |Error::MissingAPIKey
        |Error::MissingToken(_)
        |Error::Cancelled
        |Error::UploadSizeLimitExceeded(_, _)
        |Error::Failure(_)
        |Error::BadRequest(_)
        |Error::FieldClash(_)
        |Error::JsonDecodeError(_, _) => println!("{}", e),
    },
    Ok(res) => println!("Success: {:?}", res),
}

错误处理

系统产生的所有错误都作为 Result 枚举提供，作为 doit() 方法的返回值，或者作为可能的中继结果传递给 Hub Delegate 或 Authenticator Delegate。

当代理处理错误或中间值时，它们可能会有机会指示系统重试。这使得系统可能对所有类型的错误都具有弹性。

上传和下载

如果方法支持下载，则响应体（是 Result 的一部分）应由您读取以获取媒体。如果该方法还支持 Response Result，则默认返回该结果。您可以将其视为实际媒体的元数据。要触发媒体下载，您必须通过以下调用设置构建器：.param("alt", "media")。

支持上传的方法可以使用多达 2 种不同的协议进行上传：简单 和 可恢复。每种协议的独特性由定制的 doit(...) 方法表示，分别命名为 upload(...) 和 upload_resumable(...)。