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

5.0.5+20240624 2024年6月27日
5.0.4+20240219 2024年3月5日
5.0.3+20230123 2023年8月23日
5.0.2+20230123 2023年3月16日
1.0.8+20181008 2018年10月14日

#2304 in 网页编程

Download history 648/week @ 2024-04-27 645/week @ 2024-05-04 1411/week @ 2024-05-11 1014/week @ 2024-05-18 612/week @ 2024-05-25 1056/week @ 2024-06-01 681/week @ 2024-06-08 1057/week @ 2024-06-15 1624/week @ 2024-06-22 328/week @ 2024-06-29 456/week @ 2024-07-06 300/week @ 2024-07-13 281/week @ 2024-07-20 360/week @ 2024-07-27 367/week @ 2024-08-03 300/week @ 2024-08-10

1,360 每月下载量
用于 2 crates

MIT 许可证

155KB
2K SLoC

google-cloudprofiler2 库允许访问 Google Cloud Profiler 服务中的所有功能。

此文档是根据 Cloud Profiler crate 版本 5.0.5+20240624 生成的,其中 20240624 是由 mako 代码生成器 v5.0.5 构建的 cloudprofiler:v2 架构的确切修订版本。

有关 Cloud Profiler v2 API 的其他所有信息,请参阅 官方文档网站

功能

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

此库的结构

API 被组织成以下主要项目

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

所有 结构 都带有适用的特性和说明,以便进一步分类并便于浏览。

通常,您可以像这样调用 活动

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

或具体来说 ...

let r = hub.projects().profiles_create(...).doit().await
let r = hub.projects().profiles_create_offline(...).doit().await
let r = hub.projects().profiles_patch(...).doit().await

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

用法

设置你的项目

要使用此库,您需要将以下行放入您的 Cargo.toml 文件中

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

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_cloudprofiler2 as cloudprofiler2;
use cloudprofiler2::api::Profile;
use cloudprofiler2::{Result, Error};
use std::default::Default;
use cloudprofiler2::{CloudProfiler, 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 = CloudProfiler::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 = Profile::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().profiles_patch(req, "name")
             .update_mask(FieldMask::new::<&str>(&[]))
             .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() 调用之前向 Method Builder 提供一个 delegate 来修改 doit() 方法的调用方式。相应的方会调用以提供进度信息,并确定系统是否应在失败时重试。

默认实现了 delegate trait,允许您以最小的努力对其进行自定义。

服务器请求中的可选部分

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

构建器参数

通过使用方法构建器,您可以多次调用其方法来准备一个动作调用。这些方法始终只接受一个参数,以下陈述适用于该参数。

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

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

Cargo功能

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

许可证

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

依赖关系

~12–23MB
~346K SLoC