The google-dataplex1 library allows access to all features of the Google Cloud Dataplex service.

This documentation was generated from Cloud Dataplex crate version 6.0.0+20240611, where 20240611 is the exact revision of the dataplex:v1 schema built by the mako code generator v6.0.0.

Everything else about the Cloud Dataplex v1 API can be found at the official documentation site.

Features

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

• projects

• locations aspect types create, locations aspect types delete, locations aspect types get, locations aspect types get iam policy, locations aspect types list, locations aspect types patch, locations aspect types set iam policy, locations aspect types test iam permissions, locations data attribute bindings create, locations data attribute bindings delete, locations data attribute bindings get, locations data attribute bindings get iam policy, locations data attribute bindings list, locations data attribute bindings patch, locations data attribute bindings set iam policy, locations data attribute bindings test iam permissions, locations data scans create, locations data scans delete, locations data scans generate data quality rules, locations data scans get, locations data scans get iam policy, locations data scans jobs generate data quality rules, locations data scans jobs get, locations data scans jobs list, locations data scans list, locations data scans patch, locations data scans run, locations data scans set iam policy, locations data scans test iam permissions, locations data taxonomies attributes create, locations data taxonomies attributes delete, locations data taxonomies attributes get, locations data taxonomies attributes get iam policy, locations data taxonomies attributes list, locations data taxonomies attributes patch, locations data taxonomies attributes set iam policy, locations data taxonomies attributes test iam permissions, locations data taxonomies create, locations data taxonomies delete, locations data taxonomies get, locations data taxonomies get iam policy, locations data taxonomies list, locations data taxonomies patch, locations data taxonomies set iam policy, locations data taxonomies test iam permissions, locations entry groups create, locations entry groups delete, locations entry groups entries create, locations entry groups entries delete, locations entry groups entries get, locations entry groups entries list, locations entry groups entries patch, locations entry groups get, locations entry groups get iam policy, locations entry groups list, locations entry groups patch, locations entry groups set iam policy, locations entry groups test iam permissions, locations entry types create, locations entry types delete, locations entry types get, locations entry types get iam policy, locations entry types list, locations entry types patch, locations entry types set iam policy, locations entry types test iam permissions, locations get, locations governance rules get iam policy, locations governance rules set iam policy, locations governance rules test iam permissions, locations lakes actions list, locations lakes content create, locations lakes content delete, locations lakes content get, locations lakes content get iam policy, locations lakes content list, locations lakes content patch, locations lakes content set iam policy, locations lakes content test iam permissions, locations lakes contentitems create, locations lakes contentitems delete, locations lakes contentitems get, locations lakes contentitems get iam policy, locations lakes contentitems list, locations lakes contentitems patch, locations lakes contentitems set iam policy, locations lakes contentitems test iam permissions, locations lakes create, locations lakes delete, locations lakes environments create, locations lakes environments delete, locations lakes environments get, locations lakes environments get iam policy, locations lakes environments list, locations lakes environments patch, locations lakes environments sessions list, locations lakes environments set iam policy, locations lakes environments test iam permissions, locations lakes get, locations lakes get iam policy, locations lakes list, locations lakes patch, locations lakes set iam policy, locations lakes tasks create, locations lakes tasks delete, locations lakes tasks get, locations lakes tasks get iam policy, locations lakes tasks jobs cancel, locations lakes tasks jobs get, locations lakes tasks jobs list, locations lakes tasks list, locations lakes tasks patch, locations lakes tasks run, locations lakes tasks set iam policy, locations lakes tasks test iam permissions, locations lakes test iam permissions, locations lakes zones actions list, locations lakes zones assets actions list, locations lakes zones assets create, locations lakes zones assets delete, locations lakes zones assets get, locations lakes zones assets get iam policy, locations lakes zones assets list, locations lakes zones assets patch, locations lakes zones assets set iam policy, locations lakes zones assets test iam permissions, locations lakes zones create, locations lakes zones delete, locations lakes zones entities create, locations lakes zones entities delete, locations lakes zones entities get, locations lakes zones entities list, locations lakes zones entities partitions create, locations lakes zones entities partitions delete, locations lakes zones entities partitions get, locations lakes zones entities partitions list, locations lakes zones entities update, locations lakes zones get, locations lakes zones get iam policy, locations lakes zones list, locations lakes zones patch, locations lakes zones set iam policy, locations lakes zones test iam permissions, locations list, locations lookup entry, locations operations cancel, locations operations delete, locations operations get, locations operations list and locations search entries

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.projects().locations_aspect_types_create(...).doit().await
let r = hub.projects().locations_aspect_types_delete(...).doit().await
let r = hub.projects().locations_aspect_types_patch(...).doit().await
let r = hub.projects().locations_data_attribute_bindings_create(...).doit().await
let r = hub.projects().locations_data_attribute_bindings_delete(...).doit().await
let r = hub.projects().locations_data_attribute_bindings_patch(...).doit().await
let r = hub.projects().locations_data_scans_create(...).doit().await
let r = hub.projects().locations_data_scans_delete(...).doit().await
let r = hub.projects().locations_data_scans_patch(...).doit().await
let r = hub.projects().locations_data_taxonomies_attributes_create(...).doit().await
let r = hub.projects().locations_data_taxonomies_attributes_delete(...).doit().await
let r = hub.projects().locations_data_taxonomies_attributes_patch(...).doit().await
let r = hub.projects().locations_data_taxonomies_create(...).doit().await
let r = hub.projects().locations_data_taxonomies_delete(...).doit().await
let r = hub.projects().locations_data_taxonomies_patch(...).doit().await
let r = hub.projects().locations_entry_groups_create(...).doit().await
let r = hub.projects().locations_entry_groups_delete(...).doit().await
let r = hub.projects().locations_entry_groups_patch(...).doit().await
let r = hub.projects().locations_entry_types_create(...).doit().await
let r = hub.projects().locations_entry_types_delete(...).doit().await
let r = hub.projects().locations_entry_types_patch(...).doit().await
let r = hub.projects().locations_lakes_environments_create(...).doit().await
let r = hub.projects().locations_lakes_environments_delete(...).doit().await
let r = hub.projects().locations_lakes_environments_patch(...).doit().await
let r = hub.projects().locations_lakes_tasks_create(...).doit().await
let r = hub.projects().locations_lakes_tasks_delete(...).doit().await
let r = hub.projects().locations_lakes_tasks_patch(...).doit().await
let r = hub.projects().locations_lakes_zones_assets_create(...).doit().await
let r = hub.projects().locations_lakes_zones_assets_delete(...).doit().await
let r = hub.projects().locations_lakes_zones_assets_patch(...).doit().await
let r = hub.projects().locations_lakes_zones_create(...).doit().await
let r = hub.projects().locations_lakes_zones_delete(...).doit().await
let r = hub.projects().locations_lakes_zones_patch(...).doit().await
let r = hub.projects().locations_lakes_create(...).doit().await
let r = hub.projects().locations_lakes_delete(...).doit().await
let r = hub.projects().locations_lakes_patch(...).doit().await
let r = hub.projects().locations_operations_get(...).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-dataplex1 = "*"
serde = "1"
serde_json = "1"

A complete example

extern crate hyper;
extern crate hyper_rustls;
extern crate google_dataplex1 as dataplex1;
use dataplex1::api::GoogleCloudDataplexV1AspectType;
use dataplex1::{Result, Error};
use dataplex1::{CloudDataplex, 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 = CloudDataplex::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 = GoogleCloudDataplexV1AspectType::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().locations_aspect_types_create(req, "parent")
             .validate_only(true)
             .aspect_type_id("voluptua.")
             .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 dataplex1 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.