#google #protocols #google-api #access-approval #web #web-api

google-accessapproval1

一个与访问批准(协议 v1)交互的完整库

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

5.0.5+20240621 2024 年 6 月 27 日
5.0.4+20240223 2024 年 3 月 5 日
5.0.3+20230120 2023 年 8 月 23 日
5.0.2+20230120 2023 年 3 月 16 日
1.0.14+20200708 2020 年 7 月 10 日

#2408 in 网页编程

Download history 5/week @ 2024-05-19 1/week @ 2024-05-26 1/week @ 2024-06-09 1/week @ 2024-06-16 86/week @ 2024-06-23 64/week @ 2024-06-30

771 每月下载量
用于 google-accessapproval1-cl…

MIT 许可证

495KB
6K SLoC

google-accessapproval1 库允许访问 Google Access Approval 服务(协议 v1)的所有功能。

本文档由 Access Approval crate 版本 5.0.5+20240621 生成,其中 20240621 是由 mako 代码生成器 v5.0.5 构建的 accessapproval:v1 架构的确切修订版本。

有关 Access Approval v1 API 的其他所有信息,请参阅 官方文档网站

功能

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

本库的结构

API 被组织成以下主要项目

  • 中心
  • 资源
    • 你可以将 活动 应用到的主体类型
    • 一组属性和 部分
    • 部分
      • 一组属性
      • 永远不会直接用于 活动
  • 活动
    • 应用于 资源 的操作

所有 结构 都带有相应的特质,以便进一步分类和便于浏览。

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

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

或者更具体地说 ...

let r = hub.folders().approval_requests_approve(...).doit().await
let r = hub.folders().approval_requests_dismiss(...).doit().await
let r = hub.folders().approval_requests_get(...).doit().await
let r = hub.folders().approval_requests_invalidate(...).doit().await
let r = hub.organizations().approval_requests_approve(...).doit().await
let r = hub.organizations().approval_requests_dismiss(...).doit().await
let r = hub.organizations().approval_requests_get(...).doit().await
let r = hub.organizations().approval_requests_invalidate(...).doit().await
let r = hub.projects().approval_requests_approve(...).doit().await
let r = hub.projects().approval_requests_dismiss(...).doit().await
let r = hub.projects().approval_requests_get(...).doit().await
let r = hub.projects().approval_requests_invalidate(...).doit().await

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

使用方法

设置您的项目

要使用这个库,您需要将以下几行代码放入您的 Cargo.toml 文件中

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

完整示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_accessapproval1 as accessapproval1;
use accessapproval1::api::ApproveApprovalRequestMessage;
use accessapproval1::{Result, Error};
use std::default::Default;
use accessapproval1::{AccessApproval, 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 = AccessApproval::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 = ApproveApprovalRequestMessage::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.folders().approval_requests_approve(req, "name")
             .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")

支持上传的方法可以使用最多两种协议进行上传: 简单可恢复。每种方法的独特性都由定制的 doit(...) 方法表示,分别命名为 upload(...)upload_resumable(...)

自定义和回调

您可以通过向 Method Builder 提供一个 delegate 来更改 doit() 方法的调用方式,在最终调用 doit() 之前。相应的方法将被调用以提供进度信息,并确定系统在失败时是否应该重试。

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

服务器请求中的可选部分

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

构建器参数

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

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

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

Cargo 功能

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

许可证

accessapproval1 库由 Sebastian Thiel 创建,并置于 MIT 许可证之下。您可以在仓库的 许可证文件 中阅读全文。

依赖关系

~12–23MB
~346K SLoC