“google-cloudbuild1”库允许访问 Google Cloud Build 服务的所有功能。

本文档是根据 Cloud Build 包版本 5.0.5+20240618 生成的，其中 20240618 是由 mako 代码生成器 v5.0.5 构建的 cloudbuild:v1 模式的确切修订版。

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

功能

从中央 中心 简单地处理以下 资源...

• github dot com webhook
• 接收
• 位置
• 区域 webhook
• 操作
• 取消 和 获取
• 项目
• builds approve, builds cancel, builds create, builds get, builds list, builds retry, github enterprise configs create, github enterprise configs delete, github enterprise configs get, github enterprise configs list, github enterprise configs patch, locations bitbucket server configs connected repositories batch create, locations bitbucket server configs create, locations bitbucket server configs delete, locations bitbucket server configs get, locations bitbucket server configs list, locations bitbucket server configs patch, locations bitbucket server configs remove bitbucket server connected repository, locations bitbucket server configs repos list, locations builds approve, locations builds cancel, locations builds create, locations builds get, locations builds list, locations builds retry, locations get default service account, locations git lab configs connected repositories batch create, locations git lab configs create, locations git lab configs delete, locations git lab configs get, locations git lab configs list, locations git lab configs patch, locations git lab configs remove git lab connected repository, locations git lab configs repos list, locations github enterprise configs create, locations github enterprise configs delete, locations github enterprise configs get, locations github enterprise configs list, locations github enterprise configs patch, locations operations cancel, locations operations get, locations triggers create, locations triggers delete, locations triggers get, locations triggers list, locations triggers patch, locations triggers run, locations triggers webhook, locations worker pools create, locations worker pools delete, locations worker pools get, locations worker pools list, locations worker pools patch, triggers create, triggers delete, triggers get, triggers list, triggers patch, triggers run and triggers webhook

其他活动包括...

• webhook

本库的结构

API 结构如下主要项目

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

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

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

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

或具体地...

let r = hub.operations().cancel(...).doit().await
let r = hub.operations().get(...).doit().await
let r = hub.projects().builds_approve(...).doit().await
let r = hub.projects().builds_create(...).doit().await
let r = hub.projects().builds_retry(...).doit().await
let r = hub.projects().github_enterprise_configs_create(...).doit().await
let r = hub.projects().github_enterprise_configs_delete(...).doit().await
let r = hub.projects().github_enterprise_configs_patch(...).doit().await
let r = hub.projects().locations_bitbucket_server_configs_connected_repositories_batch_create(...).doit().await
let r = hub.projects().locations_bitbucket_server_configs_create(...).doit().await
let r = hub.projects().locations_bitbucket_server_configs_delete(...).doit().await
let r = hub.projects().locations_bitbucket_server_configs_patch(...).doit().await
let r = hub.projects().locations_builds_approve(...).doit().await
let r = hub.projects().locations_builds_create(...).doit().await
let r = hub.projects().locations_builds_retry(...).doit().await
let r = hub.projects().locations_git_lab_configs_connected_repositories_batch_create(...).doit().await
let r = hub.projects().locations_git_lab_configs_create(...).doit().await
let r = hub.projects().locations_git_lab_configs_delete(...).doit().await
let r = hub.projects().locations_git_lab_configs_patch(...).doit().await
let r = hub.projects().locations_github_enterprise_configs_create(...).doit().await
let r = hub.projects().locations_github_enterprise_configs_delete(...).doit().await
let r = hub.projects().locations_github_enterprise_configs_patch(...).doit().await
let r = hub.projects().locations_operations_get(...).doit().await
let r = hub.projects().locations_triggers_run(...).doit().await
let r = hub.projects().locations_worker_pools_create(...).doit().await
let r = hub.projects().locations_worker_pools_delete(...).doit().await
let r = hub.projects().locations_worker_pools_patch(...).doit().await
let r = hub.projects().triggers_run(...).doit().await

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

用法

设置项目

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

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

完整示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_cloudbuild1 as cloudbuild1;
use cloudbuild1::api::GitHubEnterpriseConfig;
use cloudbuild1::{Result, Error};
use std::default::Default;
use cloudbuild1::{CloudBuild, 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 = CloudBuild::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 = GitHubEnterpriseConfig::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().github_enterprise_configs_create(req, "parent")
             .project_id("magna")
             .ghe_config_id("no")
             .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(...)。