Lib.rs

› 网络编程
#google-api #google #protocols #web #web-api #baremetalsolution

google-baremetalsolution2

一个完整的库，用于与 baremetalsolution (协议 v2) 交互

由 Sebastian Thiel 和 48位贡献者 编写

8 个版本 (稳定)

5.0.5+20240617 2024年6月27日
5.0.4+20240228 2024年3月5日
5.0.3+20230113 2023年8月23日
5.0.2+20230113 2023年3月16日
3.0.0+20220209 2022年3月8日

#2790 in 网络编程


在 google-baremetalsolution2… 中使用

MIT 许可证

1MB
11K SLoC

《google-baremetalsolution2》库允许访问 Google baremetalsolution 服务的所有功能。

本文档由 baremetalsolution 包版本 5.0.5+20240617 生成，其中 20240617 是由 mako 代码生成器 v5.0.5 构建的 baremetalsolution:v2 模式的确切修订版本。

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

功能

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

本库的结构

API 被组织成以下主要项目

  • 中心
  • 资源
    • 你可以将 活动 应用到其上的主要类型
    • 一组属性和 部分
    • 部分
      • 一组属性
      • 在 活动 中从不直接使用
  • 活动
    • 应用于 资源 的操作

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

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

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

或具体地 ...

let r = hub.projects().locations_instances_detach_lun(...).doit().await
let r = hub.projects().locations_instances_disable_hyperthreading(...).doit().await
let r = hub.projects().locations_instances_disable_interactive_serial_console(...).doit().await
let r = hub.projects().locations_instances_enable_hyperthreading(...).doit().await
let r = hub.projects().locations_instances_enable_interactive_serial_console(...).doit().await
let r = hub.projects().locations_instances_patch(...).doit().await
let r = hub.projects().locations_instances_reimage(...).doit().await
let r = hub.projects().locations_instances_reset(...).doit().await
let r = hub.projects().locations_instances_start(...).doit().await
let r = hub.projects().locations_instances_stop(...).doit().await
let r = hub.projects().locations_networks_patch(...).doit().await
let r = hub.projects().locations_nfs_shares_create(...).doit().await
let r = hub.projects().locations_nfs_shares_delete(...).doit().await
let r = hub.projects().locations_nfs_shares_patch(...).doit().await
let r = hub.projects().locations_operations_get(...).doit().await
let r = hub.projects().locations_volumes_luns_evict(...).doit().await
let r = hub.projects().locations_volumes_snapshots_restore_volume_snapshot(...).doit().await
let r = hub.projects().locations_volumes_evict(...).doit().await
let r = hub.projects().locations_volumes_patch(...).doit().await
let r = hub.projects().locations_volumes_resize(...).doit().await

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

使用方法

设置你的项目

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

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

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_baremetalsolution2 as baremetalsolution2;
use baremetalsolution2::api::Instance;
use baremetalsolution2::{Result, Error};
use std::default::Default;
use baremetalsolution2::{Baremetalsolution, 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 = Baremetalsolution::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 = Instance::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_instances_patch(req, "name")
             .update_mask(FieldMask::new::<&str>(&[]))
             .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(...)。

定制和回调

您可以通过向Method Builder提供代理来更改doit()方法的调用方式，在最终调用doit()之前。将调用相应的方法以提供进度信息，并确定系统是否应在失败时重试。

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

服务器请求中的可选部分

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

构建器参数

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

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

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

Cargo 特性

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

许可证

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

依赖关系

~12–23MB
~343K SLoC