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

本文档是从 Cloud Run crate 版本 5.0.5+20240621 生成的，其中 20240621 是由 mako 代码生成器 v5.0.5 构建的 run:v2 架构的确切修订版。

关于 Cloud Run v2 API 的其他所有信息都可以在 官方文档网站 找到。

功能

从中央 枢纽 轻松处理以下 资源...

• 项目
• 位置导出镜像，位置导出镜像元数据，位置导出元数据，位置创建作业，位置删除作业，位置作业执行取消，位置作业执行删除，位置作业执行导出状态，位置作业执行获取，位置作业执行列表，位置作业执行任务获取，位置作业执行任务列表，位置作业获取，位置作业获取 IAM 策略，位置作业列表，位置作业修补，位置作业运行，位置作业设置 IAM 策略，位置作业测试 IAM 权限，位置操作删除，位置操作获取，位置操作列表，位置操作等待，位置创建服务，位置删除服务，位置服务获取，位置服务获取 IAM 策略，位置服务列表，位置服务修补，位置服务修订删除，位置服务修订导出状态，位置服务修订获取，位置服务修订列表，位置服务设置 IAM 策略 以及 位置服务测试 IAM 权限

本库的结构

API 结构如下主要项

• 中心
  • 一个中心对象，用于维护状态并允许访问所有 活动
  • 创建方法构建器，它允许访问单个调用构建器
• 资源
  • 可以应用于活动的基本类型
  • 一组属性和部分
  • 部分
    • 一组属性
    • 从未在活动中直接使用
• 活动
  • 应用于资源的操作

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

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

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

或者具体...

let r = hub.projects().locations_jobs_executions_cancel(...).doit().await
let r = hub.projects().locations_jobs_executions_delete(...).doit().await
let r = hub.projects().locations_jobs_create(...).doit().await
let r = hub.projects().locations_jobs_delete(...).doit().await
let r = hub.projects().locations_jobs_patch(...).doit().await
let r = hub.projects().locations_jobs_run(...).doit().await
let r = hub.projects().locations_operations_get(...).doit().await
let r = hub.projects().locations_operations_wait(...).doit().await
let r = hub.projects().locations_services_revisions_delete(...).doit().await
let r = hub.projects().locations_services_create(...).doit().await
let r = hub.projects().locations_services_delete(...).doit().await
let r = hub.projects().locations_services_patch(...).doit().await

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

用法

设置您的项目

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

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

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_run2 as run2;
use run2::api::GoogleCloudRunV2Service;
use run2::{Result, Error};
use std::default::Default;
use run2::{CloudRun, 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 = CloudRun::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 = GoogleCloudRunV2Service::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_services_patch(req, "name")
             .validate_only(true)
             .update_mask(FieldMask::new::<&str>(&[]))
             .allow_missing(false)
             .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")。

支持上传的方法可以使用最多两种不同的协议：`简单`和`可恢复`。每种方法的独特性由定制的`doit(...)方法表示，分别命名为`upload(...)`和`upload_resumable(...)`。

自定义和回调

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

默认实现了 代理特质，您可以用最小的努力来自定义它。

服务器请求中的可选部分

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

构建器参数

使用 方法构建器，您可以通过反复调用其方法来准备一个操作调用。这些方法始终接受单个参数，以下陈述对它适用。

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

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

Cargo 功能

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

许可证

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