#data-fusion #google #protocols #google-api #web #web-api

google-datafusion1_beta1

一个完整的库,用于与数据融合(协议 v1beta1)交互

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

5.0.5+20240618 2024年6月27日
5.0.4+20240111 2024年3月5日
5.0.3+20221213 2023年8月23日
5.0.2+20221213 2023年3月16日
1.0.10+20190617 2019年7月6日

网页编程 中排名第 2564


用于 google-datafusion1_beta1-…

MIT 许可证

500KB
6K SLoC

google-datafusion1_beta1 库允许访问 Google Data Fusion 服务所有功能。

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

有关数据融合 v1_beta1 API 的其他所有信息,请参阅 官方文档网站

功能

从中心 中心 简单易用地处理以下 资源 ...

本库结构

API结构如下主要项

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

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

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

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

或具体地...

let r = hub.projects().locations_instances_create(...).doit().await
let r = hub.projects().locations_instances_delete(...).doit().await
let r = hub.projects().locations_instances_patch(...).doit().await
let r = hub.projects().locations_instances_restart(...).doit().await
let r = hub.projects().locations_instances_upgrade(...).doit().await
let r = hub.projects().locations_operations_get(...).doit().await

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

用法

设置您的项目

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

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

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_datafusion1_beta1 as datafusion1_beta1;
use datafusion1_beta1::api::Instance;
use datafusion1_beta1::{Result, Error};
use std::default::Default;
use datafusion1_beta1::{DataFusion, 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 = DataFusion::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 = Instance::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_instances_create(req, "parent")
             .instance_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 枚举提供,作为 doit() 方法的返回值,或者作为中间结果传递给 Hub DelegateAuthenticator Delegate

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

上传和下载

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

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

自定义和回调

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

“委托trait”默认实现,让您能够以最小的努力对其进行自定义。

服务器请求中的可选部分

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

构建器参数

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

  • 通过复制传递POD对象
  • 字符串以&str的形式传递
  • 请求值是移动的

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

Cargo功能

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

许可证

datafusion1_beta1库由Sebastian Thiel生成,并根据MIT许可证发布。您可以在存储库的许可证文件中阅读全文。

依赖关系

~12–22MB
~342K SLoC