#资源管理器 #谷歌云 #谷歌API #谷歌 #谷歌服务 #协议 #Web API

google-cloudresourcemanager2

与云资源管理器(协议 v2)交互的完整库

17 个稳定版本 (4 个主要版本)

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 日
1.0.8+20181008 2018 年 10 月 14 日

#2788网页编程


用于 google-cloudresourcemanag…

MIT 许可证

295KB
3.5K SLoC

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

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

有关 Cloud Resource Manager v2 API 的其他所有信息,请参阅 官方文档网站

功能

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

本库的结构

API 被组织为以下主要项目

  • 枢纽
  • 资源
    • 可以应用活动主要类型
    • 属性和部分的集合
    • 部分
      • 属性的集合
      • 从不直接用于活动
  • 活动
    • 应用于资源的操作

所有结构都标记了适用的特性,以进一步分类它们并便于浏览。

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

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

或者具体...

let r = hub.folders().create(...).doit().await
let r = hub.folders().delete(...).doit().await
let r = hub.folders().get(...).doit().await
let r = hub.folders().get_iam_policy(...).doit().await
let r = hub.folders().list(...).doit().await
let r = hub.folders().move_(...).doit().await
let r = hub.folders().patch(...).doit().await
let r = hub.folders().search(...).doit().await
let r = hub.folders().set_iam_policy(...).doit().await
let r = hub.folders().test_iam_permissions(...).doit().await
let r = hub.folders().undelete(...).doit().await

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

用法

设置你的项目

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

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

完整示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_cloudresourcemanager2 as cloudresourcemanager2;
use cloudresourcemanager2::{Result, Error};
use std::default::Default;
use cloudresourcemanager2::{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.folders().list()
             .show_deleted(true)
             .parent("voluptua.")
             .page_token("At")
             .page_size(-8)
             .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 DelegateAuthenticator Delegate

当代理处理错误或中间值时,它们可能会有机会指示系统重试。这使得系统可能对所有类型的错误都有抵抗力。

上传和下载

如果方法支持下载,则响应体,作为Result的一部分,应由您读取以获取媒体。如果此类方法还支持Response Result,则默认返回该结果。您可以将它视为实际媒体的元数据。要触发媒体下载,您必须通过此调用设置构建器:.param("alt", "media")

支持上传的方法可以使用最多两种协议:简单可续传。每种协议的独特性通过定制的doit(...)方法体现,这些方法分别命名为upload(...)upload_resumable(...)

自定义和回调

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

默认实现了代理特质,允许您以最小的努力进行自定义。

服务器请求中的可选部分

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

构建器参数

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

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

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

Cargo功能

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

许可证

cloudresourcemanager2库由Sebastian Thiel生成,并置于MIT许可证下。您可以在仓库的许可证文件中阅读全文。

依赖关系

~12–23MB
~346K SLoC