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

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

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

特性

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

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

该库的结构

API 结构分为以下主要项目

• 枢纽
  • 一个中心对象，用于维护状态并允许访问所有 活动
  • 创建方法构建器，这又允许访问单个调用构建器
• 资源
  • 可以应用活动的初级类型
  • 一系列属性和部分
  • 部分
    • 一系列属性
    • 从未在活动中直接使用
• 活动
  • 应用于资源的操作

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

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

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

或者具体...

let r = hub.projects().locations_secrets_versions_destroy(...).doit().await
let r = hub.projects().locations_secrets_versions_disable(...).doit().await
let r = hub.projects().locations_secrets_versions_enable(...).doit().await
let r = hub.projects().locations_secrets_versions_get(...).doit().await
let r = hub.projects().locations_secrets_add_version(...).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(...)调用创建构建器。第二个处理活动，支持各种方法来配置即将进行的操作（此处未显示）。它被设计成必须立即指定所有必需的参数（即(...)），而所有可选的参数可以按照需要构建。doit()方法执行与服务器的实际通信并返回相应的结果。

用法

设置您的项目

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

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

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_secretmanager1 as secretmanager1;
use secretmanager1::api::DestroySecretVersionRequest;
use secretmanager1::{Result, Error};
use std::default::Default;
use secretmanager1::{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().locations_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代理或认证代理。

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

上传和下载

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

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

自定义和回调

您可以通过在最终调用 doit() 之前向 方法构建器 提供一个 委托 来更改 doit() 方法的调用方式。相应的函数将被调用以提供进度信息，以及确定系统在失败时是否应该重试。

委托特质 默认实现，允许您以最少的努力对其进行自定义。

服务器请求中的可选部分

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

构建器参数

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

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

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

Cargo 功能

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

许可证

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