8 个版本 (稳定)

5.0.5+20240619	2024年6月27日
5.0.4+20240221	2024年3月5日
5.0.3+20230105	2023年8月23日
5.0.2+20230105	2023年3月16日
3.0.0+20220223	2022年3月8日

#2856 在 Web编程

每月469次下载
用于 google-clouddeploy1-cli

MIT 许可证

1MB
12K SLoC

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

本文档是从Cloud Deploy crate版本 5.0.5+20240619 生成的，其中 20240619 是由mako 代码生成器 v5.0.5 构建的 clouddeploy:v1 模式的确切修订。

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

功能

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

本库的结构

API结构如下主要项

枢纽
- 一个中央对象，用于维护状态并允许访问所有活动
- 创建 方法构建器，后者又允许访问单个 调用构建器
资源
- 可以将其应用于活动的主要类型
- 一组属性和部分
- 部分
  - 一组属性
  - 在活动中从不直接使用
活动
- 应用于资源的操作

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

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

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

或具体...

let r = hub.projects().locations_custom_target_types_create(...).doit().await
let r = hub.projects().locations_custom_target_types_delete(...).doit().await
let r = hub.projects().locations_custom_target_types_patch(...).doit().await
let r = hub.projects().locations_delivery_pipelines_automations_create(...).doit().await
let r = hub.projects().locations_delivery_pipelines_automations_delete(...).doit().await
let r = hub.projects().locations_delivery_pipelines_automations_patch(...).doit().await
let r = hub.projects().locations_delivery_pipelines_releases_rollouts_create(...).doit().await
let r = hub.projects().locations_delivery_pipelines_releases_create(...).doit().await
let r = hub.projects().locations_delivery_pipelines_create(...).doit().await
let r = hub.projects().locations_delivery_pipelines_delete(...).doit().await
let r = hub.projects().locations_delivery_pipelines_patch(...).doit().await
let r = hub.projects().locations_operations_get(...).doit().await
let r = hub.projects().locations_targets_create(...).doit().await
let r = hub.projects().locations_targets_delete(...).doit().await
let r = hub.projects().locations_targets_patch(...).doit().await

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

使用方法

设置项目

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

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

完整示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_clouddeploy1 as clouddeploy1;
use clouddeploy1::api::CustomTargetType;
use clouddeploy1::{Result, Error};
use std::default::Default;
use clouddeploy1::{CloudDeploy, 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 = CloudDeploy::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 = CustomTargetType::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_custom_target_types_patch(req, "name")
             .validate_only(true)
             .update_mask(FieldMask::new::<&str>(&[]))
             .request_id("voluptua.")
             .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")。

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

定制和回调

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

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

服务器请求中的可选部分

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

构建器参数

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

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

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

Cargo 功能

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

许可证

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

依赖项

~12–23MB
~343K SLoC