12个稳定版本 (4个主要版本)
5.0.5+20240623 | 2024年6月27日 |
---|---|
5.0.4+20240303 | 2024年3月5日 |
5.0.3+20230121 | 2023年8月24日 |
5.0.2+20230121 | 2023年3月16日 |
1.0.14+20200704 | 2020年7月10日 |
3 in #iam-policy
114 monthly downloads
Used in google-policytroubleshoot…
130KB
1.5K SLoC
《google-policytroubleshooter1》库允许访问Google策略故障排除器服务的所有功能。
本文档由版本5.0.5+20240623的Policy Troubleshooter crate生成,其中20240623是mako代码生成器v5.0.5构建的policytroubleshooter:v1模式的确切修订版。
有关策略故障排除器v1 API的所有其他信息,请参阅官方文档网站。
功能
轻松从中央中心处理以下资源...
- iam
- troubleshoot
本库的结构
API结构如下主要项
所有结构都带有适用的特性,以进一步分类它们并简化浏览。
一般来说,你可以这样调用活动
let r = hub.resource().activity(...).doit().await
或者具体地说...
let r = hub.iam().troubleshoot(...).doit().await
resource()
和 activity(...)
调用创建构建器。第二个处理 Activities
,支持各种配置即将进行操作的方法(此处未展示)。它被设计成必须立即指定所有必需参数(即 (...)
),而所有可选参数则可以根据需要逐步构建。doit()
方法执行与服务器的实际通信,并返回相应的结果。
使用方法
设置你的项目
要使用这个库,你需要在你的 Cargo.toml
文件中添加以下行
[dependencies]
google-policytroubleshooter1 = "*"
serde = "^1.0"
serde_json = "^1.0"
完整示例
extern crate hyper;
extern crate hyper_rustls;
extern crate google_policytroubleshooter1 as policytroubleshooter1;
use policytroubleshooter1::api::GoogleCloudPolicytroubleshooterV1TroubleshootIamPolicyRequest;
use policytroubleshooter1::{Result, Error};
use std::default::Default;
use policytroubleshooter1::{PolicyTroubleshooter, 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 = PolicyTroubleshooter::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 = GoogleCloudPolicytroubleshooterV1TroubleshootIamPolicyRequest::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.iam().troubleshoot(req)
.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 提供一个 delegate 来改变 doit()
方法的调用方式。相应的方 法将被调用以提供进度信息,并确定系统是否应在失败时重试。
delegate trait 默认实现了,允许您以最小的努力进行自定义。
服务器请求中的可选部分
本库提供的所有结构都设计为可以通过 编码 和 解码 为 json 格式。使用可选参数来表示部分请求和响应是有效的。大多数可选参数都是 Parts,可以通过名称识别,这些参数将被发送到服务器以指示请求或响应中所需的部分。
构建器参数
通过使用 方法构建器,您可以通过重复调用其方法来准备一个动作调用。这些方法始终接受一个参数,以下语句是正确的。
参数将被复制或克隆到构建器中,以确保它们与其原始生命周期独立。
Cargo 特性
utoipa
- 添加对 utoipa 的支持,并在所有类型上派生utoipa::ToSchema
。您必须在#[openapi(schemas(...))]
中导入并注册所需的类型,否则生成的openapi
规范将是无效的。
许可证
policytroubleshooter1 库由 Sebastian Thiel 生成,并置于 MIT 许可证之下。您可以在仓库的 许可证文件 中阅读全文。
依赖项
~12–22MB
~339K SLoC