google-cloudfunctions1 库允许访问 Google Cloud Functions 服务的所有功能。

本文档是从 Cloud Functions crate 版本 5.0.5+20240620 生成的，其中 20240620 是由 mako 代码生成器 v5.0.5 构建的 cloudfunctions:v1 模式的确切修订版本。

关于 Cloud Functions v1 API 的其他信息可以在 官方文档网站 找到。

功能

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

• 操作
• 获取 和 列出
• 项目
• 位置功能调用、位置功能创建、位置功能删除、位置功能生成下载URL、位置功能生成上传URL、位置功能获取、位置功能获取IAM策略、位置功能列出、位置功能修补、位置功能设置IAM策略、位置功能测试IAM权限 和 位置列出

本库的结构

API 结构如下几个主要项目

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

所有 结构 都标记有相应的特性，以进一步分类并便于浏览。

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

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

或者具体来说 ...

let r = hub.operations().get(...).doit().await
let r = hub.operations().list(...).doit().await
let r = hub.projects().locations_functions_create(...).doit().await
let r = hub.projects().locations_functions_delete(...).doit().await
let r = hub.projects().locations_functions_patch(...).doit().await

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

用法

设置你的项目

要使用此库，你需要在你的 Cargo.toml 文件中添加以下行

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

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_cloudfunctions1 as cloudfunctions1;
use cloudfunctions1::{Result, Error};
use std::default::Default;
use cloudfunctions1::{CloudFunctions, 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 = CloudFunctions::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.operations().list()
             .page_token("et")
             .page_size(-33)
             .name("no")
             .filter("ipsum")
             .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 枚举返回值提供，或作为可能的中间结果传递给 Hub 代理 或 认证代理。

当代理处理错误或中间值时，它们可能会有机会指示系统重试。这使得系统可能对所有类型的错误具有弹性。

上传和下载

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

支持上传的方法可以使用最多两种不同的协议：简单 和 可恢复。每种方法的独特性通过定制的 doit(...) 方法表示，分别命名为 upload(...) 和 upload_resumable(...)。

自定义和回调

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

delegate trait具有默认实现，您可以用最小的努力来自定义它。

服务器请求中的可选部分

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

构建器参数

使用method builders，您可以通过反复调用其方法来准备一个动作调用。这些方法始终接受一个参数，以下陈述对此参数适用。

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

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

Cargo 功能

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

许可证

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