#web-api #google-api #protocols #google #api #web #chromepolicy

google-chromepolicy1

用于与 Chrome 政策协议(版本 v1)交互的完整库

11 个稳定版本 (3 个主要版本)

5.0.5+20240625 2024年6月27日
5.0.4+20240303 2024年3月5日
5.0.3+20230123 2023年8月23日
5.0.2+20230123 2023年3月16日
2.0.4+20210329 2021年4月14日

网页开发 中排名第 2877

Download history 4/week @ 2024-05-19 1/week @ 2024-06-09 85/week @ 2024-06-23 45/week @ 2024-06-30

每月下载量 707
用于 google-chromepolicy1-cli

MIT 许可证

355KB
4.5K SLoC

google-chromepolicy1 库允许访问 Google Chrome Policy 服务的所有功能。

此文档是从 Chrome Policy 库版本 5.0.5+20240625 生成的,其中 20240625 是由 mako 代码生成器 v5.0.5 构建的 chromepolicy:v1 架构的确切版本。

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

功能

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

由...支持的上传

库结构

API结构如下主要项

  • 中心
  • 资源
    • 你可以将其应用于活动的主要类型
    • 属性和部分的集合
    • 部分
      • 属性的集合
      • 从不直接用于活动
  • 活动
    • 应用于资源的操作

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

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

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

或者具体...

let r = hub.customers().policies_groups_batch_delete(...).doit().await
let r = hub.customers().policies_groups_batch_modify(...).doit().await
let r = hub.customers().policies_groups_update_group_priority_ordering(...).doit().await
let r = hub.customers().policies_orgunits_batch_inherit(...).doit().await
let r = hub.customers().policies_orgunits_batch_modify(...).doit().await

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

用法

设置你的项目

要使用这个库,你需要在你的Cargo.toml文件中添加以下行

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

一个完整的例子

extern crate hyper;
extern crate hyper_rustls;
extern crate google_chromepolicy1 as chromepolicy1;
use chromepolicy1::api::GoogleChromePolicyVersionsV1BatchDeleteGroupPoliciesRequest;
use chromepolicy1::{Result, Error};
use std::default::Default;
use chromepolicy1::{ChromePolicy, 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 = ChromePolicy::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 = GoogleChromePolicyVersionsV1BatchDeleteGroupPoliciesRequest::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.customers().policies_groups_batch_delete(req, "customer")
             .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),
}

处理错误

系统产生的所有错误都通过结果枚举作为doit()方法的返回值提供,或者作为可能的中途结果传递给Hub代理认证代理

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

上传和下载

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

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

定制和回调

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

代理特质默认实现,允许你以最小的努力对其进行定制。

服务器请求的可选部分

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

构建器参数

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

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

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

Cargo功能

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

许可证

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

依赖关系

~12–22MB
~343K SLoC