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

google-accesscontextmanager1

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

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

5.0.5+20240623 2024年6月27日
5.0.4+20240226 2024年3月5日
5.0.3+20230123 2023年8月23日
5.0.2+20230123 2023年3月16日
1.0.10+20190626 2019年7月6日

2753网页编程 中排名

Download history 5/week @ 2024-05-19 1/week @ 2024-05-26 1/week @ 2024-06-09 84/week @ 2024-06-23 8/week @ 2024-06-30

1,001 每月下载量
google-accesscontextmanag… 中使用

MIT 许可证

725KB
8K SLoC

google-accesscontextmanager1 库允许访问 Google 访问上下文管理器服务的所有功能。

此文档是从版本 5.0.5+20240623Access Context Manager crate 生成的,其中 20240623 是由 mako 代码生成器 v5.0.5 构建的 accesscontextmanager:v1 方案的精确修订。

有关 Access Context Manager v1 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().access_levels_replace_all(...).doit().await
let r = hub.access_policies().authorized_orgs_descs_create(...).doit().await
let r = hub.access_policies().authorized_orgs_descs_delete(...).doit().await
let r = hub.access_policies().authorized_orgs_descs_patch(...).doit().await
let r = hub.access_policies().service_perimeters_commit(...).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().service_perimeters_replace_all(...).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().cancel(...).doit().await
let r = hub.operations().delete(...).doit().await
let r = hub.operations().get(...).doit().await
let r = hub.operations().list(...).doit().await
let r = hub.organizations().gcp_user_access_bindings_create(...).doit().await
let r = hub.organizations().gcp_user_access_bindings_delete(...).doit().await
let r = hub.organizations().gcp_user_access_bindings_patch(...).doit().await

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

用法

设置你的项目

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

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

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_accesscontextmanager1 as accesscontextmanager1;
use accesscontextmanager1::{Result, Error};
use std::default::Default;
use accesscontextmanager1::{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);
// 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.operations().list("name")
             .page_token("magna")
             .page_size(-11)
             .filter("ipsum")
             .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 Delegate,或者 Authenticator Delegate

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

上传和下载

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

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

自定义和回调

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

代理特性行为默认实现,允许您以最小努力进行自定义。

服务器请求中的可选部分

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

构建器参数

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

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

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

Cargo功能

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

许可证

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

依赖项

~12–23MB
~346K SLoC