google-networkconnectivity1 7.0.0+20251209

A complete library to interact with networkconnectivity (protocol v1)
Documentation
// DO NOT EDIT !
// This file was generated automatically from 'src/generator/templates/api/lib.rs.mako'
// DO NOT EDIT !

//! This documentation was generated from *networkconnectivity* crate version *7.0.0+20251209*, where *20251209* is the exact revision of the *networkconnectivity:v1* schema built by the [mako](http://www.makotemplates.org/) code generator *v7.0.0*.
//!
//! Everything else about the *networkconnectivity* *v1* API can be found at the
//! [official documentation site](https://cloud.google.com/network-connectivity/docs/reference/networkconnectivity/rest).
//! The original source code is [on github](https://github.com/Byron/google-apis-rs/tree/main/gen/networkconnectivity1).
//! # Features
//!
//! Handle the following *Resources* with ease from the central [hub](Networkconnectivity) ...
//!
//! * projects
//!  * [*locations check consumer config*](api::ProjectLocationCheckConsumerConfigCall), [*locations get*](api::ProjectLocationGetCall), [*locations global hubs accept spoke*](api::ProjectLocationGlobalHubAcceptSpokeCall), [*locations global hubs accept spoke update*](api::ProjectLocationGlobalHubAcceptSpokeUpdateCall), [*locations global hubs create*](api::ProjectLocationGlobalHubCreateCall), [*locations global hubs delete*](api::ProjectLocationGlobalHubDeleteCall), [*locations global hubs get*](api::ProjectLocationGlobalHubGetCall), [*locations global hubs get iam policy*](api::ProjectLocationGlobalHubGetIamPolicyCall), [*locations global hubs groups get*](api::ProjectLocationGlobalHubGroupGetCall), [*locations global hubs groups get iam policy*](api::ProjectLocationGlobalHubGroupGetIamPolicyCall), [*locations global hubs groups list*](api::ProjectLocationGlobalHubGroupListCall), [*locations global hubs groups patch*](api::ProjectLocationGlobalHubGroupPatchCall), [*locations global hubs groups set iam policy*](api::ProjectLocationGlobalHubGroupSetIamPolicyCall), [*locations global hubs groups test iam permissions*](api::ProjectLocationGlobalHubGroupTestIamPermissionCall), [*locations global hubs list*](api::ProjectLocationGlobalHubListCall), [*locations global hubs list spokes*](api::ProjectLocationGlobalHubListSpokeCall), [*locations global hubs patch*](api::ProjectLocationGlobalHubPatchCall), [*locations global hubs query status*](api::ProjectLocationGlobalHubQueryStatuCall), [*locations global hubs reject spoke*](api::ProjectLocationGlobalHubRejectSpokeCall), [*locations global hubs reject spoke update*](api::ProjectLocationGlobalHubRejectSpokeUpdateCall), [*locations global hubs route tables get*](api::ProjectLocationGlobalHubRouteTableGetCall), [*locations global hubs route tables list*](api::ProjectLocationGlobalHubRouteTableListCall), [*locations global hubs route tables routes get*](api::ProjectLocationGlobalHubRouteTableRouteGetCall), [*locations global hubs route tables routes list*](api::ProjectLocationGlobalHubRouteTableRouteListCall), [*locations global hubs set iam policy*](api::ProjectLocationGlobalHubSetIamPolicyCall), [*locations global hubs test iam permissions*](api::ProjectLocationGlobalHubTestIamPermissionCall), [*locations global policy based routes create*](api::ProjectLocationGlobalPolicyBasedRouteCreateCall), [*locations global policy based routes delete*](api::ProjectLocationGlobalPolicyBasedRouteDeleteCall), [*locations global policy based routes get*](api::ProjectLocationGlobalPolicyBasedRouteGetCall), [*locations global policy based routes get iam policy*](api::ProjectLocationGlobalPolicyBasedRouteGetIamPolicyCall), [*locations global policy based routes list*](api::ProjectLocationGlobalPolicyBasedRouteListCall), [*locations global policy based routes set iam policy*](api::ProjectLocationGlobalPolicyBasedRouteSetIamPolicyCall), [*locations global policy based routes test iam permissions*](api::ProjectLocationGlobalPolicyBasedRouteTestIamPermissionCall), [*locations internal ranges create*](api::ProjectLocationInternalRangeCreateCall), [*locations internal ranges delete*](api::ProjectLocationInternalRangeDeleteCall), [*locations internal ranges get*](api::ProjectLocationInternalRangeGetCall), [*locations internal ranges get iam policy*](api::ProjectLocationInternalRangeGetIamPolicyCall), [*locations internal ranges list*](api::ProjectLocationInternalRangeListCall), [*locations internal ranges patch*](api::ProjectLocationInternalRangePatchCall), [*locations internal ranges set iam policy*](api::ProjectLocationInternalRangeSetIamPolicyCall), [*locations internal ranges test iam permissions*](api::ProjectLocationInternalRangeTestIamPermissionCall), [*locations list*](api::ProjectLocationListCall), [*locations multicloud data transfer configs create*](api::ProjectLocationMulticloudDataTransferConfigCreateCall), [*locations multicloud data transfer configs delete*](api::ProjectLocationMulticloudDataTransferConfigDeleteCall), [*locations multicloud data transfer configs destinations create*](api::ProjectLocationMulticloudDataTransferConfigDestinationCreateCall), [*locations multicloud data transfer configs destinations delete*](api::ProjectLocationMulticloudDataTransferConfigDestinationDeleteCall), [*locations multicloud data transfer configs destinations get*](api::ProjectLocationMulticloudDataTransferConfigDestinationGetCall), [*locations multicloud data transfer configs destinations list*](api::ProjectLocationMulticloudDataTransferConfigDestinationListCall), [*locations multicloud data transfer configs destinations patch*](api::ProjectLocationMulticloudDataTransferConfigDestinationPatchCall), [*locations multicloud data transfer configs get*](api::ProjectLocationMulticloudDataTransferConfigGetCall), [*locations multicloud data transfer configs list*](api::ProjectLocationMulticloudDataTransferConfigListCall), [*locations multicloud data transfer configs patch*](api::ProjectLocationMulticloudDataTransferConfigPatchCall), [*locations multicloud data transfer supported services get*](api::ProjectLocationMulticloudDataTransferSupportedServiceGetCall), [*locations multicloud data transfer supported services list*](api::ProjectLocationMulticloudDataTransferSupportedServiceListCall), [*locations operations cancel*](api::ProjectLocationOperationCancelCall), [*locations operations delete*](api::ProjectLocationOperationDeleteCall), [*locations operations get*](api::ProjectLocationOperationGetCall), [*locations operations list*](api::ProjectLocationOperationListCall), [*locations regional endpoints create*](api::ProjectLocationRegionalEndpointCreateCall), [*locations regional endpoints delete*](api::ProjectLocationRegionalEndpointDeleteCall), [*locations regional endpoints get*](api::ProjectLocationRegionalEndpointGetCall), [*locations regional endpoints list*](api::ProjectLocationRegionalEndpointListCall), [*locations service classes delete*](api::ProjectLocationServiceClassDeleteCall), [*locations service classes get*](api::ProjectLocationServiceClassGetCall), [*locations service classes get iam policy*](api::ProjectLocationServiceClassGetIamPolicyCall), [*locations service classes list*](api::ProjectLocationServiceClassListCall), [*locations service classes patch*](api::ProjectLocationServiceClassPatchCall), [*locations service classes set iam policy*](api::ProjectLocationServiceClassSetIamPolicyCall), [*locations service classes test iam permissions*](api::ProjectLocationServiceClassTestIamPermissionCall), [*locations service connection maps create*](api::ProjectLocationServiceConnectionMapCreateCall), [*locations service connection maps delete*](api::ProjectLocationServiceConnectionMapDeleteCall), [*locations service connection maps get*](api::ProjectLocationServiceConnectionMapGetCall), [*locations service connection maps get iam policy*](api::ProjectLocationServiceConnectionMapGetIamPolicyCall), [*locations service connection maps list*](api::ProjectLocationServiceConnectionMapListCall), [*locations service connection maps patch*](api::ProjectLocationServiceConnectionMapPatchCall), [*locations service connection maps set iam policy*](api::ProjectLocationServiceConnectionMapSetIamPolicyCall), [*locations service connection maps test iam permissions*](api::ProjectLocationServiceConnectionMapTestIamPermissionCall), [*locations service connection policies create*](api::ProjectLocationServiceConnectionPolicyCreateCall), [*locations service connection policies delete*](api::ProjectLocationServiceConnectionPolicyDeleteCall), [*locations service connection policies get*](api::ProjectLocationServiceConnectionPolicyGetCall), [*locations service connection policies get iam policy*](api::ProjectLocationServiceConnectionPolicyGetIamPolicyCall), [*locations service connection policies list*](api::ProjectLocationServiceConnectionPolicyListCall), [*locations service connection policies patch*](api::ProjectLocationServiceConnectionPolicyPatchCall), [*locations service connection policies set iam policy*](api::ProjectLocationServiceConnectionPolicySetIamPolicyCall), [*locations service connection policies test iam permissions*](api::ProjectLocationServiceConnectionPolicyTestIamPermissionCall), [*locations service connection tokens create*](api::ProjectLocationServiceConnectionTokenCreateCall), [*locations service connection tokens delete*](api::ProjectLocationServiceConnectionTokenDeleteCall), [*locations service connection tokens get*](api::ProjectLocationServiceConnectionTokenGetCall), [*locations service connection tokens list*](api::ProjectLocationServiceConnectionTokenListCall), [*locations spokes create*](api::ProjectLocationSpokeCreateCall), [*locations spokes delete*](api::ProjectLocationSpokeDeleteCall), [*locations spokes get*](api::ProjectLocationSpokeGetCall), [*locations spokes get iam policy*](api::ProjectLocationSpokeGetIamPolicyCall), [*locations spokes list*](api::ProjectLocationSpokeListCall), [*locations spokes patch*](api::ProjectLocationSpokePatchCall), [*locations spokes set iam policy*](api::ProjectLocationSpokeSetIamPolicyCall) and [*locations spokes test iam permissions*](api::ProjectLocationSpokeTestIamPermissionCall)
//!
//!
//!
//!
//! 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](Networkconnectivity)**
//!     * 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_global_hubs_groups_patch(...).doit().await
//! let r = hub.projects().locations_global_hubs_accept_spoke(...).doit().await
//! let r = hub.projects().locations_global_hubs_accept_spoke_update(...).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_hubs_reject_spoke_update(...).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_multicloud_data_transfer_configs_destinations_create(...).doit().await
//! let r = hub.projects().locations_multicloud_data_transfer_configs_destinations_delete(...).doit().await
//! let r = hub.projects().locations_multicloud_data_transfer_configs_destinations_patch(...).doit().await
//! let r = hub.projects().locations_multicloud_data_transfer_configs_create(...).doit().await
//! let r = hub.projects().locations_multicloud_data_transfer_configs_delete(...).doit().await
//! let r = hub.projects().locations_multicloud_data_transfer_configs_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][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-networkconnectivity1 = "*"
//! serde = "1"
//! serde_json = "1"
//! ```
//!
//! ## A complete example
//!
//! ```test_harness,no_run
//! extern crate hyper;
//! extern crate hyper_rustls;
//! extern crate google_networkconnectivity1 as networkconnectivity1;
//! use networkconnectivity1::api::ServiceConnectionPolicy;
//! use networkconnectivity1::{Result, Error};
//! # async fn dox() {
//! 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 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 = 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 = ServiceConnectionPolicy::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_service_connection_policies_create(req, "parent")
//!              .subnetwork_mode("amet.")
//!              .service_connection_policy_id("takimata")
//!              .request_id("amet.")
//!              .auto_subnetwork_config_prefix_length(-20)
//!              .auto_subnetwork_config_ip_stack("ipsum")
//!              .add_auto_subnetwork_config_alloc_range_space("gubergren")
//!              .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::Networkconnectivity;