12 个版本
使用旧的 Rust 2015
0.1.11+20150419 | 2016年1月30日 |
---|---|
0.1.10+20150419 | 2015年12月6日 |
0.1.9+20150419 | 2015年8月8日 |
0.1.8+20150419 | 2015年6月19日 |
0.1.2+20130108 | 2015年3月25日 |
在 #audit 中排名第 13
48KB
523 行
“google-audit1”库允许访问 Google 审计服务(协议版本 v1)的所有功能。
本文档由 audit crate 版本 0.1.11+20150419 生成,其中 20150419 是由 mako 代码生成器 v0.1.11 构建的 audit:v1 架构的精确版本。
有关审计 v1 API 的其他所有信息,请参阅 官方文档网站。
功能
轻松从中心 枢纽 处理以下 资源...
本库的结构
API 结构如下
所有 结构 都标记了相应的特性,以进一步分类它们并简化浏览。
一般来说,您可以通过以下方式调用 活动
let r = hub.resource().activity(...).doit()
或具体地...
let r = hub.activities().list(...).doit()
资源(resource()
)和活动(activity(...)
)调用创建构建器。第二个处理Activities
的调用支持配置即将进行的操作的各种方法(此处未显示)。它是这样设计的,即必须立即指定所有必需的参数(即(...)
),而所有可选的都可以按照所需的方式构建。doit()
方法执行与服务器的实际通信,并返回相应的结果。
用法
设置您的项目
要使用此库,您需要将以下行放入您的Cargo.toml
文件中
[dependencies]
google-audit1 = "*"
一个完整的示例
extern crate hyper;
extern crate yup_oauth2 as oauth2;
extern crate google_audit1 as audit1;
use audit1::{Result, Error};
use std::default::Default;
use oauth2::{Authenticator, DefaultAuthenticatorDelegate, ApplicationSecret, MemoryStorage};
use audit1::Audit;
// Get an ApplicationSecret instance by some means. It contains the `client_id` and
// `client_secret`, among other things.
let secret: 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 = Authenticator::new(&secret, DefaultAuthenticatorDelegate,
hyper::Client::new(),
<MemoryStorage as Default>::default(), None);
let mut hub = Audit::new(hyper::Client::new(), 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.activities().list("customerId", "applicationId")
.start_time("Stet")
.max_results(-42)
.event_name("et")
.end_time("dolores")
.continuation_token("kasd")
.caller("accusam")
.actor_ip_address("takimata")
.actor_email("justo")
.actor_application_id("amet.")
.doit();
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::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(...)
。
定制和回调
您可以通过向Method Builder提供代理来改变调用doit()
方法的方式,在最终调用doit()
之前。将调用相应的方法来提供进度信息,以及确定系统在失败时应否重试。
委托特质(delegate trait)默认实现,让您可以以最小的努力进行自定义。
服务器请求中的可选部分
本库提供的所有结构都是为了通过 json 进行 编码 和 解码 而设计的。可选部分用于表示部分请求或响应是有效的。大多数可选部分被视为 Parts,这些部分可以通过名称识别,并将发送到服务器以指示请求的设置部分或响应中期望的部分。
构建器参数
使用 方法构建器,您可以通过重复调用其方法来准备一个操作调用。这些方法始终接受单个参数,以下陈述对它成立。
参数将始终复制或克隆到构建器中,以使它们与其原始生命周期独立。
许可证
audit1 库由 Sebastian Thiel 创建,并置于 MIT 许可证之下。您可以在存储库的 许可证文件 中阅读全文。
依赖项
~14–27MB
~406K SLoC