11 个稳定版本 (3 个主要版本)
5.0.5+20240618 | 2024年6月27日 |
---|---|
5.0.4+20240223 | 2024年3月5日 |
5.0.3+20230113 | 2023年8月23日 |
5.0.2+20230113 | 2023年3月16日 |
2.0.4+20210325 | 2021年4月14日 |
#2312 in 网页编程
711 每月下载量
用于 google-eventarc1-cli
610KB
7.5K SLoC
该 google-eventarc1
库允许访问 Google Eventarc 服务的所有功能。
本文档由 Eventarc crate 版本 5.0.5+20240618 生成,其中 20240618 是由 mako 代码生成器 v5.0.5 构建的 eventarc:v1 架构的确切修订版本。
有关 Eventarc v1 API 的其他所有信息,请参阅 官方文档网站。
特性
轻松从中心 枢纽 ...
- 项目
- 创建位置通道连接,删除位置通道连接,获取位置通道连接,获取位置通道连接 IAM 策略,列出位置通道连接,设置位置通道连接 IAM 策略,测试位置通道连接 IAM 权限,创建位置通道,删除位置通道,获取位置通道,获取位置通道 IAM 策略,列出位置通道,更新位置通道,设置位置通道 IAM 策略,测试位置通道 IAM 权限,获取位置,获取位置 Google 通道配置,列出位置,取消位置操作,删除位置操作,获取位置操作,列出位置操作,获取位置提供者,列出位置提供者,创建位置触发器,删除位置触发器,获取位置触发器,获取位置触发器 IAM 策略,列出位置触发器,更新位置触发器,设置位置触发器 IAM 策略,测试位置触发器 IAM 权限 以及 更新位置 Google 通道配置
此库的结构
API 结构如下主要项目
所有 结构 都带有适用的特性,以便进一步分类并简化浏览。
一般来说,您可以像这样调用 活动
let r = hub.resource().activity(...).doit().await
或具体来说...
let r = hub.projects().locations_channel_connections_create(...).doit().await
let r = hub.projects().locations_channel_connections_delete(...).doit().await
let r = hub.projects().locations_channels_create(...).doit().await
let r = hub.projects().locations_channels_delete(...).doit().await
let r = hub.projects().locations_channels_patch(...).doit().await
let r = hub.projects().locations_operations_get(...).doit().await
let r = hub.projects().locations_triggers_create(...).doit().await
let r = hub.projects().locations_triggers_delete(...).doit().await
let r = hub.projects().locations_triggers_patch(...).doit().await
resource()
和 activity(...)
调用创建 构建器。第二个构建器处理 Activities
,支持各种方法来配置即将进行的操作(此处未展示)。它被设计成所有必需的参数都必须立即指定(即 (...)
),而所有可选的参数则可以按需 构建。doit()
方法执行与服务器实际通信,并返回相应的结果。
用法
设置您的项目
要使用此库,您需要将以下行放入您的 Cargo.toml
文件中
[dependencies]
google-eventarc1 = "*"
serde = "^1.0"
serde_json = "^1.0"
一个完整的示例
extern crate hyper;
extern crate hyper_rustls;
extern crate google_eventarc1 as eventarc1;
use eventarc1::api::Trigger;
use eventarc1::{Result, Error};
use std::default::Default;
use eventarc1::{Eventarc, 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 = Eventarc::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 = Trigger::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_triggers_patch(req, "name")
.validate_only(true)
.update_mask(FieldMask::new::<&str>(&[]))
.allow_missing(false)
.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")
。
支持上传的方法可以使用最多两种不同的协议进行上传: 简单 和 可恢复。每种协议的独特性由定制的 doit(...)
方法表示,分别命名为 upload(...)
和 upload_resumable(...)
。
自定义和回调
您可以通过向 方法构建器 提供一个 委托 来更改 doit()
方法的调用方式,在执行最终的 doit()
调用之前。将调用相应的方法以提供进度信息,并确定系统在失败时是否应该重试。
委托特质 默认实现,允许您以最小的努力进行自定义。
服务器请求中的可选部分
此库提供的所有结构都是为了通过 json 进行 编码 和 解码 而设计的。可选部分用于表示部分请求和响应是有效的。大多数可选部分是可识别的 部分,可以通过名称识别,这些部分将被发送到服务器以指示请求的设置部分或响应中期望的部分。
构建器参数
使用 方法构建器,您可以通过重复调用其方法来准备一个操作调用。这些方法始终接受单个参数,以下陈述对此适用。
参数将始终复制或克隆到构建器中,以使其与其原始的生命周期独立。
Cargo 功能
utoipa
- 添加对 utoipa 的支持,并为所有类型派生utoipa::ToSchema
。您必须在#[openapi(schemas(...))]
中导入并注册所需的类型,否则生成的openapi
规范将无效。
许可证
eventarc1 库由 Sebastian Thiel 生成,并置于 MIT 许可证之下。您可以在存储库的 许可证文件 中阅读全文。
依赖关系
~12–23MB
~343K SLoC