#google #dlp #protocols #google-api #web #web-api

google-dlp2_beta1

一个完整的库,用于与 DLP(协议 v2beta1)交互

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

5.0.5+20171205 2024年6月27日
5.0.4+20171205 2024年3月5日
5.0.3+20171205 2023年8月23日
5.0.2+20171205 2023年3月16日
1.0.6+20170918 2017年9月27日

#2434 in 网页编程


用于 google-dlp2_beta1-cli

MIT 许可证

410KB
5K SLoC

google-dlp2_beta1 库允许访问 Google DLP(协议 v2beta1)服务的所有功能。

此文档是从 DLP crate 版本 5.0.5+20171205 生成的,其中 20171205 是由 mako 代码生成器 v5.0.5 构建的 dlp:v2beta1 模式的确切修订版。

有关 DLP v2_beta1 API 的其他信息,请参阅官方文档网站

特性

从中心 枢纽 简单地处理以下 资源 ...

本库结构

API结构如下几个主要项目

  • 中心节点
  • 资源
    • 你可以将活动应用到这些主要类型上
    • 一系列属性和部分
    • 部分
      • 一系列属性
      • 活动中不直接使用
  • 活动
    • 应用到资源上的操作

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

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

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

或者具体来说 ...

let r = hub.risk_analysis().operations_get(...).doit().await
let r = hub.data_source().analyze(...).doit().await
let r = hub.inspect().operations_create(...).doit().await
let r = hub.inspect().operations_get(...).doit().await

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

使用方法

设置你的项目

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

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

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_dlp2_beta1 as dlp2_beta1;
use dlp2_beta1::{Result, Error};
use std::default::Default;
use dlp2_beta1::{DLP, 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 = DLP::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.risk_analysis().operations_get("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")

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

定制和回调

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

delegate trait默认实现,让您可以轻松地进行定制。

服务器请求中的可选部分

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

Builder 参数

通过使用method builders,您可以通过重复调用其方法来准备一个操作调用。这些方法始终接受单个参数,以下是一些关于该参数的说明。

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

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

Cargo 功能

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

许可证

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

依赖项

~12–23MB
~343K SLoC