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

本文档是从Cloud Tasks crate版本 5.0.5+20240614 生成的，其中 20240614 是由 mako 代码生成器 v5.0.5 构建的 cloudtasks:v2 架构的确切修订版本。

有关Cloud Tasks v2 API的所有其他信息，请参阅官方文档网站。

功能

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

• 项目
• 获取位置，获取位置CMK配置，列出位置，创建位置队列，删除位置队列，获取位置队列，获取位置队列IAM策略，列出位置队列，更新位置队列，暂停位置队列，清空位置队列，恢复位置队列，设置位置队列IAM策略，位置队列任务缓冲，创建位置队列任务，删除位置队列任务，获取位置队列任务，列出位置队列任务，运行位置队列任务，测试位置队列IAM权限以及更新位置CMK配置

库结构

API结构分为以下主要项目

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

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

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

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

或者具体...

let r = hub.projects().locations_queues_create(...).doit().await
let r = hub.projects().locations_queues_get(...).doit().await
let r = hub.projects().locations_queues_patch(...).doit().await
let r = hub.projects().locations_queues_pause(...).doit().await
let r = hub.projects().locations_queues_purge(...).doit().await
let r = hub.projects().locations_queues_resume(...).doit().await

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

使用方法

设置您的项目

要使用这个库，您需要将以下几行代码放入您的 Cargo.toml 文件中

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

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_cloudtasks2 as cloudtasks2;
use cloudtasks2::api::Queue;
use cloudtasks2::{Result, Error};
use std::default::Default;
use cloudtasks2::{CloudTasks, 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 = CloudTasks::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 = Queue::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_queues_patch(req, "name")
             .update_mask(FieldMask::new::<&str>(&[]))
             .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")。

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

定制和回调

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

delegate trait 默认实现，让您可以轻松地进行定制。

服务器请求中的可选部分

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

构建器参数

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

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

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

Cargo 功能

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

许可证

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