#google #protocols #google-api #access-context-manager #web #web-api #api

google-accesscontextmanager1_beta

与访问上下文管理器(协议 v1beta)交互的完整库

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

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

#2379 in 网页编程

Download history 4/week @ 2024-05-21 1/week @ 2024-06-11 88/week @ 2024-06-25 62/week @ 2024-07-02

1,122 每月下载量
用于 google-accesscontextmanag…

MIT 许可证

340KB
4K SLoC

google-accesscontextmanager1_beta 库允许访问 Google Access Context Manager 服务的所有功能。

本文档是从 Access Context Manager 库版本 5.0.5+20230123 生成的,其中 20230123 是由 mako 代码生成器 v5.0.5 构建的 accesscontextmanager:v1beta 架构的确切修订。

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

功能

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

库的结构

API 结构如下主要项

  • 中心
  • 资源
    • 可以应用于 活动 的主要类型
    • 属性和 部分 的集合
    • 部分
      • 属性集合
      • 永远不会在 活动 中直接使用
  • 活动
    • 应用于 资源 的操作

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

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

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

或者具体...

let r = hub.access_policies().access_levels_create(...).doit().await
let r = hub.access_policies().access_levels_delete(...).doit().await
let r = hub.access_policies().access_levels_patch(...).doit().await
let r = hub.access_policies().service_perimeters_create(...).doit().await
let r = hub.access_policies().service_perimeters_delete(...).doit().await
let r = hub.access_policies().service_perimeters_patch(...).doit().await
let r = hub.access_policies().create(...).doit().await
let r = hub.access_policies().delete(...).doit().await
let r = hub.access_policies().patch(...).doit().await
let r = hub.operations().get(...).doit().await

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

用法

设置您的项目

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

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

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_accesscontextmanager1_beta as accesscontextmanager1_beta;
use accesscontextmanager1_beta::api::AccessLevel;
use accesscontextmanager1_beta::{Result, Error};
use std::default::Default;
use accesscontextmanager1_beta::{AccessContextManager, 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 = AccessContextManager::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 = AccessLevel::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.access_policies().access_levels_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 DelegateAuthenticator Delegate

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

上传和下载

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

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

定制和回调

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

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

服务器请求中的可选部分

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

构建器参数

通过使用 method builders,您可以通过重复调用它的方法来准备一个动作调用。这些方法始终接受单个参数,以下陈述对于该参数是真实的。

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

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

Cargo 功能

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

许可证

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

依赖关系

~12–22MB
~342K SLoC