#dataflow #google #google-api #protocols #api #web-api #web

nightly google-dataflow1_b4

一个与数据流(协议 v1b4)交互的完整库

3 个版本

使用旧的 Rust 2015

0.1.5+20150401 2015 年 4 月 8 日
0.1.4+20150401 2015 年 4 月 7 日
0.1.3+20150401 2015 年 4 月 7 日

35#dataflow

MIT 许可证

40KB
424

google-dataflow1_b4 库允许访问 Google 数据流服务的所有功能。

此文档是从 dataflow crate 版本 0.1.5+20150401 生成的,其中 20150401 是由 mako 代码生成器 v0.1.5 构建的 dataflow:v1b4 模式的确切版本。

功能

似乎在这里您无法进行任何操作 ...

此库的结构

API 结构如下主要项目

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

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

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

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

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

用法

设置您的项目

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

[dependencies]
google-dataflow1_b4 = "*"

完整示例

extern crate hyper;
extern crate yup_oauth2 as oauth2;
extern crate google_dataflow1_b4 as dataflow1_b4;

use std::default::Default;
use oauth2::{Authenticator, DefaultAuthenticatorDelegate, ApplicationSecret, MemoryStorage};
use dataflow1_b4::Dataflow;

// Get an ApplicationSecret instance by some means. It contains the `client_id` and 
// `client_secret`, among other things.
let secret: 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 = Authenticator::new(&secret, DefaultAuthenticatorDelegate,
                              hyper::Client::new(),
                              <MemoryStorage as Default>::default(), None);
let mut hub = Dataflow::new(hyper::Client::new(), auth);

错误处理

系统产生的所有错误要么作为 Result 枚举作为 doit() 方法的返回值提供,要么作为可能的中间结果传递给 Hub DelegateAuthenticator Delegate

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

上传和下载

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

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

自定义和回调

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

默认实现了 delegate trait,这使得您可以以最小的努力对其进行自定义。

服务器请求的可选部分

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

构建器参数

使用 method builders,您可以通过重复调用其方法来准备一个操作调用。这些方法将始终接受单个参数,以下语句适用于此参数。

  • PODs 通过拷贝传递
  • 字符串以 &str 的形式传递
  • 请求值 是借用

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

许可证

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

依赖项

~17–30MB
~554K SLoC