18 个稳定版本 (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.8+20180913 | 2018年10月14日 |
在 网页开发 中排名 #2423
每月下载量 186 次
用于 google-cloudtasks2_beta3-…
480KB
5.5K SLoC
google-cloudtasks2_beta3
库允许访问 Google Cloud Tasks 服务的所有功能。
本文档是从 Cloud Tasks crate 版本 5.0.5+20240614 生成的,其中 20240614 是由 mako 代码生成器 v5.0.5 构建的 cloudtasks:v2beta3 架构的确切修订版。
关于 Cloud Tasks v2_beta3 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_beta3 = "*"
serde = "^1.0"
serde_json = "^1.0"
一个完整的示例
extern crate hyper;
extern crate hyper_rustls;
extern crate google_cloudtasks2_beta3 as cloudtasks2_beta3;
use cloudtasks2_beta3::api::Queue;
use cloudtasks2_beta3::{Result, Error};
use std::default::Default;
use cloudtasks2_beta3::{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")
。
支持上传的方法可以使用多达2种不同的协议:简单 和 可恢复。每种方法的独特性由定制的 doit(...)
方法表示,分别命名为 upload(...)
和 upload_resumable(...)
。
定制和回调
您可以通过向 Method Builder 提供一个 delegate 来修改 doit()
方法的调用方式,在执行最终的 doit()
调用之前。相应的方法将被调用以提供进度信息,以及确定系统是否应在失败时重试。
默认实现了 委托特质,允许您以最小的努力进行自定义。
服务器请求中的可选部分
本库提供的所有结构都是为了能够通过 json 进行 编码 和 解码 而设计的。使用可选部分来表示部分请求或响应是有效的。大多数可选部分都是 部分,这些部分可以通过名称识别,将被发送到服务器以指示请求中设置的部件或响应中期望的部件。
构建器参数
通过使用 方法构建器,您可以通过重复调用它的方法来准备一个动作调用。这些方法始终接受一个参数,以下语句对它适用。
参数将始终被复制或克隆到构建器中,以确保它们与其原始的生命周期独立。
Cargo 功能
utoipa
- 添加对 utoipa 的支持,并从所有类型中派生utoipa::ToSchema
。您必须在#[openapi(schemas(...))]
中导入和注册所需类型,否则生成的openapi
规范将无效。
许可
cloudtasks2_beta3 库由 Sebastian Thiel 生成,并置于 MIT 许可下。您可以在仓库的 许可文件 中阅读全文。
依赖项
约 12–23MB
约 343K SLoC