#google-cloud #google #protocols

google-cloudresourcemanager3

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

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

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日
2.0.4+20210328 2021年4月14日

2760网页编程 中排名

Download history 8/week @ 2024-05-19 1/week @ 2024-05-26 3/week @ 2024-06-09 1/week @ 2024-06-16 83/week @ 2024-06-23 26/week @ 2024-06-30 1/week @ 2024-07-07

每月下载 705
google-cloudresourcemanag… 中使用

MIT 许可证

1MB
11K SLoC

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

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

有关 Cloud Resource Manager v3 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().move_(...).doit().await
let r = hub.folders().patch(...).doit().await
let r = hub.folders().undelete(...).doit().await
let r = hub.operations().get(...).doit().await
let r = hub.projects().create(...).doit().await
let r = hub.projects().delete(...).doit().await
let r = hub.projects().move_(...).doit().await
let r = hub.projects().patch(...).doit().await
let r = hub.projects().undelete(...).doit().await
let r = hub.tag_bindings().create(...).doit().await
let r = hub.tag_bindings().delete(...).doit().await
let r = hub.tag_keys().create(...).doit().await
let r = hub.tag_keys().delete(...).doit().await
let r = hub.tag_keys().patch(...).doit().await
let r = hub.tag_values().tag_holds_create(...).doit().await
let r = hub.tag_values().tag_holds_delete(...).doit().await
let r = hub.tag_values().create(...).doit().await
let r = hub.tag_values().delete(...).doit().await
let r = hub.tag_values().patch(...).doit().await

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

用法

设置项目

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

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

完整示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_cloudresourcemanager3 as cloudresourcemanager3;
use cloudresourcemanager3::api::TagKey;
use cloudresourcemanager3::{Result, Error};
use std::default::Default;
use cloudresourcemanager3::{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);
// 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 = TagKey::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.tag_keys().patch(req, "name")
             .validate_only(true)
             .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 DelegateAuthenticator Delegate

当代表处理错误或中间值时,他们有机会指示系统重试。这使得系统可能对所有类型的错误都具有弹性。

上传和下载

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

支持上传的方法可以使用最多2种不同的协议:简单可恢复。每种协议的独特性由定制的doit(...)方法表示,分别命名为upload(...)upload_resumable(...)

自定义和回调

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

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

服务器请求中的可选部分

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

构建器参数

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

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

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

Cargo功能

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

许可证

cloudresourcemanager3 库由 Sebastian Thiel 构建,并置于 MIT 许可证之下。您可以在仓库的 许可证文件 中阅读全文。

依赖项

~12–23MB
~346K SLoC