16 个稳定版本 (4 个主要版本)

5.0.5+20240621 2024 年 6 月 27 日
5.0.4+20240225 2024 年 3 月 5 日
5.0.3+20230113 2023 年 8 月 23 日
5.0.2+20230113 2023 年 3 月 17 日
1.0.10+20190624 2019 年 7 月 6 日

#2236 in 网页编程

Download history · Rust 包仓库 7/week @ 2024-05-19 · Rust 包仓库 1/week @ 2024-06-09 · Rust 包仓库 1/week @ 2024-06-16 · Rust 包仓库 105/week @ 2024-06-23 · Rust 包仓库 121/week @ 2024-06-30 · Rust 包仓库

998 每月下载量
用于 google-run1-cli

MIT 许可证

1MB
13K SLoC

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

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

有关 Cloud Run v1 API 的其他所有信息,请参阅 官方文档站点

功能

从中心 枢纽 ...

本库结构

API 被组织为以下主要项

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

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

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

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

或者具体来说 ...

let r = hub.namespaces().domainmappings_delete(...).doit().await
let r = hub.namespaces().executions_delete(...).doit().await
let r = hub.namespaces().jobs_delete(...).doit().await
let r = hub.namespaces().revisions_delete(...).doit().await
let r = hub.namespaces().services_delete(...).doit().await
let r = hub.projects().locations_domainmappings_delete(...).doit().await
let r = hub.projects().locations_revisions_delete(...).doit().await
let r = hub.projects().locations_services_delete(...).doit().await

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

用法

设置项目

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

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

完整示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_run1 as run1;
use run1::{Result, Error};
use std::default::Default;
use run1::{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);
// 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.namespaces().domainmappings_delete("name")
             .propagation_policy("magna")
             .kind("no")
             .dry_run("ipsum")
             .api_version("voluptua.")
             .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()调用之前将代表提供给方法构建器来改变doit()方法的调用方式。相应的方

代表特质默认实现,允许您以最少的努力对其进行自定义。

服务器请求中的可选部分

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

构建器参数

使用方法构建器,您可以通过反复调用其方法来准备一个操作调用。这些方法始终接受单个参数,以下语句适用于这些参数。

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

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

Cargo功能

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

许可协议

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

依赖关系

~12-23MB
~343K SLoC