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

google-datastore1_beta3

与数据存储(协议 v1beta3)交互的完整库

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

5.0.5+20240617 2024年6月27日
5.0.4+20240226 2024年3月5日
5.0.3+20230118 2023年8月23日
5.0.2+20230118 2023年3月16日
1.0.7+20171205 2018年2月1日

#2485 in Web编程

Download history 5/week @ 2024-05-19 2/week @ 2024-06-02 1/week @ 2024-06-09 80/week @ 2024-06-23 105/week @ 2024-06-30

1,190 每月下载量
google-datastore1_beta3-c… 中使用

MIT 许可证

260KB
3.5K SLoC

《google-datastore1_beta3》库允许访问Google数据存储服务(v1beta3协议)的所有功能。

本文档是从版本5.0.5+20240617datastorecrate生成的,其中20240617mako代码生成器v5.0.5构建的datastore:v1beta3架构的确切修订版。

关于datastore v1_beta3 API的其它信息可以在官方文档网站找到。

功能

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

本库结构

API结构如下

  • 中心
  • 资源
    • 主要类型,您可以将活动应用于它们
    • 一组属性和组件
    • 组件
      • 一组属性
      • 从未直接用于活动
  • 活动
    • 应用于资源的操作

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

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

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

或者具体...

let r = hub.projects().run_query(...).doit().await

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

用法

设置你的项目

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

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

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_datastore1_beta3 as datastore1_beta3;
use datastore1_beta3::api::RunQueryRequest;
use datastore1_beta3::{Result, Error};
use std::default::Default;
use datastore1_beta3::{Datastore, 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 = Datastore::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 = RunQueryRequest::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().run_query(req, "projectId")
             .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")

支持上传的方法可以使用最多2种不同的协议:简单可恢复。每个的区别体现在定制的doit(...)方法上,分别命名为upload(...)upload_resumable(...)

自定义和回调

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

委托特质 默认实现,允许您以最小的努力进行自定义。

服务器请求中的可选部分

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

构建器参数

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

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

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

Cargo 功能

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

许可证

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

依赖关系

~12–23MB
~343K SLoC