#google #protocols #google-api

google-datacatalog1_beta1

与数据目录(协议 v1beta1)交互的完整库

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

5.0.5+20240624 2024年6月27日
5.0.4+20240222 2024年3月5日
5.0.3+20230117 2023年8月23日
5.0.2+20230117 2023年3月16日
1.0.14+20200528 2020年7月10日

#2378 in 网页编程

每月 39 次下载
用于 google-datacatalog1_beta1…

MIT 许可证

1MB
11K SLoC

google-datacatalog1_beta1 库允许访问 Google 数据目录服务的所有功能。

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

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

功能

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

本库的结构

API 被结构化为以下主要项目

  • 中心
  • 资源
    • 可以应用于 活动 的主要类型
    • 一组属性和 部分
    • 部分
      • 一组属性
      • 从不直接用于 活动
  • 活动
    • 应用于 资源 的操作

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

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

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

或具体地说 ...

let r = hub.projects().locations_entry_groups_entries_get_iam_policy(...).doit().await
let r = hub.projects().locations_entry_groups_get_iam_policy(...).doit().await
let r = hub.projects().locations_entry_groups_set_iam_policy(...).doit().await
let r = hub.projects().locations_tag_templates_get_iam_policy(...).doit().await
let r = hub.projects().locations_tag_templates_set_iam_policy(...).doit().await
let r = hub.projects().locations_taxonomies_policy_tags_get_iam_policy(...).doit().await
let r = hub.projects().locations_taxonomies_policy_tags_set_iam_policy(...).doit().await
let r = hub.projects().locations_taxonomies_get_iam_policy(...).doit().await
let r = hub.projects().locations_taxonomies_set_iam_policy(...).doit().await

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

用法

设置您的项目

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

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

完整示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_datacatalog1_beta1 as datacatalog1_beta1;
use datacatalog1_beta1::api::GetIamPolicyRequest;
use datacatalog1_beta1::{Result, Error};
use std::default::Default;
use datacatalog1_beta1::{DataCatalog, 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 = DataCatalog::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 = GetIamPolicyRequest::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.projects().locations_entry_groups_entries_get_iam_policy(req, "resource")
             .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")

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

自定义和回调

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

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

服务器请求中的可选部分

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

构建器参数

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

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

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

Cargo 功能

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

许可证

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

依赖关系

~12–22MB
~342K SLoC