11 个稳定版本 (3 个主要版本)
5.0.5+20240619 | 2024年6月27日 |
---|---|
5.0.4+20240221 | 2024年3月5日 |
5.0.3+20230105 | 2023年8月24日 |
5.0.2+20230105 | 2023年3月17日 |
2.0.4+20210322 | 2021年4月15日 |
#2256 in 网页编程
706 每月下载量
用于 google-privateca1_beta1-c…
335KB
4K SLoC
google-privateca1_beta1
库允许访问 Google 证书授权服务(服务 v1beta1)的所有功能。
本文档是从 证书授权服务 crate 版本 5.0.5+20240619 生成的,其中 20240619 是由 mako 代码生成器 v5.0.5 构建的 privateca:v1beta1 模式的确切修订版本。
有关 证书授权服务 v1_beta1 API 的其他所有信息,请参阅 官方文档网站。
功能
从中心 枢纽 轻松处理以下 资源...
- 项目
- 获取位置证书颁发机构证书吊销列表 IAM 策略,设置位置证书颁发机构证书吊销列表 IAM 策略,测试位置证书颁发机构证书吊销列表 IAM 权限,获取位置证书颁发机构 IAM 策略,设置位置证书颁发机构 IAM 策略,测试位置证书颁发机构 IAM 权限,获取位置,列出位置,取消位置操作,删除位置操作,获取位置操作,列出位置操作,获取位置可重用配置 IAM 策略,设置位置可重用配置 IAM 策略 以及 测试位置可重用配置 IAM 权限
该库的结构
API 结构如下主要项
所有 结构 都带有适用的特性,以便进一步分类和便于浏览。
一般来说,您可以像这样调用 活动
let r = hub.resource().activity(...).doit().await
或具体地 ...
let r = hub.projects().locations_certificate_authorities_certificate_revocation_lists_get_iam_policy(...).doit().await
let r = hub.projects().locations_certificate_authorities_certificate_revocation_lists_set_iam_policy(...).doit().await
let r = hub.projects().locations_certificate_authorities_get_iam_policy(...).doit().await
let r = hub.projects().locations_certificate_authorities_set_iam_policy(...).doit().await
let r = hub.projects().locations_reusable_configs_get_iam_policy(...).doit().await
let r = hub.projects().locations_reusable_configs_set_iam_policy(...).doit().await
resource()
和 activity(...)
调用创建 构建器。第二个处理 Activities
支持各种方法来配置即将进行的操作(此处未显示)。它被设计成所有必需的参数必须立即指定(即 (...)
),而所有可选的参数都可以 构建 如所需。 doit()
方法执行与服务器的实际通信并返回相应的结果。
使用方法
设置您的项目
要使用这个库,您需要将以下几行代码放入您的 Cargo.toml
文件中
[dependencies]
google-privateca1_beta1 = "*"
serde = "^1.0"
serde_json = "^1.0"
完整示例
extern crate hyper;
extern crate hyper_rustls;
extern crate google_privateca1_beta1 as privateca1_beta1;
use privateca1_beta1::{Result, Error};
use std::default::Default;
use privateca1_beta1::{CertificateAuthorityService, 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 = CertificateAuthorityService::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.projects().locations_certificate_authorities_certificate_revocation_lists_get_iam_policy("resource")
.options_requested_policy_version(-33)
.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")
。
支持上传的方法可以使用最多 2 种不同的协议:简单 和 可重试。每种协议的独特性由定制的 doit(...)
方法表示,分别命名为 upload(...)
和 upload_resumable(...)
。
定制和回调
您可以通过在最终调用 doit() 之前向 Method Builder 提供一个 delegate 来改变 doit() 方法的调用方式。相应的方法将被调用来提供进度信息,以及确定系统在失败时是否应该重试。
delegate trait 默认实现,允许您以最小的努力进行自定义。
服务器请求中的可选部分
此库提供的所有结构都旨在通过 json 进行 编码 和 解码。使用可选项来表示部分请求和响应是有效的。大多数可选项都被认为是 Parts,这些部分可以通过名称识别,将被发送到服务器以指示请求的设置部分或响应中期望的部分。
构建器参数
使用 method builders,您可以通过重复调用其方法来准备一个操作调用。这些方法始终接受单个参数,以下语句是真实的。
参数将始终被复制或克隆到构建器中,以确保它们与原始生命周期独立。
Cargo 功能
utoipa
- 添加对 utoipa 的支持,并派生所有类型上的utoipa::ToSchema
。您必须导入并在#[openapi(schemas(...))]
中注册所需的类型,否则生成的openapi
规范将是无效的。
许可证
privateca1_beta1 库由 Sebastian Thiel 生成,并置于 MIT 许可证下。您可以在存储库的 许可证文件 中阅读全文。
依赖项
~12–23MB
~343K SLoC