#google-cloud #google #protocols #google-api

google-cloudtasks2_beta2

一个用于与 Cloud Tasks(协议 v2beta2)交互的完整库

21 个稳定版本 (4 个主要版本)

5.0.5+20240614 2024 年 6 月 27 日
5.0.4+20240223 2024 年 3 月 5 日
5.0.3+20230105 2023 年 8 月 23 日
5.0.2+20230105 2023 年 3 月 16 日
1.0.6+20170926 2017 年 9 月 27 日

#2377网页编程


google-cloudtasks2_beta2-… 中使用

MIT 许可证

565KB
6.5K SLoC

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

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

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

特性

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

本库的结构

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_beta2 = "*"
serde = "^1.0"
serde_json = "^1.0"

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_cloudtasks2_beta2 as cloudtasks2_beta2;
use cloudtasks2_beta2::api::Queue;
use cloudtasks2_beta2::{Result, Error};
use std::default::Default;
use cloudtasks2_beta2::{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 DelegateAuthenticator Delegate

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

上传和下载

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

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

自定义和回调

您可以通过向doit()方法调用之前提供代理方法构建器来自定义doit()方法的调用方式。相应的方法将被调用以提供进度信息,并确定系统在失败时应否重试。

代理特剧行默认实现,让您轻松定制。

服务器请求中的可选部分

本库提供的所有结构都设计为可通过json进行编码解码。使用可选参数来表示部分请求或响应是有效的。大多数可选参数被认为是部分,可以通过名称识别,这些部分将发送到服务器,以指示请求的设置部分或响应中期望的部分。

构建器参数

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

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

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

Cargo功能

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

许可证

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

依赖关系

~12–23MB
~345K SLoC