#google-cloud #google #protocols #google-api

google-cloudresourcemanager1

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

30 个稳定版本 (5 个主要版本)

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.12+20160225 2016 年 2 月 28 日

2919网页开发

29 每月下载量
google-cloudresourcemanag… 中使用

MIT 许可证

710KB
8K SLoC

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

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

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

功能

从中央 枢纽 简单地处理以下 资源...

此库的结构

API 被结构化为以下主要项

  • 中心
    • 一个中心对象,用于维护状态并允许访问所有 活动
    • 创建 方法构建器,这些构建器进一步允许访问单个 调用构建器
  • 资源
    • 可以应用 活动 的主要类型
    • 一组属性和 部分
    • 部分
      • 一组属性
      • 活动 中 never 直接使用
  • 活动
    • 应用到 资源 的操作

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

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

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

或者更具体地说...

let r = hub.projects().clear_org_policy(...).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_effective_org_policy(...).doit().await
let r = hub.projects().get_iam_policy(...).doit().await
let r = hub.projects().get_org_policy(...).doit().await
let r = hub.projects().list(...).doit().await
let r = hub.projects().list_available_org_policy_constraints(...).doit().await
let r = hub.projects().list_org_policies(...).doit().await
let r = hub.projects().set_iam_policy(...).doit().await
let r = hub.projects().set_org_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)调用创建了构建器。第二个调用处理活动(Activities),支持多种配置即将进行的操作(此处未展示)的方法。它的设计使得所有必需的参数必须立即指定(即 (...)),而所有可选的参数可以根据需要逐步构建doit()方法执行与服务器的实际通信并返回相应的结果。

用法

设置你的项目

要使用这个库,你需要在你的Cargo.toml文件中添加以下几行

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

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_cloudresourcemanager1 as cloudresourcemanager1;
use cloudresourcemanager1::{Result, Error};
use std::default::Default;
use cloudresourcemanager1::{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枚举返回值,或者作为中间结果传递给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规范将是无效的。

许可

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

依赖

~12–23MB
~342K SLoC