google-deploymentmanager2 库允许访问 Google Deployment Manager 服务的所有功能。

此文档是从 Deployment Manager 包版本 5.0.5+20240404 生成的，其中 20240404 是由 mako 代码生成器 v5.0.5 构建的 deploymentmanager:v2 架构的确切修订版本。

关于 Deployment Manager v2 API 的其他信息可以在 官方文档站点 找到。

功能

从中心 枢纽 简单处理以下 资源 ...

• 部署
• 取消预览、删除、获取、获取 IAM 策略、插入、列出、更新、设置 IAM 策略、停止、测试 IAM 权限 和 更新
• 清单
• 获取 和 列出
• 操作
• 获取 和 列出
• 资源
• get 和 list
• 类型
• 列表

本库的结构

API 被组织成以下主要项目

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

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

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

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

或者具体地说 ...

let r = hub.deployments().cancel_preview(...).doit().await
let r = hub.deployments().delete(...).doit().await
let r = hub.deployments().get(...).doit().await
let r = hub.deployments().get_iam_policy(...).doit().await
let r = hub.deployments().insert(...).doit().await
let r = hub.deployments().list(...).doit().await
let r = hub.deployments().patch(...).doit().await
let r = hub.deployments().set_iam_policy(...).doit().await
let r = hub.deployments().stop(...).doit().await
let r = hub.deployments().test_iam_permissions(...).doit().await
let r = hub.deployments().update(...).doit().await

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

使用方法

设置您的项目

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

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

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_deploymentmanager2 as deploymentmanager2;
use deploymentmanager2::api::Deployment;
use deploymentmanager2::{Result, Error};
use std::default::Default;
use deploymentmanager2::{DeploymentManager, 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 = DeploymentManager::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 = Deployment::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.deployments().patch(req, "project", "deployment")
             .preview(true)
             .delete_policy("voluptua.")
             .create_policy("At")
             .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进行编码和解码而设计的。可选部分用于表示部分请求或响应是有效的。大多数可选部分都是被认为是部分，它们可以通过名称识别，这些部分将发送到服务器以指示请求的设置部分或响应中期望的部分。

构建器参数

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

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

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

Cargo功能

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

许可证

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