#google-service #google-api #google #protocols #web-api #api #api-access

google-servicebroker1

一个完整的库,用于与服务代理(协议v1)交互

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

5.0.5+20190624 2024年6月27日
5.0.4+20190624 2024年3月5日
5.0.3+20190624 2023年8月24日
5.0.2+20190624 2023年3月17日
1.0.8+20180924 2018年10月14日

#5 in #api-access

每月50次下载
用于 google-servicebroker1-cli

MIT 许可证

140KB
2K SLoC

google-servicebroker1 库允许访问 Google 服务代理服务的所有功能。

本文档是从 Service Broker crate 版本 5.0.5+20190624 生成的,其中 20190624 是由 mako 代码生成器 v5.0.5 构建的 servicebroker:v1 模式的确切修订版。

有关 Service Broker v1 API 的其他信息,请参阅 官方文档网站

特性

从中心 枢纽 简单地使用以下功能 ...

本库的结构

API 结构为以下主要项目

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

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

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

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

或者具体地 ...

let r = hub.methods().get_iam_policy(...).doit().await
let r = hub.methods().set_iam_policy(...).doit().await

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

用法

设置项目

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

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

完整示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_servicebroker1 as servicebroker1;
use servicebroker1::api::GoogleIamV1__SetIamPolicyRequest;
use servicebroker1::{Result, Error};
use std::default::Default;
use servicebroker1::{ServiceBroker, 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 = ServiceBroker::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 = GoogleIamV1__SetIamPolicyRequest::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.methods().set_iam_policy(req, "resource")
             .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枚举提供,或者作为中间结果传递给Hub DelegateAuthenticator Delegate

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

上传和下载

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

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

自定义和回调

您可以通过向doit方法提供委托来更改其调用方式,在最终调用doit之前将委托传递给Method Builder。相应的会调用提供进度信息,以及确定系统在失败时是否应该重试。

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

服务器请求中的可选部分

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

构建器参数

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

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

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

Cargo功能

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

许可证

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

依赖关系

~12-23MB
~342K SLoC