#google #protocols #google-api #web #binaryauthorization #web-api #api

google-binaryauthorization1

与 Binary Authorization (协议 v1) 交互的完整库

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

5.0.3+20230113 2023 年 8 月 23 日
5.0.2+20230113 2023 年 3 月 16 日
5.0.2-beta-1+202301132023 年 1 月 25 日
4.0.1+20220225 2022 年 9 月 14 日
1.0.14+20200619 2020 年 7 月 10 日

#2766 in 网页编程

Download history 1/week @ 2024-03-07 2/week @ 2024-03-14 57/week @ 2024-03-28 42/week @ 2024-04-04

每月 181 次下载
google-binaryauthorizatio… 中使用

MIT 许可证

335KB
4K SLoC

google-binaryauthorization1 库允许访问 Google Binary Authorization 服务的所有功能。

此文档由 Binary Authorization 库版本 5.0.3+20230113 生成,其中 20230113 是由 mako 代码生成器 v5.0.3 构建的 binaryauthorization:v1 架构的确切修订版。

关于 Binary Authorization v1 API 的其他信息可以在 官方文档站点 找到。

功能

从中心 枢纽 ...

该库的结构

API 结构如下主要项目

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

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

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

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

或者具体...

let r = hub.projects().attestors_get_iam_policy(...).doit().await
let r = hub.projects().attestors_set_iam_policy(...).doit().await
let r = hub.projects().policy_get_iam_policy(...).doit().await
let r = hub.projects().policy_set_iam_policy(...).doit().await

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

使用方法

设置您的项目

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

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

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_binaryauthorization1 as binaryauthorization1;
use binaryauthorization1::{Result, Error};
use std::default::Default;
use binaryauthorization1::{BinaryAuthorization, 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 = BinaryAuthorization::new(hyper::Client::builder().build(hyper_rustls::HttpsConnectorBuilder::new().with_native_roots().https_or_http().enable_http1().build()), auth);
// 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().attestors_get_iam_policy("resource")
             .options_requested_policy_version(-33)
             .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)提供代理来更改调用doit()方法的方式。相应的方法将被调用来提供进度信息,以及确定系统在失败时是否应重试。

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

服务器请求中的可选部分

此库提供的所有结构都旨在通过json进行encodabledecodable。可选项用于表示部分请求或响应是有效的。大多数可选项都是被视为Parts,它们可以通过名称识别,这些名称将被发送到服务器,以指示请求的设置部分或响应中希望包含的部分。

构建器参数

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

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

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

许可证

binaryauthorization1 库由 Sebastian Thiel 创建,并置于 MIT 许可证之下。您可以在存储库的 许可证文件 中阅读完整内容。

依赖关系

~17–29MB
~539K SLoC