The google-networkconnectivity1 library allows access to all features of the Google networkconnectivity service.

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

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

Features

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

• projects
• locations get, locations global hubs accept spoke, locations global hubs create, locations global hubs delete, locations global hubs get, locations global hubs get iam policy, locations global hubs groups get, locations global hubs groups get iam policy, locations global hubs groups list, locations global hubs groups patch, locations global hubs groups set iam policy, locations global hubs groups test iam permissions, locations global hubs list, locations global hubs list spokes, locations global hubs patch, locations global hubs reject spoke, locations global hubs route tables get, locations global hubs route tables list, locations global hubs route tables routes get, locations global hubs route tables routes list, locations global hubs set iam policy, locations global hubs test iam permissions, locations global policy based routes create, locations global policy based routes delete, locations global policy based routes get, locations global policy based routes get iam policy, locations global policy based routes list, locations global policy based routes set iam policy, locations global policy based routes test iam permissions, locations internal ranges create, locations internal ranges delete, locations internal ranges get, locations internal ranges list, locations internal ranges patch, locations list, locations operations cancel, locations operations delete, locations operations get, locations operations list, locations regional endpoints create, locations regional endpoints delete, locations regional endpoints get, locations regional endpoints list, locations service classes delete, locations service classes get, locations service classes get iam policy, locations service classes list, locations service classes patch, locations service classes set iam policy, locations service classes test iam permissions, locations service connection maps create, locations service connection maps delete, locations service connection maps get, locations service connection maps get iam policy, locations service connection maps list, locations service connection maps patch, locations service connection maps set iam policy, locations service connection maps test iam permissions, locations service connection policies create, locations service connection policies delete, locations service connection policies get, locations service connection policies get iam policy, locations service connection policies list, locations service connection policies patch, locations service connection policies set iam policy, locations service connection policies test iam permissions, locations service connection tokens create, locations service connection tokens delete, locations service connection tokens get, locations service connection tokens list, locations spokes create, locations spokes delete, locations spokes get, locations spokes get iam policy, locations spokes list, locations spokes patch, locations spokes set iam policy and locations spokes 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_global_hubs_groups_patch(...).doit().await
let r = hub.projects().locations_global_hubs_accept_spoke(...).doit().await
let r = hub.projects().locations_global_hubs_create(...).doit().await
let r = hub.projects().locations_global_hubs_delete(...).doit().await
let r = hub.projects().locations_global_hubs_patch(...).doit().await
let r = hub.projects().locations_global_hubs_reject_spoke(...).doit().await
let r = hub.projects().locations_global_policy_based_routes_create(...).doit().await
let r = hub.projects().locations_global_policy_based_routes_delete(...).doit().await
let r = hub.projects().locations_internal_ranges_create(...).doit().await
let r = hub.projects().locations_internal_ranges_delete(...).doit().await
let r = hub.projects().locations_internal_ranges_patch(...).doit().await
let r = hub.projects().locations_operations_get(...).doit().await
let r = hub.projects().locations_regional_endpoints_create(...).doit().await
let r = hub.projects().locations_regional_endpoints_delete(...).doit().await
let r = hub.projects().locations_service_classes_delete(...).doit().await
let r = hub.projects().locations_service_classes_patch(...).doit().await
let r = hub.projects().locations_service_connection_maps_create(...).doit().await
let r = hub.projects().locations_service_connection_maps_delete(...).doit().await
let r = hub.projects().locations_service_connection_maps_patch(...).doit().await
let r = hub.projects().locations_service_connection_policies_create(...).doit().await
let r = hub.projects().locations_service_connection_policies_delete(...).doit().await
let r = hub.projects().locations_service_connection_policies_patch(...).doit().await
let r = hub.projects().locations_service_connection_tokens_create(...).doit().await
let r = hub.projects().locations_service_connection_tokens_delete(...).doit().await
let r = hub.projects().locations_spokes_create(...).doit().await
let r = hub.projects().locations_spokes_delete(...).doit().await
let r = hub.projects().locations_spokes_patch(...).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-networkconnectivity1 = "*"
serde = "1"
serde_json = "1"

A complete example

extern crate hyper;
extern crate hyper_rustls;
extern crate google_networkconnectivity1 as networkconnectivity1;
use networkconnectivity1::api::Group;
use networkconnectivity1::{Result, Error};
use networkconnectivity1::{Networkconnectivity, 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 = Networkconnectivity::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 = Group::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_global_hubs_groups_patch(req, "name")
             .update_mask(FieldMask::new::<&str>(&[]))
             .request_id("magna")
             .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 networkconnectivity1 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.