google_networkservices1/

lib.rs

// DO NOT EDIT !
// This file was generated automatically from 'src/generator/templates/api/lib.rs.mako'
// DO NOT EDIT !

//! This documentation was generated from *NetworkServices* crate version *7.0.0+20251203*, where *20251203* is the exact revision of the *networkservices:v1* schema built by the [mako](http://www.makotemplates.org/) code generator *v7.0.0*.
//!
//! Everything else about the *NetworkServices* *v1* API can be found at the
//! [official documentation site](https://cloud.google.com/networking).
//! The original source code is [on github](https://github.com/Byron/google-apis-rs/tree/main/gen/networkservices1).
//! # Features
//!
//! Handle the following *Resources* with ease from the central [hub](NetworkServices) ...
//!
//! * projects
//!  * [*locations authz extensions create*](api::ProjectLocationAuthzExtensionCreateCall), [*locations authz extensions delete*](api::ProjectLocationAuthzExtensionDeleteCall), [*locations authz extensions get*](api::ProjectLocationAuthzExtensionGetCall), [*locations authz extensions list*](api::ProjectLocationAuthzExtensionListCall), [*locations authz extensions patch*](api::ProjectLocationAuthzExtensionPatchCall), [*locations edge cache keysets get iam policy*](api::ProjectLocationEdgeCacheKeysetGetIamPolicyCall), [*locations edge cache keysets set iam policy*](api::ProjectLocationEdgeCacheKeysetSetIamPolicyCall), [*locations edge cache keysets test iam permissions*](api::ProjectLocationEdgeCacheKeysetTestIamPermissionCall), [*locations edge cache origins get iam policy*](api::ProjectLocationEdgeCacheOriginGetIamPolicyCall), [*locations edge cache origins set iam policy*](api::ProjectLocationEdgeCacheOriginSetIamPolicyCall), [*locations edge cache origins test iam permissions*](api::ProjectLocationEdgeCacheOriginTestIamPermissionCall), [*locations edge cache services get iam policy*](api::ProjectLocationEdgeCacheServiceGetIamPolicyCall), [*locations edge cache services set iam policy*](api::ProjectLocationEdgeCacheServiceSetIamPolicyCall), [*locations edge cache services test iam permissions*](api::ProjectLocationEdgeCacheServiceTestIamPermissionCall), [*locations endpoint policies create*](api::ProjectLocationEndpointPolicyCreateCall), [*locations endpoint policies delete*](api::ProjectLocationEndpointPolicyDeleteCall), [*locations endpoint policies get*](api::ProjectLocationEndpointPolicyGetCall), [*locations endpoint policies list*](api::ProjectLocationEndpointPolicyListCall), [*locations endpoint policies patch*](api::ProjectLocationEndpointPolicyPatchCall), [*locations gateways create*](api::ProjectLocationGatewayCreateCall), [*locations gateways delete*](api::ProjectLocationGatewayDeleteCall), [*locations gateways get*](api::ProjectLocationGatewayGetCall), [*locations gateways list*](api::ProjectLocationGatewayListCall), [*locations gateways patch*](api::ProjectLocationGatewayPatchCall), [*locations gateways route views get*](api::ProjectLocationGatewayRouteViewGetCall), [*locations gateways route views list*](api::ProjectLocationGatewayRouteViewListCall), [*locations get*](api::ProjectLocationGetCall), [*locations grpc routes create*](api::ProjectLocationGrpcRouteCreateCall), [*locations grpc routes delete*](api::ProjectLocationGrpcRouteDeleteCall), [*locations grpc routes get*](api::ProjectLocationGrpcRouteGetCall), [*locations grpc routes list*](api::ProjectLocationGrpcRouteListCall), [*locations grpc routes patch*](api::ProjectLocationGrpcRoutePatchCall), [*locations http routes create*](api::ProjectLocationHttpRouteCreateCall), [*locations http routes delete*](api::ProjectLocationHttpRouteDeleteCall), [*locations http routes get*](api::ProjectLocationHttpRouteGetCall), [*locations http routes list*](api::ProjectLocationHttpRouteListCall), [*locations http routes patch*](api::ProjectLocationHttpRoutePatchCall), [*locations lb edge extensions create*](api::ProjectLocationLbEdgeExtensionCreateCall), [*locations lb edge extensions delete*](api::ProjectLocationLbEdgeExtensionDeleteCall), [*locations lb edge extensions get*](api::ProjectLocationLbEdgeExtensionGetCall), [*locations lb edge extensions list*](api::ProjectLocationLbEdgeExtensionListCall), [*locations lb edge extensions patch*](api::ProjectLocationLbEdgeExtensionPatchCall), [*locations lb route extensions create*](api::ProjectLocationLbRouteExtensionCreateCall), [*locations lb route extensions delete*](api::ProjectLocationLbRouteExtensionDeleteCall), [*locations lb route extensions get*](api::ProjectLocationLbRouteExtensionGetCall), [*locations lb route extensions list*](api::ProjectLocationLbRouteExtensionListCall), [*locations lb route extensions patch*](api::ProjectLocationLbRouteExtensionPatchCall), [*locations lb traffic extensions create*](api::ProjectLocationLbTrafficExtensionCreateCall), [*locations lb traffic extensions delete*](api::ProjectLocationLbTrafficExtensionDeleteCall), [*locations lb traffic extensions get*](api::ProjectLocationLbTrafficExtensionGetCall), [*locations lb traffic extensions list*](api::ProjectLocationLbTrafficExtensionListCall), [*locations lb traffic extensions patch*](api::ProjectLocationLbTrafficExtensionPatchCall), [*locations list*](api::ProjectLocationListCall), [*locations meshes create*](api::ProjectLocationMeshCreateCall), [*locations meshes delete*](api::ProjectLocationMeshDeleteCall), [*locations meshes get*](api::ProjectLocationMeshGetCall), [*locations meshes list*](api::ProjectLocationMeshListCall), [*locations meshes patch*](api::ProjectLocationMeshPatchCall), [*locations meshes route views get*](api::ProjectLocationMeshRouteViewGetCall), [*locations meshes route views list*](api::ProjectLocationMeshRouteViewListCall), [*locations operations cancel*](api::ProjectLocationOperationCancelCall), [*locations operations delete*](api::ProjectLocationOperationDeleteCall), [*locations operations get*](api::ProjectLocationOperationGetCall), [*locations operations list*](api::ProjectLocationOperationListCall), [*locations service bindings create*](api::ProjectLocationServiceBindingCreateCall), [*locations service bindings delete*](api::ProjectLocationServiceBindingDeleteCall), [*locations service bindings get*](api::ProjectLocationServiceBindingGetCall), [*locations service bindings list*](api::ProjectLocationServiceBindingListCall), [*locations service bindings patch*](api::ProjectLocationServiceBindingPatchCall), [*locations service lb policies create*](api::ProjectLocationServiceLbPolicyCreateCall), [*locations service lb policies delete*](api::ProjectLocationServiceLbPolicyDeleteCall), [*locations service lb policies get*](api::ProjectLocationServiceLbPolicyGetCall), [*locations service lb policies list*](api::ProjectLocationServiceLbPolicyListCall), [*locations service lb policies patch*](api::ProjectLocationServiceLbPolicyPatchCall), [*locations tcp routes create*](api::ProjectLocationTcpRouteCreateCall), [*locations tcp routes delete*](api::ProjectLocationTcpRouteDeleteCall), [*locations tcp routes get*](api::ProjectLocationTcpRouteGetCall), [*locations tcp routes list*](api::ProjectLocationTcpRouteListCall), [*locations tcp routes patch*](api::ProjectLocationTcpRoutePatchCall), [*locations tls routes create*](api::ProjectLocationTlsRouteCreateCall), [*locations tls routes delete*](api::ProjectLocationTlsRouteDeleteCall), [*locations tls routes get*](api::ProjectLocationTlsRouteGetCall), [*locations tls routes list*](api::ProjectLocationTlsRouteListCall), [*locations tls routes patch*](api::ProjectLocationTlsRoutePatchCall), [*locations wasm plugins create*](api::ProjectLocationWasmPluginCreateCall), [*locations wasm plugins delete*](api::ProjectLocationWasmPluginDeleteCall), [*locations wasm plugins get*](api::ProjectLocationWasmPluginGetCall), [*locations wasm plugins list*](api::ProjectLocationWasmPluginListCall), [*locations wasm plugins patch*](api::ProjectLocationWasmPluginPatchCall), [*locations wasm plugins versions create*](api::ProjectLocationWasmPluginVersionCreateCall), [*locations wasm plugins versions delete*](api::ProjectLocationWasmPluginVersionDeleteCall), [*locations wasm plugins versions get*](api::ProjectLocationWasmPluginVersionGetCall) and [*locations wasm plugins versions list*](api::ProjectLocationWasmPluginVersionListCall)
//!
//!
//!
//!
//! Not what you are looking for ? Find all other Google APIs in their Rust [documentation index](http://byron.github.io/google-apis-rs).
//!
//! # Structure of this Library
//!
//! The API is structured into the following primary items:
//!
//! * **[Hub](NetworkServices)**
//!     * a central object to maintain state and allow accessing all *Activities*
//!     * creates [*Method Builders*](common::MethodsBuilder) which in turn
//!       allow access to individual [*Call Builders*](common::CallBuilder)
//! * **[Resources](common::Resource)**
//!     * primary types that you can apply *Activities* to
//!     * a collection of properties and *Parts*
//!     * **[Parts](common::Part)**
//!         * a collection of properties
//!         * never directly used in *Activities*
//! * **[Activities](common::CallBuilder)**
//!     * 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:
//!
//! ```Rust,ignore
//! let r = hub.resource().activity(...).doit().await
//! ```
//!
//! Or specifically ...
//!
//! ```ignore
//! let r = hub.projects().locations_authz_extensions_create(...).doit().await
//! let r = hub.projects().locations_authz_extensions_delete(...).doit().await
//! let r = hub.projects().locations_authz_extensions_patch(...).doit().await
//! 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_edge_extensions_create(...).doit().await
//! let r = hub.projects().locations_lb_edge_extensions_delete(...).doit().await
//! let r = hub.projects().locations_lb_edge_extensions_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_bindings_patch(...).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
//! let r = hub.projects().locations_wasm_plugins_versions_create(...).doit().await
//! let r = hub.projects().locations_wasm_plugins_versions_delete(...).doit().await
//! let r = hub.projects().locations_wasm_plugins_create(...).doit().await
//! let r = hub.projects().locations_wasm_plugins_delete(...).doit().await
//! let r = hub.projects().locations_wasm_plugins_patch(...).doit().await
//! ```
//!
//! The `resource()` and `activity(...)` calls create [builders][builder-pattern]. 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][builder-pattern] 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:
//!
//! ```toml
//! [dependencies]
//! google-networkservices1 = "*"
//! serde = "1"
//! serde_json = "1"
//! ```
//!
//! ## A complete example
//!
//! ```test_harness,no_run
//! extern crate hyper;
//! extern crate hyper_rustls;
//! extern crate google_networkservices1 as networkservices1;
//! use networkservices1::api::AuthzExtension;
//! use networkservices1::{Result, Error};
//! # async fn dox() {
//! 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 connector = hyper_rustls::HttpsConnectorBuilder::new()
//!     .with_native_roots()
//!     .unwrap()
//!     .https_only()
//!     .enable_http2()
//!     .build();
//!
//! let executor = hyper_util::rt::TokioExecutor::new();
//! let auth = yup_oauth2::InstalledFlowAuthenticator::with_client(
//!     secret,
//!     yup_oauth2::InstalledFlowReturnMethod::HTTPRedirect,
//!     yup_oauth2::client::CustomHyperClientBuilder::from(
//!         hyper_util::client::legacy::Client::builder(executor).build(connector),
//!     ),
//! ).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_http2()
//!         .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 = AuthzExtension::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_authz_extensions_create(req, "parent")
//!              .request_id("voluptua.")
//!              .authz_extension_id("At")
//!              .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](common::Result) enumeration as return value of
//! the doit() methods, or handed as possibly intermediate results to either the
//! [Hub Delegate](common::Delegate), or the [Authenticator Delegate](https://docs.rs/yup-oauth2/*/yup_oauth2/trait.AuthenticatorDelegate.html).
//!
//! 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](common::Result), should be
//! read by you to obtain the media.
//! If such a method also supports a [Response Result](common::ResponseResult), 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](common::Delegate) to the
//! [Method Builder](common::CallBuilder) 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](common::Delegate) 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](common::RequestValue) and
//! [decodable](common::ResponseResult) via *json*. Optionals are used to indicate that partial requests are responses
//! are valid.
//! Most optionals are are considered [Parts](common::Part) 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](common::CallBuilder), 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][wiki-pod] are handed by copy
//! * strings are passed as `&str`
//! * [request values](common::RequestValue) are moved
//!
//! Arguments will always be copied or cloned into the builder, to make them independent of their original life times.
//!
//! [wiki-pod]: http://en.wikipedia.org/wiki/Plain_old_data_structure
//! [builder-pattern]: http://en.wikipedia.org/wiki/Builder_pattern
//! [google-go-api]: https://github.com/google/google-api-go-client
//!
//! ## Cargo Features
//!
//! * `utoipa` - Add support for [utoipa](https://crates.io/crates/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.
//!
//!
//!

// Unused attributes happen thanks to defined, but unused structures We don't
// warn about this, as depending on the API, some data structures or facilities
// are never used. Instead of pre-determining this, we just disable the lint.
// It's manually tuned to not have any unused imports in fully featured APIs.
// Same with unused_mut.
#![allow(unused_imports, unused_mut, dead_code)]

// DO NOT EDIT !
// This file was generated automatically from 'src/generator/templates/api/lib.rs.mako'
// DO NOT EDIT !

pub extern crate hyper;
pub extern crate hyper_rustls;
pub extern crate hyper_util;
#[cfg(feature = "yup-oauth2")]
pub extern crate yup_oauth2;

pub extern crate google_apis_common as common;
pub use common::{Delegate, Error, FieldMask, Result};

pub mod api;
pub use api::NetworkServices;