30 个稳定版本 (5 个主要版本)
5.0.5+20240623 | 2024 年 6 月 27 日 |
---|---|
5.0.4+20240225 | 2024 年 3 月 5 日 |
5.0.3+20230115 | 2023 年 8 月 24 日 |
5.0.2+20230115 | 2023 年 3 月 16 日 |
0.1.14+20160321 | 2016 年 7 月 17 日 |
#2384 in Web 编程
每月 157 次下载
用于 google-monitoring3-cli
1MB
12K SLoC
google-monitoring3
库允许访问 Google Monitoring 服务的所有功能。
本文档由 Monitoring crate 版本 5.0.5+20240623 生成,其中 20240623 是由 mako 代码生成器 v5.0.5 构建的 monitoring:v3 架构的精确修订。
有关 Monitoring v3 API 的其他信息,请参阅 官方文档网站。
特性
从中央 枢纽 轻松处理以下 资源 ...
- 文件夹
- 时间序列列表
- 组织
- 时间序列列表
- 项目
- alert policies create, alert policies delete, alert policies get, alert policies list, alert policies patch, collectd time series create, groups create, groups delete, groups get, groups list, groups members list, groups update, metric descriptors create, metric descriptors delete, metric descriptors get, metric descriptors list, monitored resource descriptors get, monitored resource descriptors list, notification channel descriptors get, notification channel descriptors list, notification channels create, notification channels delete, notification channels get, notification channels get verification code, notification channels list, notification channels patch, notification channels send verification code, notification channels verify, snoozes create, snoozes get, snoozes list, snoozes patch, time series create, time series create service, time series list, time series query, uptime check configs create, uptime check configs delete, uptime check configs get, uptime check configs list and uptime check configs patch
- 服务
- 创建、删除、获取、列出、修补、创建服务级别目标、删除服务级别目标、获取服务级别目标、列出服务级别目标 和 修补服务级别目标
- uptime 检查 IP
- 列表
本库结构
API 结构如下
所有结构都标有适用的特性和,以便进一步分类并便于浏览。
一般来说,你可以这样调用活动
let r = hub.resource().activity(...).doit().await
或者具体...
let r = hub.services().service_level_objectives_create(...).doit().await
let r = hub.services().service_level_objectives_delete(...).doit().await
let r = hub.services().service_level_objectives_get(...).doit().await
let r = hub.services().service_level_objectives_list(...).doit().await
let r = hub.services().service_level_objectives_patch(...).doit().await
let r = hub.services().create(...).doit().await
let r = hub.services().delete(...).doit().await
let r = hub.services().get(...).doit().await
let r = hub.services().list(...).doit().await
let r = hub.services().patch(...).doit().await
resource()
和activity(...)
调用创建构建器。第二个处理活动
,支持各种方法来配置即将进行的操作(此处未显示)。它被设计成所有必需的参数必须立即指定(即(...)
),而所有可选的都可以按需构建。doit()
方法执行与服务器实际的通信并返回相应的结果。
用法
设置你的项目
要使用此库,您需要将以下行放入您的Cargo.toml
文件
[dependencies]
google-monitoring3 = "*"
serde = "^1.0"
serde_json = "^1.0"
一个完整的示例
extern crate hyper;
extern crate hyper_rustls;
extern crate google_monitoring3 as monitoring3;
use monitoring3::{Result, Error};
use std::default::Default;
use monitoring3::{Monitoring, 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 = Monitoring::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.services().service_level_objectives_list("parent")
.view("magna")
.page_token("no")
.page_size(-55)
.filter("voluptua.")
.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")
。
支持上传的方法可以使用最多2种不同的协议进行上传:简单和可恢复。每种的独特性由定制的doit(...)
方法表示,分别命名为upload(...)
和upload_resumable(...)
。
自定义和回调
您可以通过向 Delegate 提供代理,在执行最终的 doit()
调用之前,更改 doit()
方法的调用方式。相应的函数将被调用以提供进度信息,并确定系统是否在失败时应该重试。
delegate trait 默认实现,让您可以以最小的努力对其进行自定义。
服务器请求中的可选部分
此库提供的所有结构都旨在通过 json 进行 编码 和 解码。可选项用于表示部分请求或响应是有效的。大多数可选项被视为 Parts,这些部分可以通过名称识别,并将发送到服务器以指示请求的设置部分或响应中所需的部分。
构建器参数
使用 方法构建器,您可以通过反复调用其方法来准备一个操作调用。这些方法将始终接受单个参数,以下陈述对此适用。
- PODs 通过复制传递
- 字符串作为
&str
传递 - request values 被移动
参数将始终复制或克隆到构建器中,以使它们与其原始生命周期独立。
Cargo 功能
utoipa
- 添加对 utoipa 的支持,并在所有类型上派生utoipa::ToSchema
。您必须在#[openapi(schemas(...))]
中导入和注册所需的类型,否则生成的openapi
规范将是无效的。
许可协议
monitoring3 库由 Sebastian Thiel 创建,并置于 MIT 许可协议下。您可以在存储库的 许可文件 中阅读全文。
依赖关系
~12–23MB
~345K SLoC