#google #google-api #protocols #web #web-api #api #assuredworkloads

google-assuredworkloads1

一个完整的库,用于与 Assuredworkloads(协议 v1)交互

11 个稳定版本 (3 个主要版本)

5.0.5+20240617 2024年6月27日
5.0.4+20240222 2024年3月5日
5.0.3+20230116 2023年8月23日
5.0.2+20230116 2023年3月16日
2.0.4+20210325 2021年4月14日

#2825 in 网页编程


用于 google-assuredworkloads1-…

MIT 许可证

335KB
4K SLoC

google-assuredworkloads1 库允许访问 Google Assuredworkloads 服务的所有功能。

此文档是从 Assuredworkloads crate 版本 5.0.5+20240617 生成的,其中 20240617 是由 mako 代码生成器 v5.0.5 构建的 assuredworkloads:v1 模式的确切修订版。

有关 Assuredworkloads v1 API 的其他所有信息,请参阅 官方文档站点

功能

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

该库的结构

API结构如下

  • 中心
  • 资源
    • 主要类型,可以将活动应用于其中
    • 一组属性和部分
    • 部分
      • 一组属性
      • 永远不会直接用于活动
  • 活动
    • 应用于资源的操作

所有结构都标记了适用特性,以进一步分类并简化浏览。

一般来说,您可以像这样调用活动

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

或具体...

let r = hub.organizations().locations_workloads_create(...).doit().await
let r = hub.organizations().locations_workloads_get(...).doit().await
let r = hub.organizations().locations_workloads_mutate_partner_permissions(...).doit().await
let r = hub.organizations().locations_workloads_patch(...).doit().await

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

使用方法

设置您的项目

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

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

完整示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_assuredworkloads1 as assuredworkloads1;
use assuredworkloads1::api::GoogleCloudAssuredworkloadsV1Workload;
use assuredworkloads1::{Result, Error};
use std::default::Default;
use assuredworkloads1::{Assuredworkloads, 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 = Assuredworkloads::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 = GoogleCloudAssuredworkloadsV1Workload::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.organizations().locations_workloads_create(req, "parent")
             .external_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()之前将delegate提供给方法构建器来改变调用doit()方法的方式。相应的方法将被调用以提供进度信息,并确定系统在失败时是否应该重试。

delegate trait默认实现,允许您以最小的努力进行定制。

服务器请求中的可选部分

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

构建器参数

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

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

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

Cargo 功能

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

许可证

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

依赖项

~12-23MB
~343K SLoC