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

此文档由 Cloud KMS crate 版本 5.0.5+20170515 生成，其中 20170515 是由 mako 代码生成器 v5.0.5 构建的 cloudkms:v1beta1 方案的精确修订版。

关于 Cloud KMS v1_beta1 API 的其他所有信息都可以在 官方文档网站 找到。

功能

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

• 项目
• 获取位置，创建位置密钥环，创建位置密钥环加密密钥，创建位置密钥环加密密钥密钥版本，销毁位置密钥环加密密钥密钥版本，获取位置密钥环加密密钥密钥版本，列出位置密钥环加密密钥密钥版本，修复位置密钥环加密密钥密钥版本，恢复位置密钥环加密密钥密钥版本，解密位置密钥环加密密钥，加密位置密钥环加密密钥，获取位置密钥环加密密钥，获取位置密钥环加密密钥 IAM 策略，列出位置密钥环加密密钥，修复位置密钥环加密密钥，设置位置密钥环加密密钥 IAM 策略，测试位置密钥环加密密钥 IAM 权限，更新位置密钥环加密密钥主版本，获取位置密钥环，获取位置密钥环 IAM 策略，列出位置密钥环，设置位置密钥环 IAM 策略，测试位置密钥环 IAM 权限以及列出位置

本库结构

API 结构如下主要项

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

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

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

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

或者具体地 ...

let r = hub.projects().locations_key_rings_crypto_keys_crypto_key_versions_create(...).doit().await
let r = hub.projects().locations_key_rings_crypto_keys_crypto_key_versions_destroy(...).doit().await
let r = hub.projects().locations_key_rings_crypto_keys_crypto_key_versions_restore(...).doit().await
let r = hub.projects().locations_key_rings_crypto_keys_crypto_key_versions_patch(...).doit().await
let r = hub.projects().locations_key_rings_crypto_keys_crypto_key_versions_get(...).doit().await

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

用法

设置您的项目

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

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

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_cloudkms1_beta1 as cloudkms1_beta1;
use cloudkms1_beta1::api::CryptoKeyVersion;
use cloudkms1_beta1::{Result, Error};
use std::default::Default;
use cloudkms1_beta1::{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);
// As the method needs a request, you would usually fill it with the desired information
// into the respective structure. Some of the parts shown here might not be applicable !
// Values shown here are possibly random and not representative !
let mut req = CryptoKeyVersion::default();

// 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_key_rings_crypto_keys_crypto_key_versions_patch(req, "name")
             .update_mask(FieldMask::new::<&str>(&[]))
             .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(...)。

定制和回调

您可以通过在最终调用doit()之前提供一个delegate给Method Builder来更改调用doit()方法的方式。相应的方法将被调用以提供进度信息，并确定系统在失败时是否应该重试。

delegate trait具有默认实现，允许您以最少的努力对其进行自定义。

服务器请求中的可选部分

本库提供的所有结构都旨在通过json进行编码和解码。使用可选值来表示部分请求和响应是有效的。大多数可选值被认为是部分，可以通过名称识别，这些部分将发送到服务器以指示请求的设置部分或期望的响应部分。

构建器参数

通过使用方法构建器，您可以多次调用其方法来准备操作调用。这些方法始终接受单个参数，以下语句对它们成立。

• POD通过复制传递
• 字符串作为&str传递
• 请求值是移动的

参数将被复制或克隆到构建器中，以确保它们与它们的原始生命周期独立。

Cargo功能

• utoipa - 添加对utoipa的支持，并在所有类型上派生utoipa::ToSchema。您必须在#[openapi(schemas(...))]中导入和注册所需类型，否则生成的openapi规范将无效。

许可证

cloudkms1_beta1库由Sebastian Thiel生成，并置于MIT许可证下。您可以在存储库的许可证文件中阅读全文。