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

5.0.5+20181005 2024 年 6 月 27 日
5.0.4+20181005 2024 年 3 月 5 日
5.0.3+20181005 2023 年 8 月 23 日
5.0.2+20181005 2023 年 3 月 16 日
0.1.11+20160121 2016 年 1 月 30 日

2562网页编程 中排名

每月 23 次下载
用于 google-appengine1_beta5-c…

MIT 许可证

435KB
5.5K SLoC

google-appengine1_beta5 库允许访问 Google appengine 服务所有功能。

本文档是根据 appengine crate 版本 5.0.5+20181005 生成的,其中 20181005 是由 mako 代码生成器 v5.0.5 构建的 appengine:v1beta5 架构的精确修订版。

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

功能

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

本库结构

API结构化为主以下项目

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

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

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

let r = hub.resource().activity(...).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

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

用法

设置项目

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

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

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_appengine1_beta5 as appengine1_beta5;
use appengine1_beta5::api::DebugInstanceRequest;
use appengine1_beta5::{Result, Error};
use std::default::Default;
use appengine1_beta5::{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")

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

自定义和回调

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

delegate trait 默认实现,允许您以最小的努力进行自定义。

服务器请求中的可选部分

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

构建器参数

使用 method builders,您可以通过重复调用其方法来准备动作调用。这些方法始终接受单个参数,以下陈述对此有效。

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

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

Cargo 特性

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

许可证

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

依赖项

~12–22MB
~344K SLoC