8 个版本 (稳定版)
5.0.5+20240617 | 2024年6月27日 |
---|---|
5.0.4+20240221 | 2024年3月5日 |
5.0.3+20230104 | 2023年8月23日 |
5.0.2+20230104 | 2023年3月16日 |
3.0.0+20220214 | 2022年3月8日 |
#2870 in 网页开发
630KB
7.5K SLoC
google-certificatemanager1
库允许访问 Google 证书管理器服务(协议版本 v1)的所有功能。
本文档是从 证书管理器 库版本 5.0.5+20240617 生成的,其中 20240617 是由 mako 代码生成器 v5.0.5 构建的 certificatemanager:v1 架构的确切修订版本。
有关证书管理器 v1 API 的其他所有信息,请参阅 官方文档网站。
功能
轻松从中心 枢纽 处处理以下 资源...
- 项目
- locations certificate issuance configs create, locations certificate issuance configs delete, locations certificate issuance configs get, locations certificate issuance configs list, locations certificate maps certificate map entries create, locations certificate maps certificate map entries delete, locations certificate maps certificate map entries get, locations certificate maps certificate map entries list, locations certificate maps certificate map entries patch, locations certificate maps create, locations certificate maps delete, locations certificate maps get, locations certificate maps list, locations certificate maps patch, locations certificates create, locations certificates delete, locations certificates get, locations certificates list, locations certificates patch, locations dns authorizations create, locations dns authorizations delete, locations dns authorizations get, locations dns authorizations list, locations dns authorizations patch, locations get, locations list, locations operations cancel, locations operations delete, locations operations get, locations operations list, locations trust configs create, locations trust configs delete, locations trust configs get, locations trust configs list and locations trust configs patch
本库的结构
API 被组织成以下主要项目
所有 结构 都带有适用的特性和进一步分类以及便于浏览。
一般来说,您可以像这样调用 活动
let r = hub.resource().activity(...).doit().await
或具体地说 ...
let r = hub.projects().locations_certificate_issuance_configs_create(...).doit().await
let r = hub.projects().locations_certificate_issuance_configs_delete(...).doit().await
let r = hub.projects().locations_certificate_maps_certificate_map_entries_create(...).doit().await
let r = hub.projects().locations_certificate_maps_certificate_map_entries_delete(...).doit().await
let r = hub.projects().locations_certificate_maps_certificate_map_entries_patch(...).doit().await
let r = hub.projects().locations_certificate_maps_create(...).doit().await
let r = hub.projects().locations_certificate_maps_delete(...).doit().await
let r = hub.projects().locations_certificate_maps_patch(...).doit().await
let r = hub.projects().locations_certificates_create(...).doit().await
let r = hub.projects().locations_certificates_delete(...).doit().await
let r = hub.projects().locations_certificates_patch(...).doit().await
let r = hub.projects().locations_dns_authorizations_create(...).doit().await
let r = hub.projects().locations_dns_authorizations_delete(...).doit().await
let r = hub.projects().locations_dns_authorizations_patch(...).doit().await
let r = hub.projects().locations_operations_get(...).doit().await
let r = hub.projects().locations_trust_configs_create(...).doit().await
let r = hub.projects().locations_trust_configs_delete(...).doit().await
let r = hub.projects().locations_trust_configs_patch(...).doit().await
资源(resource)和活动(activity)的调用创建了构建器。第二个处理活动(Activities)的调用支持各种配置即将进行操作的方法(此处未显示)。它是这样设计的,即所有必需的参数必须立即指定(即 (...)
),而所有可选的都可以按需构建。doit()
方法执行与服务器的实际通信并返回相应的结果。
用法
设置项目
要使用这个库,你需要在你的Cargo.toml
文件中添加以下行
[dependencies]
google-certificatemanager1 = "*"
serde = "^1.0"
serde_json = "^1.0"
一个完整的示例
extern crate hyper;
extern crate hyper_rustls;
extern crate google_certificatemanager1 as certificatemanager1;
use certificatemanager1::api::CertificateIssuanceConfig;
use certificatemanager1::{Result, Error};
use std::default::Default;
use certificatemanager1::{CertificateManager, 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 = CertificateManager::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 = CertificateIssuanceConfig::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_certificate_issuance_configs_create(req, "parent")
.certificate_issuance_config_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。
当代理处理错误或中间值时,它们有机会指示系统重试。这使得系统可能对所有类型的错误都具有弹性。
上传和下载
如果某个方法支持下载,你应该读取响应体来获取媒体,响应体是Result的一部分。如果这样的方法也支持Response Result,则默认返回它。你可以将其视为实际媒体的元数据。要触发媒体下载,你将需要通过以下调用设置构建器:.param("alt", "media")
。
支持上传的方法可以使用最多2种不同的协议进行:简单和可恢复。每种协议的独特性由定制的doit(...)
方法表示,分别命名为upload(...)
和upload_resumable(...)
。
定制和回调
您可以通过在最终doit()
调用之前向Method Builder提供一个代理来更改调用doit()
方法的方式。相应的方法将被调用以提供进度信息,以及确定系统是否应在失败时重试。
默认实现了 代理 trait,允许您以最小的努力进行自定义。
服务器请求中的可选部分
此库提供的所有结构都是为了通过 json 进行 编码 和 解码 而设计的。可选部分用于表示部分请求和响应是有效的。大多数可选部分都是可以识别的 部分,通过名称进行标识,将发送到服务器以指示请求的设置部分或响应中所需的部分。
构建器参数
使用 方法构建器,您可以通过重复调用其方法来准备一个操作调用。这些方法始终接受单个参数,以下陈述对此参数是正确的。
参数将始终被复制或克隆到构建器中,以便它们与其原始的生命周期独立。
Cargo 功能
utoipa
- 添加对 utoipa 的支持,并在所有类型上派生utoipa::ToSchema
。您必须在#[openapi(schemas(...))]
中导入和注册所需的类型,否则生成的openapi
规范将无效。
许可证
certificatemanager1 库由 Sebastian Thiel 生成,并置于 MIT 许可证之下。您可以在存储库的 许可证文件 中阅读全文。
依赖关系
~12–23MB
~346K SLoC