该 google-secretmanager1_beta1 库允许访问 Google Secret Manager 服务的所有功能。

本文档由 Secret Manager 库版本 5.0.5+20240621 生成，其中 20240621 是由 mako 代码生成器 v5.0.5 构建的 secretmanager:v1beta1 模式的确切修订。

关于 Secret Manager v1_beta1 API 的其他所有信息，请参阅 官方文档网站。

功能

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

• 项目
• 获取位置，列出位置，添加密钥版本，创建密钥，删除密钥，获取密钥，获取 IAM 策略，列出密钥，修补密钥，设置 IAM 策略，测试 IAM 权限，访问版本，销毁版本，禁用版本，启用版本，获取版本和列出版本

本库的结构

API 结构如下主要项目

• 中心
  • 一个中心对象，用于维护状态并允许访问所有 活动
  • 创建 方法构建器，这些构建器再依次允许访问单个 调用构建器
• 资源
  • 主要类型，您可以对其应用 活动
  • 属性和 部分 的集合
  • 部分
    • 属性的集合
    • 在 活动 中从不直接使用
• 活动
  • 应用到 资源 上的操作

所有 结构 都带有适用的特质，以进一步分类它们并便于浏览。

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

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

或者具体...

let r = hub.projects().secrets_versions_destroy(...).doit().await
let r = hub.projects().secrets_versions_disable(...).doit().await
let r = hub.projects().secrets_versions_enable(...).doit().await
let r = hub.projects().secrets_versions_get(...).doit().await
let r = hub.projects().secrets_add_version(...).doit().await

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

用法

设置您的项目

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

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

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_secretmanager1_beta1 as secretmanager1_beta1;
use secretmanager1_beta1::api::DestroySecretVersionRequest;
use secretmanager1_beta1::{Result, Error};
use std::default::Default;
use secretmanager1_beta1::{SecretManager, 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 = SecretManager::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 = DestroySecretVersionRequest::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().secrets_versions_destroy(req, "name")
             .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()之前向Method Builder提供一个代理来改变doit()方法的调用方式。将调用相应的方法以提供进度信息，并确定系统是否应在失败时重试。

代理特质默认实现，允许您以最小的努力进行定制。

服务器请求中的可选部分

此库提供的所有结构都是通过json进行编码和解码的。选项用于表示部分请求和响应都是有效的。大多数选项都是被认为是部分，可由名称识别，将发送到服务器以指示请求的设置部分或响应中希望的部分。

构建器参数

通过方法构建器，您可以通过重复调用它的方法来准备一个动作调用。这些方法始终接受单个参数，以下陈述是真实的。

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

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

Cargo 功能

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

许可证

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