The google-dlp2 library allows access to all features of the Google DLP service.

This documentation was generated from DLP crate version 6.0.0+20240616, where 20240616 is the exact revision of the dlp:v2 schema built by the mako code generator v6.0.0.

Everything else about the DLP v2 API can be found at the official documentation site.

Features

Handle the following Resources with ease from the central hub ...

• info types
• list
• locations
• info types list
• organizations
• deidentify templates create, deidentify templates delete, deidentify templates get, deidentify templates list, deidentify templates patch, inspect templates create, inspect templates delete, inspect templates get, inspect templates list, inspect templates patch, locations column data profiles get, locations column data profiles list, locations connections create, locations connections delete, locations connections get, locations connections patch, locations connections search, locations deidentify templates create, locations deidentify templates delete, locations deidentify templates get, locations deidentify templates list, locations deidentify templates patch, locations discovery configs create, locations discovery configs delete, locations discovery configs get, locations discovery configs list, locations discovery configs patch, locations dlp jobs list, locations inspect templates create, locations inspect templates delete, locations inspect templates get, locations inspect templates list, locations inspect templates patch, locations job triggers create, locations job triggers delete, locations job triggers get, locations job triggers list, locations job triggers patch, locations project data profiles get, locations project data profiles list, locations stored info types create, locations stored info types delete, locations stored info types get, locations stored info types list, locations stored info types patch, locations table data profiles delete, locations table data profiles get, locations table data profiles list, stored info types create, stored info types delete, stored info types get, stored info types list and stored info types patch
• projects
• content deidentify, content inspect, content reidentify, deidentify templates create, deidentify templates delete, deidentify templates get, deidentify templates list, deidentify templates patch, dlp jobs cancel, dlp jobs create, dlp jobs delete, dlp jobs get, dlp jobs list, image redact, inspect templates create, inspect templates delete, inspect templates get, inspect templates list, inspect templates patch, job triggers activate, job triggers create, job triggers delete, job triggers get, job triggers list, job triggers patch, locations column data profiles get, locations column data profiles list, locations connections create, locations connections delete, locations connections get, locations connections list, locations connections patch, locations connections search, locations content deidentify, locations content inspect, locations content reidentify, locations deidentify templates create, locations deidentify templates delete, locations deidentify templates get, locations deidentify templates list, locations deidentify templates patch, locations discovery configs create, locations discovery configs delete, locations discovery configs get, locations discovery configs list, locations discovery configs patch, locations dlp jobs cancel, locations dlp jobs create, locations dlp jobs delete, locations dlp jobs finish, locations dlp jobs get, locations dlp jobs hybrid inspect, locations dlp jobs list, locations image redact, locations inspect templates create, locations inspect templates delete, locations inspect templates get, locations inspect templates list, locations inspect templates patch, locations job triggers activate, locations job triggers create, locations job triggers delete, locations job triggers get, locations job triggers hybrid inspect, locations job triggers list, locations job triggers patch, locations project data profiles get, locations project data profiles list, locations stored info types create, locations stored info types delete, locations stored info types get, locations stored info types list, locations stored info types patch, locations table data profiles delete, locations table data profiles get, locations table data profiles list, stored info types create, stored info types delete, stored info types get, stored info types list and stored info types patch

Structure of this Library

The API is structured into the following primary items:

• Hub
  • a central object to maintain state and allow accessing all Activities
  • creates Method Builders which in turn allow access to individual Call Builders
• Resources
  • primary types that you can apply Activities to
  • a collection of properties and Parts
  • Parts
    • a collection of properties
    • never directly used in Activities
• Activities
  • operations to apply to Resources

All structures are marked with applicable traits to further categorize them and ease browsing.

Generally speaking, you can invoke Activities like this:

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

Or specifically ...

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

The resource() and activity(...) calls create builders. The second one dealing with Activities supports various methods to configure the impending operation (not shown here). It is made such that all required arguments have to be specified right away (i.e. (...)), whereas all optional ones can be build up as desired. The doit() method performs the actual communication with the server and returns the respective result.

Usage

Setting up your Project

To use this library, you would put the following lines into your Cargo.toml file:

[dependencies]
google-dlp2 = "*"
serde = "1"
serde_json = "1"

A complete example

extern crate hyper;
extern crate hyper_rustls;
extern crate google_dlp2 as dlp2;
use dlp2::api::GooglePrivacyDlpV2CancelDlpJobRequest;
use dlp2::{Result, Error};
use dlp2::{DLP, FieldMask, hyper_rustls, hyper_util, yup_oauth2};

// Get an ApplicationSecret instance by some means. It contains the `client_id` and
// `client_secret`, among other things.
let secret: yup_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 = yup_oauth2::InstalledFlowAuthenticator::builder(
    secret,
    yup_oauth2::InstalledFlowReturnMethod::HTTPRedirect,
).build().await.unwrap();

let client = hyper_util::client::legacy::Client::builder(
    hyper_util::rt::TokioExecutor::new()
)
.build(
    hyper_rustls::HttpsConnectorBuilder::new()
        .with_native_roots()
        .unwrap()
        .https_or_http()
        .enable_http1()
        .build()
);
let mut hub = DLP::new(client, 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),
}

Handling Errors

All errors produced by the system are provided either as Result enumeration as return value of the doit() methods, or handed as possibly intermediate results to either the Hub Delegate, or the Authenticator Delegate.

When delegates handle errors or intermediate values, they may have a chance to instruct the system to retry. This makes the system potentially resilient to all kinds of errors.

Uploads and Downloads

If a method supports downloads, the response body, which is part of the Result, should be read by you to obtain the media. If such a method also supports a Response Result, it will return that by default. You can see it as meta-data for the actual media. To trigger a media download, you will have to set up the builder by making this call: .param("alt", "media").

Methods supporting uploads can do so using up to 2 different protocols: simple and resumable. The distinctiveness of each is represented by customized doit(...) methods, which are then named upload(...) and upload_resumable(...) respectively.

Customization and Callbacks

You may alter the way an doit() method is called by providing a delegate to the Method Builder before making the final doit() call. Respective methods will be called to provide progress information, as well as determine whether the system should retry on failure.

The delegate trait is default-implemented, allowing you to customize it with minimal effort.

Optional Parts in Server-Requests

All structures provided by this library are made to be encodable and decodable via json. Optionals are used to indicate that partial requests are responses are valid. Most optionals are are considered Parts which are identifiable by name, which will be sent to the server to indicate either the set parts of the request or the desired parts in the response.

Builder Arguments

Using method builders, you are able to prepare an action call by repeatedly calling it's methods. These will always take a single argument, for which the following statements are true.

• PODs are handed by copy
• strings are passed as &str
• request values are moved

Arguments will always be copied or cloned into the builder, to make them independent of their original life times.

Cargo Features

• utoipa - Add support for utoipa and derive utoipa::ToSchema on all the types. You'll have to import and register the required types in #[openapi(schemas(...))], otherwise the generated openapi spec would be invalid.

License

The dlp2 library was generated by Sebastian Thiel, and is placed under the MIT license. You can read the full text at the repository's license file.