#google #protocols #google-api

google-datacatalog1

与数据目录(协议版本v1)交互的完整库

8 个版本 (稳定)

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日
3.0.0+20220224 2022年3月8日

#2538 in Web编程


用于 google-datacatalog1-cli

MIT 许可证

1MB
14K SLoC

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

本文档是根据 数据目录 crate 版本 5.0.5+20240624 生成的,其中 20240624 是由 mako 代码生成器 v5.0.5 构建的 datacatalog:v1 模式的确切版本。

有关数据目录 v1 API 的其他信息,请参阅 官方文档网站

功能

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

本库结构

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

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

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

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

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

或具体地 ...

let r = hub.projects().locations_entry_groups_entries_tags_delete(...).doit().await
let r = hub.projects().locations_entry_groups_entries_delete(...).doit().await
let r = hub.projects().locations_entry_groups_tags_delete(...).doit().await
let r = hub.projects().locations_entry_groups_delete(...).doit().await
let r = hub.projects().locations_operations_cancel(...).doit().await
let r = hub.projects().locations_operations_delete(...).doit().await
let r = hub.projects().locations_tag_templates_fields_delete(...).doit().await
let r = hub.projects().locations_tag_templates_delete(...).doit().await
let r = hub.projects().locations_taxonomies_policy_tags_delete(...).doit().await
let r = hub.projects().locations_taxonomies_delete(...).doit().await

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

用法

设置项目

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

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

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_datacatalog1 as datacatalog1;
use datacatalog1::{Result, Error};
use std::default::Default;
use datacatalog1::{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);
// 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_delete("name")
             .force(true)
             .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()方法的方式。相关方法将被调用以提供进度信息,并确定系统在失败时是否应该重试。

delegate trait具有默认实现,允许您以最小的努力进行自定义。

服务器请求中的可选部分

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

构建器参数

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

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

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

Cargo 功能

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

许可证

datacatalog1 库由 Sebastian Thiel 创建,并置于 MIT 许可证之下。您可以在存储库的 许可证文件 中阅读完整文本。

依赖关系

~12–23MB
~342K SLoC