#connector #google #protocols #google-api #web #web-api

google-connectors1

一个完整的库,用于与 Connectors(协议 v1)交互

8 个版本 (稳定)

5.0.5+20240619 2024 年 6 月 27 日
5.0.4+20240221 2024 年 3 月 5 日
5.0.3+20230103 2023 年 8 月 23 日
5.0.2+20230103 2023 年 3 月 16 日
3.0.0+20220214 2022 年 3 月 8 日

#2914 in 网页编程

Download history 3/week @ 2024-05-18 1/week @ 2024-05-25 80/week @ 2024-06-22 22/week @ 2024-06-29 17/week @ 2024-07-06

每月 470 次下载
用于 google-connectors1-cli

MIT 许可证

1MB
15K SLoC

google-connectors1 库允许访问 Google Connectors 服务的所有功能。

此文档是从版本 5.0.5+20240619Connectors crate 生成的,其中 20240619 是由 mako 代码生成器 v5.0.5 构建的 connectors:v1 模式的确切修订。

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

功能

轻松从中心 枢纽 ...

本库的结构

API 结构如下

  • 枢纽
  • 资源
    • 可以应用于 活动 的主要类型
    • 属性和 部分 的集合
    • 部分
      • 属性的集合
      • 活动 中 never 直接使用
  • 活动
    • 应用于 资源 的操作

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

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

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

或具体 ...

let r = hub.projects().locations_connections_connection_schema_metadata_get_action(...).doit().await
let r = hub.projects().locations_connections_connection_schema_metadata_get_entity_type(...).doit().await
let r = hub.projects().locations_connections_connection_schema_metadata_refresh(...).doit().await
let r = hub.projects().locations_connections_event_subscriptions_create(...).doit().await
let r = hub.projects().locations_connections_event_subscriptions_delete(...).doit().await
let r = hub.projects().locations_connections_event_subscriptions_patch(...).doit().await
let r = hub.projects().locations_connections_event_subscriptions_retry(...).doit().await
let r = hub.projects().locations_connections_create(...).doit().await
let r = hub.projects().locations_connections_delete(...).doit().await
let r = hub.projects().locations_connections_patch(...).doit().await
let r = hub.projects().locations_connections_repair_eventing(...).doit().await
let r = hub.projects().locations_custom_connectors_custom_connector_versions_delete(...).doit().await
let r = hub.projects().locations_custom_connectors_custom_connector_versions_deprecate(...).doit().await
let r = hub.projects().locations_endpoint_attachments_create(...).doit().await
let r = hub.projects().locations_endpoint_attachments_delete(...).doit().await
let r = hub.projects().locations_endpoint_attachments_patch(...).doit().await
let r = hub.projects().locations_global_custom_connectors_custom_connector_versions_create(...).doit().await
let r = hub.projects().locations_global_custom_connectors_create(...).doit().await
let r = hub.projects().locations_global_custom_connectors_delete(...).doit().await
let r = hub.projects().locations_global_custom_connectors_patch(...).doit().await
let r = hub.projects().locations_global_managed_zones_create(...).doit().await
let r = hub.projects().locations_global_managed_zones_delete(...).doit().await
let r = hub.projects().locations_global_managed_zones_patch(...).doit().await
let r = hub.projects().locations_global_update_settings(...).doit().await
let r = hub.projects().locations_operations_get(...).doit().await
let r = hub.projects().locations_update_regional_settings(...).doit().await

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

使用方法

设置你的项目

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

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

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_connectors1 as connectors1;
use connectors1::api::EventSubscription;
use connectors1::{Result, Error};
use std::default::Default;
use connectors1::{Connectors, 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 = Connectors::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 = EventSubscription::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_connections_event_subscriptions_create(req, "parent")
             .event_subscription_id("magna")
             .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 DelegateAuthenticator Delegate

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

上传和下载

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

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

自定义和回调

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

委托特质(delegate trait)默认实现,让您可以以最少的努力进行自定义。

服务器请求中的可选部分

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

构建器参数

使用 方法构建器,您可以通过重复调用其方法来准备动作调用。这些方法始终接受单个参数,以下陈述是正确的。

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

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

Cargo 功能

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

许可证

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

依赖关系

~12–22MB
~342K SLoC