The google-datacatalog1 library allows access to all features of the Google Data Catalog service.

This documentation was generated from Data Catalog crate version 6.0.0+20240624, where 20240624 is the exact revision of the datacatalog:v1 schema built by the mako code generator v6.0.0.

Everything else about the Data Catalog v1 API can be found at the official documentation site.

Features

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

• catalog
• search
• entries
• lookup
• projects
• 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 get iam policy, locations entry groups entries import, locations entry groups entries list, locations entry groups entries modify entry contacts, locations entry groups entries modify entry overview, locations entry groups entries patch, locations entry groups entries star, locations entry groups entries tags create, locations entry groups entries tags delete, locations entry groups entries tags list, locations entry groups entries tags patch, locations entry groups entries tags reconcile, locations entry groups entries test iam permissions, locations entry groups entries unstar, 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 tags create, locations entry groups tags delete, locations entry groups tags list, locations entry groups tags patch, locations entry groups test iam permissions, locations operations cancel, locations operations delete, locations operations get, locations operations list, locations tag templates create, locations tag templates delete, locations tag templates fields create, locations tag templates fields delete, locations tag templates fields enum values rename, locations tag templates fields patch, locations tag templates fields rename, locations tag templates get, locations tag templates get iam policy, locations tag templates patch, locations tag templates set iam policy, locations tag templates test iam permissions, locations taxonomies create, locations taxonomies delete, locations taxonomies export, locations taxonomies get, locations taxonomies get iam policy, locations taxonomies import, locations taxonomies list, locations taxonomies patch, locations taxonomies policy tags create, locations taxonomies policy tags delete, locations taxonomies policy tags get, locations taxonomies policy tags get iam policy, locations taxonomies policy tags list, locations taxonomies policy tags patch, locations taxonomies policy tags set iam policy, locations taxonomies policy tags test iam permissions, locations taxonomies replace, locations taxonomies set iam policy and locations taxonomies test iam permissions

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_entry_groups_entries_tags_delete(...).doit().await
let r = hub.projects().locations_entry_groups_entries_delete(...).doit().await
let r = hub.projects().locations_entry_groups_tags_delete(...).doit().await
let r = hub.projects().locations_entry_groups_delete(...).doit().await
let r = hub.projects().locations_operations_cancel(...).doit().await
let r = hub.projects().locations_operations_delete(...).doit().await
let r = hub.projects().locations_tag_templates_fields_delete(...).doit().await
let r = hub.projects().locations_tag_templates_delete(...).doit().await
let r = hub.projects().locations_taxonomies_policy_tags_delete(...).doit().await
let r = hub.projects().locations_taxonomies_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-datacatalog1 = "*"
serde = "1"
serde_json = "1"

A complete example

extern crate hyper;
extern crate hyper_rustls;
extern crate google_datacatalog1 as datacatalog1;
use datacatalog1::{Result, Error};
use datacatalog1::{DataCatalog, 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 = DataCatalog::new(client, 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.projects().locations_entry_groups_delete("name")
             .force(true)
             .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 datacatalog1 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.