#data-transfer #google #protocols

google-bigquerydatatransfer1

一个完整的库,用于与 BigQuery 数据传输(协议 v1)交互

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

5.0.5+20240616 2024年6月27日
5.0.4+20240227 2024年3月5日
5.0.3+20230115 2023年8月23日
5.0.2+20230115 2023年3月16日
1.0.6+20170921 2017年9月27日

#9 in #data-transfer

Download history 5/week @ 2024-05-17 2/week @ 2024-05-24 1/week @ 2024-06-07 57/week @ 2024-06-21 39/week @ 2024-06-28 33/week @ 2024-07-05

1,288 每月下载量
google-bigquerydatatransf… 中使用

MIT 许可证

615KB
7.5K SLoC

google-bigquerydatatransfer1 库允许访问 Google BigQuery 数据传输服务(协议 v1)的所有功能。

本文档是根据 BigQuery 数据传输 crate 版本 5.0.5+20240616 生成的,其中 20240616 是由 mako 代码生成器 v5.0.5 构建的 bigquerydatatransfer:v1 架构的确切版本。

有关 BigQuery 数据传输 v1 API 的其他所有信息,请参阅 官方文档网站

功能

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

本库的结构

API 结构如下

  • 中心
    • 一个中心对象,用于维护状态并允许访问所有 活动
    • 创建 方法构建器,这些构建器反过来允许访问单个 调用构建器
  • 资源
    • 你可以将 活动 应用到这些主要类型
    • 一组属性和 部分
    • 部分
      • 一组属性
      • 活动 中从不直接使用
  • 活动
    • 应用于 资源 的操作

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

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

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

或具体地说 ...

let r = hub.projects().locations_transfer_configs_runs_delete(...).doit().await
let r = hub.projects().locations_transfer_configs_delete(...).doit().await
let r = hub.projects().locations_enroll_data_sources(...).doit().await
let r = hub.projects().locations_unenroll_data_sources(...).doit().await
let r = hub.projects().transfer_configs_runs_delete(...).doit().await
let r = hub.projects().transfer_configs_delete(...).doit().await
let r = hub.projects().enroll_data_sources(...).doit().await

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

用法

设置你的项目

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

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

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_bigquerydatatransfer1 as bigquerydatatransfer1;
use bigquerydatatransfer1::api::EnrollDataSourcesRequest;
use bigquerydatatransfer1::{Result, Error};
use std::default::Default;
use bigquerydatatransfer1::{BigQueryDataTransfer, 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 = BigQueryDataTransfer::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 = EnrollDataSourcesRequest::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_enroll_data_sources(req, "name")
             .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),
}

错误处理

系统产生的所有错误都通过作为doit()方法的返回值的枚举提供,或者作为可能的中途结果传递给Hub代理认证代理

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

上传和下载

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

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

定制和回调

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

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

服务器请求中的可选部分

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

构建器参数

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

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

Cargo 功能

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

许可

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

依赖关系

约 12-23MB
约 343K SLoC