#dlp #google #protocols

google-dlp2

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

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

5.0.5+20240616 2024年6月27日
5.0.4+20240225 2024年3月5日
5.0.3+20230121 2023年8月23日
5.0.2+20230121 2023年3月16日
1.0.8+20181009 2018年10月14日

网页编程 中排名第 2493

Download history 5/week @ 2024-05-18 1/week @ 2024-05-25 87/week @ 2024-06-22 16/week @ 2024-06-29 3/week @ 2024-07-06

每月下载量 1,113
用于 google-dlp2-cli

MIT 许可证

2.5MB
28K SLoC

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

此文档是根据 DLP 包版本 5.0.5+20240616 生成的,其中 20240616 是由 mako 代码生成器 v5.0.5 构建的 dlp:v2 架构的精确修订版本。

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

特性

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

本库的结构

API 结构如下主要项

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

所有 结构 都标记了适用的特质,以便进一步分类并便于浏览。

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

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

或具体 ...

let r = hub.organizations().deidentify_templates_delete(...).doit().await
let r = hub.organizations().inspect_templates_delete(...).doit().await
let r = hub.organizations().locations_connections_delete(...).doit().await
let r = hub.organizations().locations_deidentify_templates_delete(...).doit().await
let r = hub.organizations().locations_discovery_configs_delete(...).doit().await
let r = hub.organizations().locations_inspect_templates_delete(...).doit().await
let r = hub.organizations().locations_job_triggers_delete(...).doit().await
let r = hub.organizations().locations_stored_info_types_delete(...).doit().await
let r = hub.organizations().locations_table_data_profiles_delete(...).doit().await
let r = hub.organizations().stored_info_types_delete(...).doit().await
let r = hub.projects().deidentify_templates_delete(...).doit().await
let r = hub.projects().dlp_jobs_cancel(...).doit().await
let r = hub.projects().dlp_jobs_delete(...).doit().await
let r = hub.projects().inspect_templates_delete(...).doit().await
let r = hub.projects().job_triggers_delete(...).doit().await
let r = hub.projects().locations_connections_delete(...).doit().await
let r = hub.projects().locations_deidentify_templates_delete(...).doit().await
let r = hub.projects().locations_discovery_configs_delete(...).doit().await
let r = hub.projects().locations_dlp_jobs_cancel(...).doit().await
let r = hub.projects().locations_dlp_jobs_delete(...).doit().await
let r = hub.projects().locations_dlp_jobs_finish(...).doit().await
let r = hub.projects().locations_inspect_templates_delete(...).doit().await
let r = hub.projects().locations_job_triggers_delete(...).doit().await
let r = hub.projects().locations_stored_info_types_delete(...).doit().await
let r = hub.projects().locations_table_data_profiles_delete(...).doit().await
let r = hub.projects().stored_info_types_delete(...).doit().await

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

用法

设置你的项目

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

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

完整示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_dlp2 as dlp2;
use dlp2::api::GooglePrivacyDlpV2CancelDlpJobRequest;
use dlp2::{Result, Error};
use std::default::Default;
use dlp2::{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);
// 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 = GooglePrivacyDlpV2CancelDlpJobRequest::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.projects().dlp_jobs_cancel(req, "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 Delegate,或 Authenticator Delegate

当代理处理错误或中继值时,它们可能会有机会指示系统重试。这使得系统对各种错误具有潜在的抗压性。

上传和下载

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

支持上传的方法可以使用最多两种不同的协议进行: 简单可恢复。每个的独特之处在于自定义的 doit(...) 方法,分别命名为 upload(...)upload_resumable(...)

自定义和回调

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

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

服务器请求中的可选部分

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

构建器参数

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

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

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

Cargo功能

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

许可证

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

依赖关系

~12–23MB
~343K SLoC