google-cloudshell1 库允许访问 Google Cloud Shell 服务所有功能。

本文档由 Cloud Shell crate 版本 5.0.5+20240624 生成，其中 20240624 是由 mako 代码生成器 v5.0.5 构建的 cloudshell:v1 方案的精确修订。

关于 Cloud Shell v1 API 的其他内容可以在 官方文档网站 找到。

功能

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

• 操作
• 取消、删除、获取 和 列出
• 用户
• 添加公钥到环境、授权环境、获取环境、从环境中删除公钥 和 启动环境

本库的结构

API 被组织成以下主要项目

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

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

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

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

或者具体...

let r = hub.operations().cancel(...).doit().await
let r = hub.operations().delete(...).doit().await
let r = hub.operations().get(...).doit().await
let r = hub.operations().list(...).doit().await
let r = hub.users().environments_add_public_key(...).doit().await
let r = hub.users().environments_authorize(...).doit().await
let r = hub.users().environments_remove_public_key(...).doit().await
let r = hub.users().environments_start(...).doit().await

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

使用方法

设置您的项目

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

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

完整示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_cloudshell1 as cloudshell1;
use cloudshell1::{Result, Error};
use std::default::Default;
use cloudshell1::{CloudShell, 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 = CloudShell::new(hyper::Client::builder().build(hyper_rustls::HttpsConnectorBuilder::new().with_native_roots().unwrap().https_or_http().enable_http1().build()), auth);
// 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.operations().list("name")
             .page_token("magna")
             .page_size(-11)
             .filter("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 规范将无效。

许可证

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