#google #google-api #web-api #protocols #api #web #clouderrorreporting

google-clouderrorreporting1_beta1

一个完整的库,用于与 Clouderrorreporting(协议 v1beta1)交互

19 个稳定版本 (4 个主要版本)

5.0.5+20240621 2024年6月27日
5.0.4+20240221 2024年3月5日
5.0.3+20230112 2023年8月23日
5.0.2+20230112 2023年3月16日
1.0.7+20171201 2018年2月1日

网页开发 中排名第 2500

Download history 58/week @ 2024-06-21 37/week @ 2024-06-28 66/week @ 2024-07-05

每月下载量 1,145
用于 google-clouderrorreportin…

MIT 许可证

205KB
2.5K SLoC

google-clouderrorreporting1_beta1 库允许访问 Google Clouderrorreporting 服务(协议 v1beta1)的所有功能。

本文档是根据 Clouderrorreporting crate 版本 5.0.5+20240621 生成的,其中 20240621 是由 mako 代码生成器 v5.0.5 构建的 clouderrorreporting:v1beta1 架构的确切修订版。

有关 Clouderrorreporting v1_beta1 API 的其他信息,请参阅 官方文档网站

功能

轻松从中心 枢纽 处处理以下 资源...

本库的结构

API 结构如下主要项

  • 枢纽
  • 资源
    • 你可以应用 活动 的主要类型
    • 一组属性和 部件
    • 部件
      • 一组属性
      • 活动 中从未直接使用
  • 活动
    • 应用于 资源 的操作

所有 结构 都带有适用的属性,以便进一步分类并简化浏览。

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

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

或者具体来说 ...

let r = hub.projects().groups_get(...).doit().await
let r = hub.projects().groups_update(...).doit().await

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

使用方法

设置你的项目

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

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

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_clouderrorreporting1_beta1 as clouderrorreporting1_beta1;
use clouderrorreporting1_beta1::api::ErrorGroup;
use clouderrorreporting1_beta1::{Result, Error};
use std::default::Default;
use clouderrorreporting1_beta1::{Clouderrorreporting, 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 = Clouderrorreporting::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 = ErrorGroup::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().groups_update(req, "name")
             .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")

支持上传的方法可以使用最多 2 种不同的协议:简单可恢复。每种协议的独特性由定制的 doit(...) 方法表示,分别命名为 upload(...)upload_resumable(...)

定制和回调

您可以通过为委托提供方法构建器来修改调用 doit() 方法的方式,在执行最终的 doit() 调用之前。将调用相应的方法以提供进度信息,以及确定系统在失败时是否应该重试。

默认实现了 委托特质,允许您以最小的努力进行自定义。

服务器请求中的可选部分

此库提供的所有结构都旨在通过 json 进行 编码解码。可选部分用于表示部分请求或响应是有效的。大多数可选部分都是可识别的 部分,它们可以通过名称识别,将被发送到服务器以指示请求或响应中所需的设置部分。

构建器参数

通过使用 方法构建器,您可以通过重复调用其方法来准备操作调用。这些方法始终接受单个参数,以下语句为真。

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

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

Cargo 特性

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

许可证

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

依赖关系

~12–23MB
~343K SLoC