18 个稳定版本 (4 个主要版本)
5.0.5+20240227 | 2024年6月27日 |
---|---|
5.0.4+20240227 | 2024年3月5日 |
5.0.3+20230123 | 2023年8月24日 |
5.0.2+20230123 | 2023年3月16日 |
1.0.7+20171030 | 2018年2月1日 |
#2374 in 网页编程
435KB
5K SLoC
该 google-runtimeconfig1_beta1
库允许访问 Google Cloud RuntimeConfig 服务(协议 v1beta1)的所有功能。
本文档是根据 Cloud RuntimeConfig crate 版本 5.0.5+20240227 生成的,其中 20240227 是由 mako 代码生成器 v5.0.5 构建的 runtimeconfig:v1beta1 方案的精确版本。
有关 Cloud RuntimeConfig v1_beta1 API 的其他信息,请参阅官方文档网站。
功能
轻松从中央 中心 处理以下 资源 ...
- 项目
- 创建配置,删除配置,获取配置,获取IAM策略,列出配置,获取操作,测试IAM权限,设置IAM策略,测试IAM权限,更新配置,创建变量,删除变量,获取变量,列出变量,测试IAM权限,更新变量,监视变量,创建等待器,删除等待器,获取等待器,列出等待器以及测试等待器IAM权限
库的结构
API结构如下几个主要项
所有结构都标记了适用的特性,以进一步分类并便于浏览。
一般来说,您可以像这样调用活动
let r = hub.resource().activity(...).doit().await
或者具体来说...
let r = hub.projects().configs_variables_create(...).doit().await
let r = hub.projects().configs_variables_get(...).doit().await
let r = hub.projects().configs_variables_update(...).doit().await
let r = hub.projects().configs_variables_watch(...).doit().await
资源 resource()
和活动 activity(...)
调用创建构建器。第二个处理 Activities
支持各种方法来配置即将进行的操作(此处未展示)。它被设计成必须立即指定所有必需参数(即 (...)
),而所有可选参数都可以根据需要 构建。doit()
方法执行与服务器的实际通信并返回相应的结果。
用法
设置您的项目
要使用此库,您需要将以下行放入您的 Cargo.toml
文件
[dependencies]
google-runtimeconfig1_beta1 = "*"
serde = "^1.0"
serde_json = "^1.0"
一个完整的示例
extern crate hyper;
extern crate hyper_rustls;
extern crate google_runtimeconfig1_beta1 as runtimeconfig1_beta1;
use runtimeconfig1_beta1::api::Variable;
use runtimeconfig1_beta1::{Result, Error};
use std::default::Default;
use runtimeconfig1_beta1::{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);
// 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 = Variable::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().configs_variables_create(req, "parent")
.request_id("magna")
.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。
当代理处理错误或中间值时,它们有机会指示系统重试。这使得系统可能对所有类型的错误都有弹性。
上传和下载
如果方法支持下载,您应该读取响应体以获取媒体。如果此类方法还支持 Response Result,则默认返回该结果。您可以将它视为实际媒体的元数据。要触发媒体下载,您将必须通过此调用设置构建器:.param("alt", "media")
。
支持上传的方法可以使用最多两种不同的协议进行上传:简单 和 可恢复。每种协议的独特性由定制的 doit(...)
方法表示,分别命名为 upload(...)
和 upload_resumable(...)
。
定制和回调
您可以通过提供一个委托给方法构建器来改变对doit()
方法的调用方式。在执行最终的doit()
调用之前,将调用相应的方法以提供进度信息,并确定系统是否应在失败时重试。
委托特质默认实现,允许您以最小的努力进行自定义。
服务器请求中的可选部分
此库提供的所有结构都是为了通过json进行编码和解码而设计的。使用可选类型表示部分请求或响应是有效的。大多数可选类型都是被认为是部分,可以通过名称识别,这些部分将被发送到服务器,以指示请求或响应中所需的设置部分。
构建器参数
使用方法构建器,您可以通过重复调用其方法来准备动作调用。这些方法始终接受单个参数,以下陈述对参数是正确的。
参数将始终复制或克隆到构建器中,以便它们与其原始的生命周期独立。
Cargo功能
utoipa
- 添加对utoipa的支持,并在所有类型上派生utoipa::ToSchema
。您必须在#[openapi(schemas(...))]
中导入和注册所需的类型,否则生成的openapi
规范将是无效的。
许可证
runtimeconfig1_beta1库由Sebastian Thiel生成,并置于MIT许可证之下。您可以在存储库的许可证文件中阅读全文。
依赖项
~12–23MB
~345K SLoC