#数据存储 #Google API #Google #协议 #API #Web API

google-datastore1_beta2

用于与数据存储(协议 v1beta2)交互的完整库

15 个版本

使用旧的 Rust 2015

0.1.13+20160314 2016 年 4 月 10 日
0.1.12+20151008 2016 年 2 月 28 日
0.1.11+20151008 2016 年 1 月 30 日
0.1.10+20151008 2015 年 12 月 6 日
0.1.2+20140916 2015 年 3 月 25 日

#5 in #数据存储

MIT 许可证

49KB
523

“google-datastore1_beta2”库允许访问 Google 数据存储服务(协议 v1beta2)的所有功能。

此文档是从 datastore 包版本 0.1.13+20160314 生成的,其中 20160314 是由 mako 代码生成器 v0.1.13 构建的 datastore:v1beta2 模式的确切修订。

有关数据存储(v1_beta2)API 的其他信息,请参阅官方文档网站

功能

从中央 枢纽 简单易用地处理以下 资源 ...

此库的结构

API 被组织为以下主要项目

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

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

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

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

或具体地说 ...

let r = hub.datasets().lookup(...).doit()

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

使用方法

设置你的项目

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

[dependencies]
google-datastore1_beta2 = "*"

完整示例

extern crate hyper;
extern crate yup_oauth2 as oauth2;
extern crate google_datastore1_beta2 as datastore1_beta2;
use datastore1_beta2::LookupRequest;
use datastore1_beta2::{Result, Error};
use std::default::Default;
use oauth2::{Authenticator, DefaultAuthenticatorDelegate, ApplicationSecret, MemoryStorage};
use datastore1_beta2::Datastore;

// 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 = Datastore::new(hyper::Client::new(), 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 = LookupRequest::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.datasets().lookup(req, "datasetId")
             .doit();

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::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 Delegate,或者 Authenticator Delegate

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

上传和下载

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

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

定制和回调

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

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

服务器请求中的可选部分

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

构建器参数

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

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

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

许可证

datastore1_beta2 库由 Sebastian Thiel 创建,并置于 MIT 许可证下。您可以在存储库的 许可证文件 中阅读全文。

依赖项

~15–27MB
~413K SLoC