该 google-composer1 库允许访问 Google Cloud Composer 服务的所有功能。

本文档是根据 Cloud Composer crate 版本 5.0.5+20240618 生成的，其中 20240618 是由 mako 代码生成器 v5.0.5 构建的 composer:v1 方案的精确版本。

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

功能

从中央 枢纽 ...

• 项目
• 位置环境检查升级，位置环境创建，位置环境数据库故障转移，位置环境删除，位置环境执行 Airflow 命令，位置环境获取数据库属性，位置环境获取，位置环境列表，位置环境加载快照，位置环境修补，位置环境轮询 Airflow 命令，位置环境保存快照，位置环境停止 Airflow 命令，位置环境用户工作负载配置映射创建，位置环境用户工作负载配置映射删除，位置环境用户工作负载配置映射获取，位置环境用户工作负载配置映射列表，位置环境用户工作负载配置映射更新，位置环境用户工作负载机密创建，位置环境用户工作负载机密删除，位置环境用户工作负载机密获取，位置环境用户工作负载机密列表，位置环境用户工作负载机密更新，位置环境工作负载列表，位置镜像版本列表，位置操作删除，位置操作获取和位置操作列表

本库结构

API 结构如下主要项目

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

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

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

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

或者具体...

let r = hub.projects().locations_environments_check_upgrade(...).doit().await
let r = hub.projects().locations_environments_create(...).doit().await
let r = hub.projects().locations_environments_database_failover(...).doit().await
let r = hub.projects().locations_environments_delete(...).doit().await
let r = hub.projects().locations_environments_load_snapshot(...).doit().await
let r = hub.projects().locations_environments_patch(...).doit().await
let r = hub.projects().locations_environments_save_snapshot(...).doit().await
let r = hub.projects().locations_operations_get(...).doit().await

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

用法

设置您的项目

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

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

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_composer1 as composer1;
use composer1::api::Environment;
use composer1::{Result, Error};
use std::default::Default;
use composer1::{CloudComposer, 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 = CloudComposer::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 = Environment::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_environments_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(...)。

定制和回调

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

默认实现了代理特质，您可以用最少的努力对其进行自定义。

服务器请求中的可选部分

此库提供所有结构，以便通过json进行编码和解码。可选部分用于表示部分请求或响应是有效的。大多数可选部分都是部分，通过名称标识，将发送到服务器以指示请求的设置部分或期望的响应部分。

构建器参数

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

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

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

Cargo功能

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

许可证

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