#google-api #google #protocols #api #web-api #web #policyanalyzer

google-policyanalyzer1

与Policy Analyzer(协议v1)交互的完整库

8个版本 (稳定版)

5.0.5+20240623 2024年6月27日
5.0.4+20240303 2024年3月5日
5.0.3+20230122 2023年8月24日
5.0.2+20230122 2023年3月17日
3.0.0+20220227 2022年3月8日

#2641 in Web编程

Download history 5/week @ 2024-05-19 1/week @ 2024-06-09 95/week @ 2024-06-23 25/week @ 2024-06-30

每月474次下载
用于 google-policyanalyzer1-cl…

MIT 协议

140KB
2K SLoC

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

此文档由 Policy Analyzer crate版本 5.0.5+20240623 生成,其中 20240623 是由 mako 代码生成器 v5.0.5 构建的 policyanalyzer:v1 架构的确切修订版本。

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

功能

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

本库的结构

API结构如下主要项目

  • 中心
  • 资源
    • 可以将 活动 应用于其主要类型
    • 一系列属性和 部分
    • 部分
      • 一系列属性
      • 活动 中永远不会直接使用
  • 活动
    • 应用于 资源 的操作

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

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

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

或具体地 ...

let r = hub.folders().locations_activity_types_activities_query(...).doit().await
let r = hub.organizations().locations_activity_types_activities_query(...).doit().await
let r = hub.projects().locations_activity_types_activities_query(...).doit().await

《资源》resource()和《活动》activity(...)调用创建了构建器。后者处理《活动》支持配置即将进行的操作的各种方法(此处未展示)。它被设计成必须立即指定所有必需的参数(即(...)),而所有可选的则可以按需构建。`doit()`方法执行与服务器的实际通信并返回相应的结果。

用法

设置项目

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

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

完整示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_policyanalyzer1 as policyanalyzer1;
use policyanalyzer1::{Result, Error};
use std::default::Default;
use policyanalyzer1::{PolicyAnalyzer, 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 = PolicyAnalyzer::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.folders().locations_activity_types_activities_query("parent")
             .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枚举,或者作为可能的中继结果传递给(...)Hub Delegate,或Authenticator Delegate

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

上传和下载

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

支持上传的方法可以使用最多2种不同的协议:`simple`和`resumable`。每种的独特性由定制的`doit()`方法表示,分别命名为`upload()`和`upload_resumable()`。

定制和回调

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

代理trait”默认实现,让您可以以最小的努力进行自定义。

服务器请求中的可选部分

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

构建器参数

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

  • POD(普通旧数据结构)通过复制传递
  • 字符串作为&str传递
  • 请求值是移动的

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

Cargo功能

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

许可证

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

依赖关系

~12–23MB
~343K SLoC