#logging #google #protocols #google-api

google-logging2_beta1

一个完整的库,用于与日志(协议 v2beta1)交互

30 个稳定版本 (5 个主要)

5.0.5+20190325 2024年6月27日
5.0.4+20190325 2024年3月5日
5.0.3+20190325 2023年8月24日
5.0.2+20190325 2023年3月16日
0.1.9+20151007 2015年10月19日

#2458 in 网络编程


用于 google-logging2_beta1-cli

MIT 许可证

325KB
4K SLoC

《google-logging2_beta1》库允许访问Google日志服务(协议v2beta1)的所有功能。

有关《日志》(v2_beta1) API的其他所有信息,请参阅官方文档网站

功能

从中心 枢纽 ...

处理以下 资源...

本库的结构

API 结构为以下主要项目

  • 枢纽
    • 一个中心对象,用于维护状态并允许访问所有 活动
    • 创建 方法构建器,这些构建器反过来允许访问单个 调用构建器
  • 资源
    • 可以应用于 活动 的主要类型
    • 一组属性和 部分
    • 部分
      • 一组属性
      • 活动 中从不直接使用
  • 活动
    • 应用于 资源 的操作

所有 结构 都带有可用的特性,以进一步分类它们并简化浏览。

一般来说,你可以这样调用 活动

let r = hub.resource().activity(...).doit().await

或者具体地说 ...

let r = hub.projects().metrics_create(...).doit().await
let r = hub.projects().metrics_get(...).doit().await
let r = hub.projects().metrics_update(...).doit().await

resource()activity(...) 调用创建 构建器。第二个构建器处理 活动,支持各种方法来配置即将进行的操作(此处未显示)。它被设计成必须立即指定所有必需的参数(即 (...)),而所有可选的参数都可以按需 构建doit() 方法执行与服务器实际通信并返回相应的结果。

用法

设置您的项目

要使用此库,您需要在您的 Cargo.toml 文件中添加以下行

[dependencies]
google-logging2_beta1 = "*"
serde = "^1.0"
serde_json = "^1.0"

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_logging2_beta1 as logging2_beta1;
use logging2_beta1::api::LogMetric;
use logging2_beta1::{Result, Error};
use std::default::Default;
use logging2_beta1::{Logging, 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 = Logging::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 = LogMetric::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().metrics_create(req, "parent")
             .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 DelegateAuthenticator Delegate

当代理处理错误或中间值时,它们可能有机会指示系统重试。这使得系统可能对所有类型的错误都具有弹性。

上传和下载

如果方法支持下载,则响应体(作为 Result 的一部分)应由您读取以获取媒体。如果此类方法还支持 Response Result,则默认情况下将返回该结果。您可以将它视为实际媒体的数据。要触发媒体下载,您必须通过此调用设置构建器:.param("alt", "media")

支持上传的方法可以使用最多两种协议进行上传:简单可恢复。每种协议的独特性通过定制的doit(...)方法来表示,这些方法分别命名为upload(...)upload_resumable(...)

定制和回调

您可以通过向doit()调用提供代理方法构建器来更改doit()的调用方式。相应的函数将被调用以提供进度信息,以及确定系统在失败时是否应该重试。

默认实现了代理特质,允许您以最小的努力进行定制。

服务器请求中的可选部分

此库提供的所有结构都设计为可以通过json进行编码解码。使用可选类型来表示部分请求或响应是有效的。大多数可选类型都是被认为部分,这些部分可以通过名称识别,将被发送到服务器以指示请求的设置部分或响应中期望的部分。

构建器参数

使用方法构建器,您可以通过反复调用其方法来准备一个操作调用。这些方法始终接受单个参数,以下语句是正确的。

  • PODs通过复制传递
  • 字符串作为&str传递
  • 请求值被移动

参数将始终被复制或克隆到构建器中,以使它们与其原始生命周期独立。

Cargo功能

  • utoipa - 添加对utoipa的支持,并在所有类型上派生utoipa::ToSchema。您必须在#[openapi(schemas(...))]中导入和注册所需类型,否则生成的openapi规范将无效。

许可证

名为logging2_beta1的库由Sebastian Thiel生成,并置于MIT许可证下。您可以在存储库的许可证文件中阅读全文。

依赖关系

~12–23MB
~345K SLoC