该 google-runtimeconfig1 库允许访问 Google Cloud RuntimeConfig（服务）的所有功能。

本文档是从 Cloud RuntimeConfig crate 版本 5.0.5+20240227 生成的，其中 20240227 是由 mako 代码生成器 v5.0.5 构建的 runtimeconfig:v1 架构的确切修订版。

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

功能

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

• 操作
• 取消，删除 和 列出

本库的结构

API 结构如下主要项目

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

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

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

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

或具体 ...

let r = hub.operations().cancel(...).doit().await
let r = hub.operations().delete(...).doit().await
let r = hub.operations().list(...).doit().await

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

使用方法

设置您的项目

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

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

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_runtimeconfig1 as runtimeconfig1;
use runtimeconfig1::{Result, Error};
use std::default::Default;
use runtimeconfig1::{CloudRuntimeConfig, 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 = CloudRuntimeConfig::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.operations().list("name")
             .page_token("magna")
             .page_size(-11)
             .filter("ipsum")
             .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(...)。

自定义和回调

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

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

服务器请求中的可选部分

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

构建器参数

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

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

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

Cargo 功能

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

许可证

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