google-apikeys2 库允许访问 Google Api Keys Service 服务的所有功能。

本文档是从 Api Keys Service crate版本 5.0.5+20240623 生成的，其中 20240623 是由 mako 代码生成器 v5.0.5 构建的 apikeys:v2 模式的确切版本。

有关Api Keys Service v2 API的其他所有信息，请参阅官方文档网站。

功能

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

• 密钥
• 查找密钥
• 操作
• 获取
• 项目
• locations keys create，locations keys delete，locations keys get，locations keys get key string，locations keys list，locations keys patch 和 locations keys undelete

本库的结构

API结构化为以下主要项目

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

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

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

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

或者具体...

let r = hub.operations().get(...).doit().await
let r = hub.projects().locations_keys_create(...).doit().await
let r = hub.projects().locations_keys_delete(...).doit().await
let r = hub.projects().locations_keys_patch(...).doit().await
let r = hub.projects().locations_keys_undelete(...).doit().await

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

用法

设置你的项目

要使用这个库，你需要在你的Cargo.toml文件中添加以下几行

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

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_apikeys2 as apikeys2;
use apikeys2::api::V2Key;
use apikeys2::{Result, Error};
use std::default::Default;
use apikeys2::{ApiKeysService, 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 = ApiKeysService::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 = V2Key::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_keys_create(req, "parent")
             .key_id("magna")
             .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()方法的调用方式，在执行最终的doit()调用之前。相应的函数将被调用以提供进度信息，以及确定系统在失败时是否应该重试。

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

服务器请求中的可选部分

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

构建器参数

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

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

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

Cargo功能

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

许可证

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