#google-api #google #protocols #api #web-api #web #area120tables

google-area120tables1_alpha1

与 Area120 Tables(协议 v1alpha1)交互的完整库

11 个稳定版本 (3 个主要版本)

5.0.5+20240625 2024年6月27日
5.0.4+20240304 2024年3月5日
5.0.3+20230123 2023年8月23日
5.0.2+20230123 2023年3月16日
2.0.4+20210330 2021年4月14日

#256#web-api


google-area120tables1_alp… 中使用

MIT 许可证

270KB
3.5K SLoC

google-area120tables1_alpha1 库允许访问 Google Area120 Tables 服务(v1alpha1)的所有功能。

本文档由 Area120 Tables crate 版本 5.0.5+20240625 生成,其中 20240625 是由 mako 代码生成器 v5.0.5 构建的 area120tables:v1alpha1 模式的确切修订版。

有关 Area120 Tables v1_alpha1 API 的其他信息,请参阅 官方文档站点

功能

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

库的结构

API 结构如下

  • 枢纽
  • 资源
    • 可以应用 活动 的主要类型
    • 一系列属性和 部分
    • 部分
      • 一系列属性
      • 活动 中永远不会直接使用
  • 活动
    • 应用于 资源 的操作

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

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

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

或者具体来说 ...

let r = hub.tables().rows_batch_create(...).doit().await
let r = hub.tables().rows_batch_delete(...).doit().await
let r = hub.tables().rows_batch_update(...).doit().await
let r = hub.tables().rows_create(...).doit().await
let r = hub.tables().rows_delete(...).doit().await
let r = hub.tables().rows_get(...).doit().await
let r = hub.tables().rows_list(...).doit().await
let r = hub.tables().rows_patch(...).doit().await
let r = hub.tables().get(...).doit().await
let r = hub.tables().list(...).doit().await

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

用法

设置您的项目

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

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

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_area120tables1_alpha1 as area120tables1_alpha1;
use area120tables1_alpha1::{Result, Error};
use std::default::Default;
use area120tables1_alpha1::{Area120Tables, 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 = Area120Tables::new(hyper::Client::builder().build(hyper_rustls::HttpsConnectorBuilder::new().with_native_roots().unwrap().https_or_http().enable_http1().build()), auth);
// 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.tables().rows_list("parent")
             .view("magna")
             .page_token("no")
             .page_size(-55)
             .order_by("voluptua.")
             .filter("At")
             .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(...)

定制和回调

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

代理特质默认实现,允许您以最小的努力进行定制。

服务器请求中的可选部分

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

构建器参数

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

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

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

Cargo 功能

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

许可证

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

依赖关系

~12–23MB
~342K SLoC