#google-cloud #jobs #google #protocols #web #google-api #web-api

google-jobs4

一个用于与 Cloud Talent Solution (协议 v4) 交互的完整库

11 个稳定版本 (3 个主要版本)

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 日
2.0.4+20210309 2021 年 4 月 15 日

#2376 in 网页编程


用于 google-jobs4-cli

MIT 许可证

500KB
6K SLoC

google-jobs4 库允许访问 Google Cloud Talent Solution 服务的所有功能。

此文档是从 Cloud Talent Solution 包版本 5.0.5+20240620 生成的,其中 20240620 是由 mako 代码生成器 v5.0.5 构建的 jobs:v4 架构的确切修订版。

有关 Cloud Talent Solution v4 API 的其他所有信息,请参阅官方文档网站

功能

从中心 枢纽 简单地处理以下 资源 ...

该库的结构

API结构如下主要项

  • 中心
  • 资源
    • 可以应用活动的主要类型
    • 一系列属性和部分
    • 部分
      • 一系列属性
      • 活动中从不直接使用
  • 活动
    • 应用到资源的操作

所有结构都带有适用的特性,以进一步分类它们并简化浏览。

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

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

或者具体...

let r = hub.projects().operations_get(...).doit().await
let r = hub.projects().tenants_jobs_batch_create(...).doit().await
let r = hub.projects().tenants_jobs_batch_delete(...).doit().await
let r = hub.projects().tenants_jobs_batch_update(...).doit().await

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

用法

设置您的项目

要使用此库,您需要将以下行放入您的 Cargo.toml 文件中

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

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_jobs4 as jobs4;
use jobs4::api::BatchCreateJobsRequest;
use jobs4::{Result, Error};
use std::default::Default;
use jobs4::{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 = BatchCreateJobsRequest::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().tenants_jobs_batch_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 DelegateAuthenticator Delegate

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

上传和下载

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

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

定制和回调

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

delegate trait 默认实现,允许您以最少的努力进行自定义。

服务器请求中的可选部分

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

构建器参数

使用 method builders,您可以通过重复调用它的方法来准备一个动作调用。这些方法将始终接受一个参数,以下陈述对此适用。

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

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

Cargo 功能

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

许可证

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

依赖关系

~12–23MB
~343K SLoC