google-remotebuildexecution2 库允许访问 Google Remote Build Execution 服务的所有功能。

此文档是从 Remote Build Executioncrate版本 5.0.5+20210329 生成的，其中 20210329 是由 mako 代码生成器 v5.0.5 构建的 remotebuildexecution:v2 架构的确切版本。

有关 Remote Build Execution v2 API 的其他所有信息，请参阅官方文档网站。

功能

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

• 操作结果
• 获取 和 更新
• 操作
• 执行
• 块
• 批量读取，批量更新，查找缺失的 和 获取树
• 操作
• 等待执行

其他活动 ...

• 获取能力

此库的结构

API 结构如下主要项

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

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

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

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

或者具体来说...

let r = hub.action_results().get(...).doit().await
let r = hub.action_results().update(...).doit().await

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

用法

设置您的项目

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

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

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_remotebuildexecution2 as remotebuildexecution2;
use remotebuildexecution2::{Result, Error};
use std::default::Default;
use remotebuildexecution2::{RemoteBuildExecution, 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 = RemoteBuildExecution::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.action_results().get("instanceName", "hash", -11)
             .inline_stdout(true)
             .inline_stderr(false)
             .add_inline_output_files("amet.")
             .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 提供一个 代理 来更改 doit() 方法调用的方式。相应的函数将被调用来提供进度信息，并确定系统是否在失败时应该重试。

代理特质 默认实现，允许您以最小的努力进行自定义。

服务器请求中的可选部分

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

构建器参数

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

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

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

Cargo 功能

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

许可证

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