8 个版本 (稳定版)
5.0.5+20240613 | 2024年6月27日 |
---|---|
5.0.4+20231203 | 2024年3月5日 |
5.0.3+20221113 | 2023年8月23日 |
5.0.2+20221113 | 2023年3月16日 |
3.0.0+20220221 | 2022年3月8日 |
#2569 in 网页编程
315KB
4K SLoC
该 google-ids1
库允许访问 Google IDS 服务的所有功能。
本文档是由版本 5.0.5+20240613 的 IDS crate 生成的,其中 20240613 是由 mako 代码生成器 v5.0.5 构建的 ids:v1 架构的确切修订版。
关于 IDS v1 API 的其他信息可在 官方文档网站 找到。
特性
从中央 中心 轻松处理以下 资源...
- 项目
- locations endpoints create、locations endpoints delete、locations endpoints get、locations endpoints get iam policy、locations endpoints list、locations endpoints patch、locations endpoints set iam policy、locations endpoints test iam permissions、locations get、locations list、locations operations cancel、locations operations delete、locations operations get 和 locations operations list
本库的结构
API 被组织成以下主要项目
所有结构都带有适用的特性和属性,以便进一步分类并便于浏览。
一般来说,你可以像这样调用活动
let r = hub.resource().activity(...).doit().await
或具体来说...
let r = hub.projects().locations_endpoints_create(...).doit().await
let r = hub.projects().locations_endpoints_delete(...).doit().await
let r = hub.projects().locations_endpoints_patch(...).doit().await
let r = hub.projects().locations_operations_get(...).doit().await
resource()
和activity(...)
调用创建构建器。第二个处理活动
,支持各种方法来配置即将进行的操作(此处未显示)。它设计为所有必需的参数必须立即指定(即(...)
),而所有可选的可以按需(...)
构建。doit()
方法执行与服务器的实际通信并返回相应的结果。
用法
设置您的项目
要使用此库,您需要将以下行放入您的Cargo.toml
文件中
[dependencies]
google-ids1 = "*"
serde = "^1.0"
serde_json = "^1.0"
一个完整的示例
extern crate hyper;
extern crate hyper_rustls;
extern crate google_ids1 as ids1;
use ids1::api::Endpoint;
use ids1::{Result, Error};
use std::default::Default;
use ids1::{IDS, 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 = IDS::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 = Endpoint::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_endpoints_create(req, "parent")
.request_id("magna")
.endpoint_id("no")
.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()
之前修改其调用方式。相应的函数将被调用以提供进度信息,并确定系统在失败时是否应该重试。
代理特质具有默认实现,允许您以最小的努力进行自定义。
服务器请求的可选部分
此库提供的所有结构都旨在通过json进行编码和解码。使用可选值来表示部分请求或响应是有效的。大多数可选值都是被认为是部分,这些部分可以通过名称识别,并将被发送到服务器以指示请求的集合部分或响应中所需的部分。
构建器参数
使用方法构建器,您可以通过反复调用其方法来准备一个动作调用。这些方法总是接受单个参数,以下语句对它适用。
参数将被复制或克隆到构建器中,以使它们与其原始生命周期独立。
Cargo功能
utoipa
- 添加对utoipa的支持,并在所有类型上派生utoipa::ToSchema
。您必须在#[openapi(schemas(...))]
中导入和注册所需类型,否则生成的openapi
规范将是无效的。
许可证
ids1库是由Sebastian Thiel生成的,并置于MIT许可证之下。您可以在存储库的许可证文件中阅读全文。
依赖项
~12–23MB
~346K SLoC