The google-retail2 library allows access to all features of the Google Cloud Retail service.

This documentation was generated from Cloud Retail crate version 6.0.0+20240614, where 20240614 is the exact revision of the retail:v2 schema built by the mako code generator v6.0.0.

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

Features

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

• projects
• locations catalogs attributes config add catalog attribute, locations catalogs attributes config remove catalog attribute, locations catalogs attributes config replace catalog attribute, locations catalogs branches operations get, locations catalogs branches products add fulfillment places, locations catalogs branches products add local inventories, locations catalogs branches products create, locations catalogs branches products delete, locations catalogs branches products get, locations catalogs branches products import, locations catalogs branches products list, locations catalogs branches products patch, locations catalogs branches products purge, locations catalogs branches products remove fulfillment places, locations catalogs branches products remove local inventories, locations catalogs branches products set inventory, locations catalogs complete query, locations catalogs completion data import, locations catalogs controls create, locations catalogs controls delete, locations catalogs controls get, locations catalogs controls list, locations catalogs controls patch, locations catalogs export analytics metrics, locations catalogs get attributes config, locations catalogs get completion config, locations catalogs get default branch, locations catalogs list, locations catalogs models create, locations catalogs models delete, locations catalogs models get, locations catalogs models list, locations catalogs models patch, locations catalogs models pause, locations catalogs models resume, locations catalogs models tune, locations catalogs operations get, locations catalogs operations list, locations catalogs patch, locations catalogs placements predict, locations catalogs placements search, locations catalogs serving configs add control, locations catalogs serving configs create, locations catalogs serving configs delete, locations catalogs serving configs get, locations catalogs serving configs list, locations catalogs serving configs patch, locations catalogs serving configs predict, locations catalogs serving configs remove control, locations catalogs serving configs search, locations catalogs set default branch, locations catalogs update attributes config, locations catalogs update completion config, locations catalogs user events collect, locations catalogs user events import, locations catalogs user events purge, locations catalogs user events rejoin, locations catalogs user events write, locations operations get, locations operations list, operations get and operations list

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_catalogs_branches_operations_get(...).doit().await
let r = hub.projects().locations_catalogs_branches_products_add_fulfillment_places(...).doit().await
let r = hub.projects().locations_catalogs_branches_products_add_local_inventories(...).doit().await
let r = hub.projects().locations_catalogs_branches_products_import(...).doit().await
let r = hub.projects().locations_catalogs_branches_products_purge(...).doit().await
let r = hub.projects().locations_catalogs_branches_products_remove_fulfillment_places(...).doit().await
let r = hub.projects().locations_catalogs_branches_products_remove_local_inventories(...).doit().await
let r = hub.projects().locations_catalogs_branches_products_set_inventory(...).doit().await
let r = hub.projects().locations_catalogs_completion_data_import(...).doit().await
let r = hub.projects().locations_catalogs_models_create(...).doit().await
let r = hub.projects().locations_catalogs_models_tune(...).doit().await
let r = hub.projects().locations_catalogs_operations_get(...).doit().await
let r = hub.projects().locations_catalogs_user_events_import(...).doit().await
let r = hub.projects().locations_catalogs_user_events_purge(...).doit().await
let r = hub.projects().locations_catalogs_user_events_rejoin(...).doit().await
let r = hub.projects().locations_catalogs_export_analytics_metrics(...).doit().await
let r = hub.projects().locations_operations_get(...).doit().await
let r = hub.projects().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-retail2 = "*"
serde = "1"
serde_json = "1"

A complete example

extern crate hyper;
extern crate hyper_rustls;
extern crate google_retail2 as retail2;
use retail2::api::GoogleCloudRetailV2Model;
use retail2::{Result, Error};
use retail2::{CloudRetail, 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 = CloudRetail::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 = GoogleCloudRetailV2Model::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_catalogs_models_create(req, "parent")
             .dry_run(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 retail2 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.