#google-cloud #google-api #google #api #protocols #web-api #cloudmonitoring

google-cloudmonitoring2_beta2

一个完整的库,用于与Cloud Monitoring(协议v2beta2)交互

46个版本 (27个稳定版)

5.0.5+20170501 2024年6月27日
5.0.4+20170501 2024年3月5日
5.0.3+20170501 2023年8月23日
5.0.2+20170501 2023年3月16日
0.1.2+20150305 2015年3月25日

#2859 in Web编程

Download history 5/week @ 2024-05-19 1/week @ 2024-05-26 2/week @ 2024-06-09 1/week @ 2024-06-16 85/week @ 2024-06-23 45/week @ 2024-06-30

2,711 每月下载量
用于 google-cloudmonitoring2_b…

MIT 许可证

215KB
2.5K SLoC

google-cloudmonitoring2_beta2 库允许访问Google Cloud Monitoring服务的所有功能。

本文档由Cloud Monitoring crate版本 5.0.5+20170501 生成,其中 20170501 是由 mako 代码生成器 v5.0.5 构建的 cloudmonitoring:v2beta2 模式的确切修订版。

有关Cloud Monitoring v2_beta2 API的其他信息,请参阅官方文档网站

特性

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

本库的结构

API结构如下几个主要项目

  • 枢纽
  • 资源
    • 可以应用 活动 的主要类型
    • 一组属性和 部分
    • 部分
      • 一组属性
      • 永远不会直接用于 活动
  • 活动
    • 应用于 资源 的操作

所有结构都被标记上适用的特征,以便进一步分类并简化浏览。

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

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

或者具体...

let r = hub.metric_descriptors().create(...).doit().await
let r = hub.metric_descriptors().delete(...).doit().await
let r = hub.metric_descriptors().list(...).doit().await

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

用法

设置你的项目

要使用这个库,你需要在你的Cargo.toml文件中放入以下行

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

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_cloudmonitoring2_beta2 as cloudmonitoring2_beta2;
use cloudmonitoring2_beta2::api::ListMetricDescriptorsRequest;
use cloudmonitoring2_beta2::{Result, Error};
use std::default::Default;
use cloudmonitoring2_beta2::{CloudMonitoring, 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 = CloudMonitoring::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 = ListMetricDescriptorsRequest::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.metric_descriptors().list(req, "project")
             .query("magna")
             .page_token("no")
             .count(-55)
             .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")

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

自定义和回调

你可以通过在调用最后的doit()之前提供一个代理方法构建器来更改doit()方法的调用方式。相应的方法将被调用以提供进度信息,并确定系统是否在失败时应该重试。

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

服务器请求中的可选部分

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

构建器参数

通过使用方法构建器,您可以通过重复调用其方法来准备操作调用。这些方法始终接受单个参数,以下陈述对此参数有效。

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

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

Cargo功能

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

许可证

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

依赖关系

~12–23MB
~343K SLoC