39 个版本 (稳定)

5.0.5+20240617 2024年6月27日
5.0.4+20240303 2024年3月5日
5.0.3+20230115 2023年8月23日
5.0.2+20230115 2023年3月16日
0.1.9+20150909 2015年10月19日

#2781 in 网页编程


用于 google-cloudresourcemanag…

MIT 许可证

360KB
4K SLoC

google-cloudresourcemanager1_beta1 库允许访问 Google Cloud Resource Manager 服务的所有功能。

此文档是从 Cloud Resource Manager crate 版本 5.0.5+20240617 生成的,其中 20240617 是由 mako 代码生成器 v5.0.5 构建的 cloudresourcemanager:v1beta1 架构的确切修订版本。

关于 Cloud Resource Manager v1_beta1 API 的其他信息可以在 官方文档网站 找到。

功能

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

此库的结构

API 结构为以下主要项目

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

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

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

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

或具体...

let r = hub.projects().create(...).doit().await
let r = hub.projects().delete(...).doit().await
let r = hub.projects().get(...).doit().await
let r = hub.projects().get_ancestry(...).doit().await
let r = hub.projects().get_iam_policy(...).doit().await
let r = hub.projects().list(...).doit().await
let r = hub.projects().set_iam_policy(...).doit().await
let r = hub.projects().test_iam_permissions(...).doit().await
let r = hub.projects().undelete(...).doit().await
let r = hub.projects().update(...).doit().await

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

用法

设置您的项目

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

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

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_cloudresourcemanager1_beta1 as cloudresourcemanager1_beta1;
use cloudresourcemanager1_beta1::{Result, Error};
use std::default::Default;
use cloudresourcemanager1_beta1::{CloudResourceManager, 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 = CloudResourceManager::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.projects().list()
             .page_token("et")
             .page_size(-33)
             .filter("no")
             .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()调用之前向Method Builder提供一个delegate来更改调用doit()方法的方式。相应的方法将被调用来提供进度信息,并确定系统在失败时是否应该重试。

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

服务器请求中的可选部分

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

构建器参数

通过使用method builders,您可以通过重复调用其方法来准备一个操作调用。这些方法将始终接受一个参数,以下陈述对它来说是真实的。

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

Cargo 功能

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

许可证

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

依赖关系

~12–23MB
~343K SLoC