16 个稳定版本 (4 个主要版本)
5.0.5+20240623 | 2024年6月27日 |
---|---|
5.0.4+20240224 | 2024年3月5日 |
5.0.3+20230118 | 2023年8月23日 |
5.0.2+20230118 | 2023年3月16日 |
1.0.10+20190628 | 2019年7月6日 |
#2427 in 网页编程
405KB
5K SLoC
google-iap1
库允许访问 Google Cloud IAP 服务(协议 v1)的所有功能。
本文档是从 Cloud IAP 库版本 5.0.5+20240623 生成的,其中 20240623 是由 mako 代码生成器 v5.0.5 构建的 iap:v1 架构的确切修订版本。
有关 Cloud IAP v1 API 的其他所有信息,请参阅 官方文档网站。
功能
从中央 中心轻松处理以下 资源...
- 项目
- 创建品牌,获取品牌,创建品牌身份感知代理客户端,删除品牌身份感知代理客户端,获取品牌身份感知代理客户端,列出品牌身份感知代理客户端,重置品牌身份感知代理客户端的秘密,列出品牌,创建 iap_tunnel 位置目标组,删除 iap_tunnel 位置目标组,获取 iap_tunnel 位置目标组,列出 iap_tunnel 位置目标组 和 修补 iap_tunnel 位置目标组
其他活动包括 ...
本库的结构
API结构如下主要项目
所有结构都带有适用的特质,以进一步分类它们并简化浏览。
一般来说,您可以这样调用活动
let r = hub.resource().activity(...).doit().await
或具体...
let r = hub.projects().brands_identity_aware_proxy_clients_create(...).doit().await
let r = hub.projects().brands_identity_aware_proxy_clients_get(...).doit().await
let r = hub.projects().brands_identity_aware_proxy_clients_reset_secret(...).doit().await
resource()
和activity(...)
调用创建构建器。第二个构建器用于处理活动
,它支持各种方法来配置即将进行的操作(此处未显示)。它被设计成必须立即指定所有必需的参数(即(...)
),而所有可选的参数可以按需构建。doit()
方法执行与服务器的实际通信并返回相应的结果。
用法
设置您的项目
要使用此库,您会将以下行放入您的Cargo.toml
文件中
[dependencies]
google-iap1 = "*"
serde = "^1.0"
serde_json = "^1.0"
一个完整的示例
extern crate hyper;
extern crate hyper_rustls;
extern crate google_iap1 as iap1;
use iap1::api::IdentityAwareProxyClient;
use iap1::{Result, Error};
use std::default::Default;
use iap1::{CloudIAP, 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 = CloudIAP::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 = IdentityAwareProxyClient::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().brands_identity_aware_proxy_clients_create(req, "parent")
.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()
的一部分)应由您读取以获取媒体。如果此方法还支持ResponseResult()
,则默认返回该结果。您可以将它视为实际媒体的元数据。要触发媒体下载,您必须通过此调用设置构建器:.param("alt", "media")
。
支持上传的方法可以使用最多两种不同的协议进行上传:简单和可恢复。每种协议的独特性由自定义的doit(...)
方法表示,分别命名为upload(...)
和upload_resumable(...)
。
自定义和回调
您可以通过向委托提供方法构建器来改变doit()
方法的调用方式,在执行最终的doit()
调用之前。相应的函数将被调用以提供进度信息,并确定系统在失败时应否重试。
委托特剧行默认实现,让您轻松自定义。
服务器请求中的可选部分
此库提供的所有结构都旨在通过json进行编码和解码。使用可选项表示部分请求和响应都是有效的。大多数可选项都是可识别的部分,这些部分可以通过名称识别,并将发送到服务器以指示请求的设置部分或响应中所需的部分。
构建器参数
通过使用方法构建器,您可以多次调用其方法来准备操作调用。这些方法始终接受单个参数,以下语句是真实的。
参数总是被复制或克隆到构建器中,以使它们与其原始的生命周期独立。
Cargo功能
utoipa
- 为所有类型添加对utoipa的支持并派生utoipa::ToSchema
。您必须在#[openapi(schemas(...))]
中导入并注册所需类型,否则生成的openapi
规范将无效。
许可协议
iap1库由Sebastian Thiel生成,并置于MIT许可证之下。您可以在存储库的许可文件中阅读全文。
依赖关系
~12–23MB
~346K SLoC