18 个稳定版本 (4 个主要版本)
5.0.5+20240620 | 2024 年 6 月 27 日 |
---|---|
5.0.4+20240202 | 2024 年 3 月 5 日 |
5.0.3+20230120 | 2023 年 8 月 23 日 |
5.0.2+20230120 | 2023 年 3 月 16 日 |
1.0.8+20181008 | 2018 年 10 月 14 日 |
#2539 in 网页编程
390KB
4.5K SLoC
该 google-jobs3
库允许访问 Google Cloud Talent Solution 服务的所有功能。
此文档是从 Cloud Talent Solution crate 版本 5.0.5+20240620 生成的,其中 20240620 是由 mako 代码生成器 v5.0.5 构建的 jobs:v3 架构的确切修订版。
关于 Cloud Talent Solution v3 API 的其他信息可以在 官方文档网站 找到。
功能
从中心 枢纽 轻松处理以下 资源 ...
本库的结构
API结构如下几个主要部分
所有结构都标记了适用的特性,以进一步分类它们并简化浏览。
一般来说,你可以这样调用活动
let r = hub.resource().activity(...).doit().await
或具体来说 ...
let r = hub.projects().jobs_create(...).doit().await
let r = hub.projects().jobs_get(...).doit().await
let r = hub.projects().jobs_patch(...).doit().await
resource()
和 activity(...)
调用创建构建器。第二个处理 Activities
的构建器支持各种配置即将进行操作的方法(此处未显示)。它被设计成必须立即指定所有必需的参数(即 (...)
),而所有可选的都可以按需构建。doit()
方法执行与服务器的实际通信并返回相应的结果。
用法
设置你的项目
要使用此库,你需要在你的 Cargo.toml
文件中放入以下行
[dependencies]
google-jobs3 = "*"
serde = "^1.0"
serde_json = "^1.0"
一个完整的示例
extern crate hyper;
extern crate hyper_rustls;
extern crate google_jobs3 as jobs3;
use jobs3::api::CreateJobRequest;
use jobs3::{Result, Error};
use std::default::Default;
use jobs3::{CloudTalentSolution, 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 = CloudTalentSolution::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 = CreateJobRequest::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().jobs_create(req, "parent")
.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()
之前向Method Builder提供delegate来更改调用doit()
方法的方式。相应的方法将被调用以提供进度信息,以及确定系统是否应在失败时重试。
delegate trait具有默认实现,允许您以最小的努力进行定制。
服务器请求中的可选部分
此库提供的所有结构都旨在通过json进行编码和解码。使用可选值来表示部分请求和响应是有效的。大多数可选值都被视为Parts,这些部分可以通过名称识别,并将发送到服务器以指示请求的设置部分或响应中期望的部分。
构建器参数
使用方法构建器,您可以通过重复调用它的方法来准备一个动作调用。这些方法始终接受一个参数,以下陈述是正确的。
- PODs通过复制传递
- 字符串作为
&str
传递 - request values被移动
参数将始终被复制或克隆到构建器中,以确保它们与其原始的生命周期独立。
Cargo功能
utoipa
- 添加对 utoipa 的支持,并在所有类型上派生utoipa::ToSchema
。您需要在#[openapi(schemas(...))]
中导入和注册所需类型,否则生成的openapi
规范将无效。
许可证
jobs3 库由 Sebastian Thiel 创建,并置于 MIT 许可证下。您可以在存储库的 许可证文件 中阅读全文。
依赖项
~12–23MB
~345K SLoC