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

本文档是从 Cloud Schedulercrate 版本 5.0.5+20240615 生成的，其中 20240615 是由 mako 代码生成器构建的 cloudscheduler:v1 架构的确切修订版。

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

功能

轻松处理以下 资源，从中央 中心 ...

• 项目
• 位置获取，位置工作创建，位置工作删除，位置工作获取，位置工作列表，位置工作修补，位置工作暂停，位置工作恢复，位置工作运行 和 位置列表

此库的结构

API 结构如下主要项

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

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

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

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

或者具体来说...

let r = hub.projects().locations_jobs_create(...).doit().await
let r = hub.projects().locations_jobs_get(...).doit().await
let r = hub.projects().locations_jobs_patch(...).doit().await
let r = hub.projects().locations_jobs_pause(...).doit().await
let r = hub.projects().locations_jobs_resume(...).doit().await
let r = hub.projects().locations_jobs_run(...).doit().await

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

使用方法

设置你的项目

要使用这个库，你需要在你的Cargo.toml文件中放入以下几行

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

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_cloudscheduler1 as cloudscheduler1;
use cloudscheduler1::api::Job;
use cloudscheduler1::{Result, Error};
use std::default::Default;
use cloudscheduler1::{CloudScheduler, 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 = CloudScheduler::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 = Job::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_jobs_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(...)。

定制和回调

您可以通过向 方法构建器 提供一个 委托 来更改 doit() 方法调用的方式。在执行最终的 doit() 调用之前，将调用相应的方法以提供进度信息，并确定系统在失败时是否应该重试。

委托特质 具有默认实现，让您可以轻松地对其进行自定义。

服务器请求中的可选部分

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

构建器参数

使用 方法构建器，您可以通过反复调用其方法来准备动作调用。这些方法始终接受单个参数，以下语句是真实的。

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

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

Cargo 功能

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

许可证

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