该 google-oslogin1_beta 库允许访问 Google Cloud OS Login 服务（协议 v1beta）的所有功能。

此文档是从 Cloud OS Login 包版本 5.0.5+20240616 生成的，其中 20240616 是由 mako 代码生成器 v5.0.5 构建的 oslogin:v1beta 架构的确切修订版本。

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

功能

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

• 用户
• 获取登录配置文件，导入 SSH 公钥，项目删除，项目位置签名 SSH 公钥，项目区域签名 SSH 公钥，创建 SSH 公钥，删除 SSH 公钥，获取 SSH 公钥 和 修补 SSH 公钥

本库的结构

API 结构如下主要项目

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

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

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

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

或者具体来说 ...

let r = hub.users().ssh_public_keys_create(...).doit().await
let r = hub.users().ssh_public_keys_get(...).doit().await
let r = hub.users().ssh_public_keys_patch(...).doit().await
let r = hub.users().import_ssh_public_key(...).doit().await

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

用法

设置你的项目

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

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

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_oslogin1_beta as oslogin1_beta;
use oslogin1_beta::api::SshPublicKey;
use oslogin1_beta::{Result, Error};
use std::default::Default;
use oslogin1_beta::{CloudOSLogin, 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 = CloudOSLogin::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 = SshPublicKey::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.users().import_ssh_public_key(req, "parent")
             .view("magna")
             .add_regions("no")
             .project_id("ipsum")
             .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 编码和解码而设计的。使用可选参数来表示部分请求和响应是有效的。大多数可选参数都是被认为是 部分，这些部分可以通过名称识别，将被发送到服务器以指示请求中设置的各部分或响应中期望的部分。

构建器参数

通过使用 方法构建器，您可以通过重复调用其方法来准备一个操作调用。这些方法始终接受一个参数，以下陈述对此参数是正确的。

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

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

Cargo 功能

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

许可证

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