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

此文档是从 Cloud Scheduler crate 版本 5.0.5+20240615 生成的，其中 20240615 是由 mako 代码生成器 v5.0.5 构建的 cloudscheduler:v1beta1 架构的精确修订。

有关 Cloud Scheduler v1_beta1 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_beta1 = "*"
serde = "^1.0"
serde_json = "^1.0"

一个完整的示例

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

定制和回调

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

delegate trait 默认实现，允许您以最小的努力进行定制。

服务器请求中的可选部分

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

Builder 参数

使用 method builders，您可以通过反复调用其方法来准备一个操作调用。这些方法始终接受一个单一参数，以下陈述适用于该参数。

• PODs 通过复制传递
• 字符串作为 &str 传递
• request values 被移动

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

Cargo 功能

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

许可证

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