The google-networkservices1 library allows access to all features of the Google NetworkServices service.

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

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

Features

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

• projects
• locations edge cache keysets get iam policy, locations edge cache keysets set iam policy, locations edge cache keysets test iam permissions, locations edge cache origins get iam policy, locations edge cache origins set iam policy, locations edge cache origins test iam permissions, locations edge cache services get iam policy, locations edge cache services set iam policy, locations edge cache services test iam permissions, locations endpoint policies create, locations endpoint policies delete, locations endpoint policies get, locations endpoint policies get iam policy, locations endpoint policies list, locations endpoint policies patch, locations endpoint policies set iam policy, locations endpoint policies test iam permissions, locations gateways create, locations gateways delete, locations gateways get, locations gateways get iam policy, locations gateways list, locations gateways patch, locations gateways set iam policy, locations gateways test iam permissions, locations get, locations grpc routes create, locations grpc routes delete, locations grpc routes get, locations grpc routes list, locations grpc routes patch, locations http routes create, locations http routes delete, locations http routes get, locations http routes list, locations http routes patch, locations lb route extensions create, locations lb route extensions delete, locations lb route extensions get, locations lb route extensions list, locations lb route extensions patch, locations lb traffic extensions create, locations lb traffic extensions delete, locations lb traffic extensions get, locations lb traffic extensions list, locations lb traffic extensions patch, locations list, locations meshes create, locations meshes delete, locations meshes get, locations meshes get iam policy, locations meshes list, locations meshes patch, locations meshes set iam policy, locations meshes test iam permissions, locations operations cancel, locations operations delete, locations operations get, locations operations list, locations service bindings create, locations service bindings delete, locations service bindings get, locations service bindings get iam policy, locations service bindings list, locations service bindings set iam policy, locations service bindings test iam permissions, locations service lb policies create, locations service lb policies delete, locations service lb policies get, locations service lb policies get iam policy, locations service lb policies list, locations service lb policies patch, locations service lb policies set iam policy, locations service lb policies test iam permissions, locations tcp routes create, locations tcp routes delete, locations tcp routes get, locations tcp routes list, locations tcp routes patch, locations tls routes create, locations tls routes delete, locations tls routes get, locations tls routes list and locations tls routes 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.projects().locations_endpoint_policies_create(...).doit().await
let r = hub.projects().locations_endpoint_policies_delete(...).doit().await
let r = hub.projects().locations_endpoint_policies_patch(...).doit().await
let r = hub.projects().locations_gateways_create(...).doit().await
let r = hub.projects().locations_gateways_delete(...).doit().await
let r = hub.projects().locations_gateways_patch(...).doit().await
let r = hub.projects().locations_grpc_routes_create(...).doit().await
let r = hub.projects().locations_grpc_routes_delete(...).doit().await
let r = hub.projects().locations_grpc_routes_patch(...).doit().await
let r = hub.projects().locations_http_routes_create(...).doit().await
let r = hub.projects().locations_http_routes_delete(...).doit().await
let r = hub.projects().locations_http_routes_patch(...).doit().await
let r = hub.projects().locations_lb_route_extensions_create(...).doit().await
let r = hub.projects().locations_lb_route_extensions_delete(...).doit().await
let r = hub.projects().locations_lb_route_extensions_patch(...).doit().await
let r = hub.projects().locations_lb_traffic_extensions_create(...).doit().await
let r = hub.projects().locations_lb_traffic_extensions_delete(...).doit().await
let r = hub.projects().locations_lb_traffic_extensions_patch(...).doit().await
let r = hub.projects().locations_meshes_create(...).doit().await
let r = hub.projects().locations_meshes_delete(...).doit().await
let r = hub.projects().locations_meshes_patch(...).doit().await
let r = hub.projects().locations_operations_get(...).doit().await
let r = hub.projects().locations_service_bindings_create(...).doit().await
let r = hub.projects().locations_service_bindings_delete(...).doit().await
let r = hub.projects().locations_service_lb_policies_create(...).doit().await
let r = hub.projects().locations_service_lb_policies_delete(...).doit().await
let r = hub.projects().locations_service_lb_policies_patch(...).doit().await
let r = hub.projects().locations_tcp_routes_create(...).doit().await
let r = hub.projects().locations_tcp_routes_delete(...).doit().await
let r = hub.projects().locations_tcp_routes_patch(...).doit().await
let r = hub.projects().locations_tls_routes_create(...).doit().await
let r = hub.projects().locations_tls_routes_delete(...).doit().await
let r = hub.projects().locations_tls_routes_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-networkservices1 = "*"
serde = "1"
serde_json = "1"

A complete example

extern crate hyper;
extern crate hyper_rustls;
extern crate google_networkservices1 as networkservices1;
use networkservices1::api::LbRouteExtension;
use networkservices1::{Result, Error};
use networkservices1::{NetworkServices, 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 = NetworkServices::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 = LbRouteExtension::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_lb_route_extensions_create(req, "parent")
             .request_id("magna")
             .lb_route_extension_id("no")
             .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 networkservices1 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.