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

google-cloudprivatecatalog1_beta1

用于与 Cloud Private Catalog (协议 v1beta1) 交互的完整库

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

5.0.5+20200405 2024年6月27日
5.0.4+20200405 2024年3月5日
5.0.3+20200405 2023年8月23日
5.0.2+20200405 2023年3月16日
1.0.10+20190622 2019年7月6日

#129#google-cloud


用于 google-cloudprivatecatalo…

MIT 许可证

235KB
3K SLoC

google-cloudprivatecatalog1_beta1 库允许访问 Google Cloud Private Catalog 服务(v1_beta1)的所有功能。

本文档是从 Cloud Private Catalog crate 版本 5.0.5+20200405 生成的,其中 20200405 是由 mako 代码生成器 v5.0.5 构建的 cloudprivatecatalog:v1beta1 架构的确切修订。

有关 Cloud Private Catalog v1_beta1 API 的其他信息,请参阅官方文档网站

功能

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

本库的结构

API 结构如下

  • 枢纽
  • 资源
    • 你可以将活动应用于的主要类型
    • 一组属性和部分
    • 部分
      • 一组属性
      • 活动中从未直接使用
  • 活动
    • 应用于资源的操作

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

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

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

或者具体...

let r = hub.folders().catalogs_search(...).doit().await
let r = hub.organizations().catalogs_search(...).doit().await
let r = hub.projects().catalogs_search(...).doit().await

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

使用方法

设置你的项目

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

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

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_cloudprivatecatalog1_beta1 as cloudprivatecatalog1_beta1;
use cloudprivatecatalog1_beta1::{Result, Error};
use std::default::Default;
use cloudprivatecatalog1_beta1::{CloudPrivateCatalog, 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 = CloudPrivateCatalog::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().catalogs_search("resource")
             .query("magna")
             .page_token("no")
             .page_size(-55)
             .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() 方法的方式,在执行最后的 doit() 调用之前。相应的函数将被调用以提供进度信息,并确定系统是否应该在失败时重试。

代理特质默认实现,让您可以轻松地进行自定义。

服务器请求中的可选部分

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

构建器参数

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

  • POD 以副本形式传递
  • 字符串作为 &str 传递
  • 请求值被移动

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

Cargo 功能

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

许可证

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

依赖关系

~12–23MB
~344K SLoC