30个稳定版本 (5个主要版本)

5.0.5+20240624 2024年6月27日
5.0.4+20240226 2024年3月5日
5.0.3+20230114 2023年8月23日
5.0.2+20230114 2023年3月16日
0.1.15+20160802 2016年9月11日

#2786 in Web编程


用于 google-appengine1-cli

MIT 许可证

765KB
9K SLoC

“google-appengine1”库允许访问Google appengine服务的所有功能。

本文档是从appengine crate版本5.0.5+20240624生成的,其中20240624mako代码生成器v5.0.5构建的appengine:v1模式的确切修订。

有关appengine v1 API的所有其他信息,请参阅官方文档网站

功能

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

此库的结构

API结构如下主要项目

  • 中心
  • 资源
    • 您可以将其应用于 活动 的主要类型
    • 属性和 部分 的集合
    • 部分
      • 属性的集合
      • 不直接在 活动中 使用
  • 活动
    • 应用于 资源 的操作

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

一般来说,您可以通过以下方式调用 活动

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

或具体地说 ...

let r = hub.apps().domain_mappings_create(...).doit().await
let r = hub.apps().domain_mappings_delete(...).doit().await
let r = hub.apps().domain_mappings_patch(...).doit().await
let r = hub.apps().operations_get(...).doit().await
let r = hub.apps().services_versions_instances_debug(...).doit().await
let r = hub.apps().services_versions_instances_delete(...).doit().await
let r = hub.apps().services_versions_create(...).doit().await
let r = hub.apps().services_versions_delete(...).doit().await
let r = hub.apps().services_versions_patch(...).doit().await
let r = hub.apps().services_delete(...).doit().await
let r = hub.apps().services_patch(...).doit().await
let r = hub.apps().create(...).doit().await
let r = hub.apps().patch(...).doit().await
let r = hub.apps().repair(...).doit().await

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

用法

设置你的项目

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

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

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_appengine1 as appengine1;
use appengine1::api::DebugInstanceRequest;
use appengine1::{Result, Error};
use std::default::Default;
use appengine1::{Appengine, 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 = Appengine::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 = DebugInstanceRequest::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.apps().services_versions_instances_debug(req, "appsId", "servicesId", "versionsId", "instancesId")
             .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() 调用之前向 Method Builder 提供一个 delegate 来更改 doit() 方法的调用方式。相应的方方法将被调用来提供进度信息,以及确定系统是否应在失败时重试。

委托特质(delegate trait)默认实现,让您可以轻松自定义。

服务器请求中的可选部分

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

构建器参数

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

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

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

Cargo 功能

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

许可证

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

依赖关系

~12–23MB
~343K SLoC