google_networksecurity1/

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 *NetworkSecurity* crate version *6.0.0+20240606*, where *20240606* is the exact revision of the *networksecurity:v1* schema built by the [mako](http://www.makotemplates.org/) code generator *v6.0.0*.
//!
//! Everything else about the *NetworkSecurity* *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/networksecurity1).
//! # Features
//!
//! Handle the following *Resources* with ease from the central [hub](NetworkSecurity) ...
//!
//! * organizations
//!  * [*locations address groups add items*](api::OrganizationLocationAddressGroupAddItemCall), [*locations address groups clone items*](api::OrganizationLocationAddressGroupCloneItemCall), [*locations address groups create*](api::OrganizationLocationAddressGroupCreateCall), [*locations address groups delete*](api::OrganizationLocationAddressGroupDeleteCall), [*locations address groups get*](api::OrganizationLocationAddressGroupGetCall), [*locations address groups list*](api::OrganizationLocationAddressGroupListCall), [*locations address groups list references*](api::OrganizationLocationAddressGroupListReferenceCall), [*locations address groups patch*](api::OrganizationLocationAddressGroupPatchCall), [*locations address groups remove items*](api::OrganizationLocationAddressGroupRemoveItemCall), [*locations firewall endpoints create*](api::OrganizationLocationFirewallEndpointCreateCall), [*locations firewall endpoints delete*](api::OrganizationLocationFirewallEndpointDeleteCall), [*locations firewall endpoints get*](api::OrganizationLocationFirewallEndpointGetCall), [*locations firewall endpoints list*](api::OrganizationLocationFirewallEndpointListCall), [*locations firewall endpoints patch*](api::OrganizationLocationFirewallEndpointPatchCall), [*locations operations cancel*](api::OrganizationLocationOperationCancelCall), [*locations operations delete*](api::OrganizationLocationOperationDeleteCall), [*locations operations get*](api::OrganizationLocationOperationGetCall), [*locations operations list*](api::OrganizationLocationOperationListCall), [*locations security profile groups create*](api::OrganizationLocationSecurityProfileGroupCreateCall), [*locations security profile groups delete*](api::OrganizationLocationSecurityProfileGroupDeleteCall), [*locations security profile groups get*](api::OrganizationLocationSecurityProfileGroupGetCall), [*locations security profile groups list*](api::OrganizationLocationSecurityProfileGroupListCall), [*locations security profile groups patch*](api::OrganizationLocationSecurityProfileGroupPatchCall), [*locations security profiles create*](api::OrganizationLocationSecurityProfileCreateCall), [*locations security profiles delete*](api::OrganizationLocationSecurityProfileDeleteCall), [*locations security profiles get*](api::OrganizationLocationSecurityProfileGetCall), [*locations security profiles list*](api::OrganizationLocationSecurityProfileListCall) and [*locations security profiles patch*](api::OrganizationLocationSecurityProfilePatchCall)
//! * projects
//!  * [*locations address groups add items*](api::ProjectLocationAddressGroupAddItemCall), [*locations address groups clone items*](api::ProjectLocationAddressGroupCloneItemCall), [*locations address groups create*](api::ProjectLocationAddressGroupCreateCall), [*locations address groups delete*](api::ProjectLocationAddressGroupDeleteCall), [*locations address groups get*](api::ProjectLocationAddressGroupGetCall), [*locations address groups get iam policy*](api::ProjectLocationAddressGroupGetIamPolicyCall), [*locations address groups list*](api::ProjectLocationAddressGroupListCall), [*locations address groups list references*](api::ProjectLocationAddressGroupListReferenceCall), [*locations address groups patch*](api::ProjectLocationAddressGroupPatchCall), [*locations address groups remove items*](api::ProjectLocationAddressGroupRemoveItemCall), [*locations address groups set iam policy*](api::ProjectLocationAddressGroupSetIamPolicyCall), [*locations address groups test iam permissions*](api::ProjectLocationAddressGroupTestIamPermissionCall), [*locations authorization policies create*](api::ProjectLocationAuthorizationPolicyCreateCall), [*locations authorization policies delete*](api::ProjectLocationAuthorizationPolicyDeleteCall), [*locations authorization policies get*](api::ProjectLocationAuthorizationPolicyGetCall), [*locations authorization policies get iam policy*](api::ProjectLocationAuthorizationPolicyGetIamPolicyCall), [*locations authorization policies list*](api::ProjectLocationAuthorizationPolicyListCall), [*locations authorization policies patch*](api::ProjectLocationAuthorizationPolicyPatchCall), [*locations authorization policies set iam policy*](api::ProjectLocationAuthorizationPolicySetIamPolicyCall), [*locations authorization policies test iam permissions*](api::ProjectLocationAuthorizationPolicyTestIamPermissionCall), [*locations client tls policies create*](api::ProjectLocationClientTlsPolicyCreateCall), [*locations client tls policies delete*](api::ProjectLocationClientTlsPolicyDeleteCall), [*locations client tls policies get*](api::ProjectLocationClientTlsPolicyGetCall), [*locations client tls policies get iam policy*](api::ProjectLocationClientTlsPolicyGetIamPolicyCall), [*locations client tls policies list*](api::ProjectLocationClientTlsPolicyListCall), [*locations client tls policies patch*](api::ProjectLocationClientTlsPolicyPatchCall), [*locations client tls policies set iam policy*](api::ProjectLocationClientTlsPolicySetIamPolicyCall), [*locations client tls policies test iam permissions*](api::ProjectLocationClientTlsPolicyTestIamPermissionCall), [*locations firewall endpoint associations create*](api::ProjectLocationFirewallEndpointAssociationCreateCall), [*locations firewall endpoint associations delete*](api::ProjectLocationFirewallEndpointAssociationDeleteCall), [*locations firewall endpoint associations get*](api::ProjectLocationFirewallEndpointAssociationGetCall), [*locations firewall endpoint associations list*](api::ProjectLocationFirewallEndpointAssociationListCall), [*locations firewall endpoint associations patch*](api::ProjectLocationFirewallEndpointAssociationPatchCall), [*locations gateway security policies create*](api::ProjectLocationGatewaySecurityPolicyCreateCall), [*locations gateway security policies delete*](api::ProjectLocationGatewaySecurityPolicyDeleteCall), [*locations gateway security policies get*](api::ProjectLocationGatewaySecurityPolicyGetCall), [*locations gateway security policies list*](api::ProjectLocationGatewaySecurityPolicyListCall), [*locations gateway security policies patch*](api::ProjectLocationGatewaySecurityPolicyPatchCall), [*locations gateway security policies rules create*](api::ProjectLocationGatewaySecurityPolicyRuleCreateCall), [*locations gateway security policies rules delete*](api::ProjectLocationGatewaySecurityPolicyRuleDeleteCall), [*locations gateway security policies rules get*](api::ProjectLocationGatewaySecurityPolicyRuleGetCall), [*locations gateway security policies rules list*](api::ProjectLocationGatewaySecurityPolicyRuleListCall), [*locations gateway security policies rules patch*](api::ProjectLocationGatewaySecurityPolicyRulePatchCall), [*locations get*](api::ProjectLocationGetCall), [*locations list*](api::ProjectLocationListCall), [*locations operations cancel*](api::ProjectLocationOperationCancelCall), [*locations operations delete*](api::ProjectLocationOperationDeleteCall), [*locations operations get*](api::ProjectLocationOperationGetCall), [*locations operations list*](api::ProjectLocationOperationListCall), [*locations server tls policies create*](api::ProjectLocationServerTlsPolicyCreateCall), [*locations server tls policies delete*](api::ProjectLocationServerTlsPolicyDeleteCall), [*locations server tls policies get*](api::ProjectLocationServerTlsPolicyGetCall), [*locations server tls policies get iam policy*](api::ProjectLocationServerTlsPolicyGetIamPolicyCall), [*locations server tls policies list*](api::ProjectLocationServerTlsPolicyListCall), [*locations server tls policies patch*](api::ProjectLocationServerTlsPolicyPatchCall), [*locations server tls policies set iam policy*](api::ProjectLocationServerTlsPolicySetIamPolicyCall), [*locations server tls policies test iam permissions*](api::ProjectLocationServerTlsPolicyTestIamPermissionCall), [*locations tls inspection policies create*](api::ProjectLocationTlsInspectionPolicyCreateCall), [*locations tls inspection policies delete*](api::ProjectLocationTlsInspectionPolicyDeleteCall), [*locations tls inspection policies get*](api::ProjectLocationTlsInspectionPolicyGetCall), [*locations tls inspection policies list*](api::ProjectLocationTlsInspectionPolicyListCall), [*locations tls inspection policies patch*](api::ProjectLocationTlsInspectionPolicyPatchCall), [*locations url lists create*](api::ProjectLocationUrlListCreateCall), [*locations url lists delete*](api::ProjectLocationUrlListDeleteCall), [*locations url lists get*](api::ProjectLocationUrlListGetCall), [*locations url lists list*](api::ProjectLocationUrlListListCall) and [*locations url lists patch*](api::ProjectLocationUrlListPatchCall)
//!
//!
//!
//!
//! 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](NetworkSecurity)**
//!     * 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.organizations().locations_address_groups_add_items(...).doit().await
//! let r = hub.organizations().locations_address_groups_clone_items(...).doit().await
//! let r = hub.organizations().locations_address_groups_create(...).doit().await
//! let r = hub.organizations().locations_address_groups_delete(...).doit().await
//! let r = hub.organizations().locations_address_groups_patch(...).doit().await
//! let r = hub.organizations().locations_address_groups_remove_items(...).doit().await
//! let r = hub.organizations().locations_firewall_endpoints_create(...).doit().await
//! let r = hub.organizations().locations_firewall_endpoints_delete(...).doit().await
//! let r = hub.organizations().locations_firewall_endpoints_patch(...).doit().await
//! let r = hub.organizations().locations_operations_get(...).doit().await
//! let r = hub.organizations().locations_security_profile_groups_create(...).doit().await
//! let r = hub.organizations().locations_security_profile_groups_delete(...).doit().await
//! let r = hub.organizations().locations_security_profile_groups_patch(...).doit().await
//! let r = hub.organizations().locations_security_profiles_create(...).doit().await
//! let r = hub.organizations().locations_security_profiles_delete(...).doit().await
//! let r = hub.organizations().locations_security_profiles_patch(...).doit().await
//! let r = hub.projects().locations_address_groups_add_items(...).doit().await
//! let r = hub.projects().locations_address_groups_clone_items(...).doit().await
//! let r = hub.projects().locations_address_groups_create(...).doit().await
//! let r = hub.projects().locations_address_groups_delete(...).doit().await
//! let r = hub.projects().locations_address_groups_patch(...).doit().await
//! let r = hub.projects().locations_address_groups_remove_items(...).doit().await
//! let r = hub.projects().locations_authorization_policies_create(...).doit().await
//! let r = hub.projects().locations_authorization_policies_delete(...).doit().await
//! let r = hub.projects().locations_authorization_policies_patch(...).doit().await
//! let r = hub.projects().locations_client_tls_policies_create(...).doit().await
//! let r = hub.projects().locations_client_tls_policies_delete(...).doit().await
//! let r = hub.projects().locations_client_tls_policies_patch(...).doit().await
//! let r = hub.projects().locations_firewall_endpoint_associations_create(...).doit().await
//! let r = hub.projects().locations_firewall_endpoint_associations_delete(...).doit().await
//! let r = hub.projects().locations_firewall_endpoint_associations_patch(...).doit().await
//! let r = hub.projects().locations_gateway_security_policies_rules_create(...).doit().await
//! let r = hub.projects().locations_gateway_security_policies_rules_delete(...).doit().await
//! let r = hub.projects().locations_gateway_security_policies_rules_patch(...).doit().await
//! let r = hub.projects().locations_gateway_security_policies_create(...).doit().await
//! let r = hub.projects().locations_gateway_security_policies_delete(...).doit().await
//! let r = hub.projects().locations_gateway_security_policies_patch(...).doit().await
//! let r = hub.projects().locations_operations_get(...).doit().await
//! let r = hub.projects().locations_server_tls_policies_create(...).doit().await
//! let r = hub.projects().locations_server_tls_policies_delete(...).doit().await
//! let r = hub.projects().locations_server_tls_policies_patch(...).doit().await
//! let r = hub.projects().locations_tls_inspection_policies_create(...).doit().await
//! let r = hub.projects().locations_tls_inspection_policies_delete(...).doit().await
//! let r = hub.projects().locations_tls_inspection_policies_patch(...).doit().await
//! let r = hub.projects().locations_url_lists_create(...).doit().await
//! let r = hub.projects().locations_url_lists_delete(...).doit().await
//! let r = hub.projects().locations_url_lists_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-networksecurity1 = "*"
//! serde = "1"
//! serde_json = "1"
//! ```
//!
//! ## A complete example
//!
//! ```test_harness,no_run
//! extern crate hyper;
//! extern crate hyper_rustls;
//! extern crate google_networksecurity1 as networksecurity1;
//! use networksecurity1::api::AddressGroup;
//! use networksecurity1::{Result, Error};
//! # async fn dox() {
//! use networksecurity1::{NetworkSecurity, 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 = NetworkSecurity::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 = AddressGroup::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.organizations().locations_address_groups_create(req, "parent")
//!              .request_id("voluptua.")
//!              .address_group_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::NetworkSecurity;