9 个稳定版本 (3 个主要版本)

5.0.3+20230106 2023 年 8 月 23 日
5.0.2+20230106 2023 年 3 月 16 日
5.0.2-beta-1+202301062023 年 1 月 25 日
4.0.1+20220211 2022 年 9 月 14 日
2.0.4+20210322 2021 年 4 月 15 日

#2746 in 网页编程

Download history 88/week @ 2024-03-31 2/week @ 2024-04-07

180 每月下载量
google-gkehub1-cli 中使用

MIT 许可证

515KB
6K SLoC

“google-gkehub1” 库允许访问 Google GKE Hub 服务(协议 v1)的所有功能。

本文档是从 GKE Hub 包版本 5.0.3+20230106 生成的,其中 20230106 是由 mako 代码生成器 v5.0.3 构建的 gkehub:v1 架构的确切修订。

有关 GKE Hub v1 API 的其他所有信息可以在 官方文档网站 找到。

功能

轻松从中央 hub ...

库的结构

API 结构如下主要项

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

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

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

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

或具体...

let r = hub.projects().locations_features_create(...).doit().await
let r = hub.projects().locations_features_delete(...).doit().await
let r = hub.projects().locations_features_patch(...).doit().await
let r = hub.projects().locations_memberships_create(...).doit().await
let r = hub.projects().locations_memberships_delete(...).doit().await
let r = hub.projects().locations_memberships_patch(...).doit().await
let r = hub.projects().locations_operations_get(...).doit().await

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

用法

设置你的项目

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

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

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_gkehub1 as gkehub1;
use gkehub1::api::Feature;
use gkehub1::{Result, Error};
use std::default::Default;
use gkehub1::{GKEHub, 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 = GKEHub::new(hyper::Client::builder().build(hyper_rustls::HttpsConnectorBuilder::new().with_native_roots().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 = Feature::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().locations_features_create(req, "parent")
             .request_id("magna")
             .feature_id("no")
             .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()之前向Method Builder提供一个delegate来改变调用doit()方法的方式。相应的函数将被调用以提供进度信息,并确定系统在失败时应否重试。

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

服务器请求中的可选部分

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

构建器参数

通过使用方法构建器,您可以通过重复调用其方法来准备一个操作调用。这些方法总是接受一个参数,以下陈述适用于该参数。

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

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

许可证

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

依赖项

~17–31MB
~548K SLoC