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

本文档是根据 Workflows crate 版本 5.0.5+20240612 生成的，其中 20240612 是由 mako 代码生成器 v5.0.5 构建的 workflows:v1 架构的确切修订。

有关 Workflows v1 API 的其他信息，请参阅 官方文档网站。

功能

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

• 项目
• 获取位置，列出位置，删除位置操作，获取位置操作，列出位置操作，创建位置工作流，删除位置工作流，获取位置工作流，列出位置工作流，列出位置工作流修订版 和 更新位置工作流

本库的结构

API 被结构化为以下主要项目

• 中心
  • 一个中心对象，用于维护状态并允许访问所有 活动
  • 创建 方法构建器，后者反过来允许访问单个 调用构建器
• 资源
  • 可以应用 活动 的基本类型
  • 属性和 部分 的集合
  • 部分
    • 属性的集合
    • 在 活动 中从不直接使用
• 活动
  • 应用于 资源 的操作

所有 结构 都带有适用的特征，以进一步分类它们并便于浏览。

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

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

或者具体...

let r = hub.projects().locations_operations_get(...).doit().await
let r = hub.projects().locations_workflows_create(...).doit().await
let r = hub.projects().locations_workflows_delete(...).doit().await
let r = hub.projects().locations_workflows_patch(...).doit().await

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

使用方法

设置你的项目

要使用这个库，你需要在你的 Cargo.toml 文件中放入以下行

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

一个完整的例子

extern crate hyper;
extern crate hyper_rustls;
extern crate google_workflows1 as workflows1;
use workflows1::api::Workflow;
use workflows1::{Result, Error};
use std::default::Default;
use workflows1::{Workflows, 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 = Workflows::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 = Workflow::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().locations_workflows_create(req, "parent")
             .workflow_id("magna")
             .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 Delegate 或 Authenticator Delegate。

当代理处理错误或中间值时，他们有机会指示系统重试。这使得系统对各种错误具有潜在的抗性。

上传和下载

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

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

自定义和回调

您可以通过在最终调用 doit() 之前提供给 Delegate 的 方法构建器 来修改调用 doit() 方式。将调用相应的方法以提供进度信息，并确定系统在失败时是否应该重试。

默认实现了 delegate trait，这使得您几乎不需要努力就可以自定义它。

服务器请求中的可选部分

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

构建器参数

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

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

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

Cargo 功能

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

许可证

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