OMGeeky/google-apis-rs
1
0
Fork 0
mirror of https://github.com/OMGeeky/google-apis-rs.git synced 2026-01-01 00:51:17 +01:00
Code Issues Packages Projects Releases Wiki Activity
Files
beaeeea41c9b7ddd3ac8e470a1a93e6fdc1962ed
google-apis-rs/gen/networksecurity1/README.md
Sebastian Thiel 1216fcf695 set version 5.0.4 and publish APIs
2024-03-05 21:02:48 +01:00

222 lines
24 KiB
Markdown
Raw Blame History

<!---
DO NOT EDIT !
This file was generated automatically from 'src/generator/templates/api/README.md.mako'
DO NOT EDIT !
-->
The `google-networksecurity1` library allows access to all features of the *Google NetworkSecurity* service.
This documentation was generated from *NetworkSecurity* crate version *5.0.4+20240221*, where *20240221* is the exact revision of the *networksecurity:v1* schema built by the [mako](http://www.makotemplates.org/) code generator *v5.0.4*.
Everything else about the *NetworkSecurity* *v1* API can be found at the
[official documentation site](https://cloud.google.com/networking).
# Features
Handle the following *Resources* with ease from the central [hub](https://docs.rs/google-networksecurity1/5.0.4+20240221/google_networksecurity1/NetworkSecurity) ...
* organizations
* [*locations address groups add items*](https://docs.rs/google-networksecurity1/5.0.4+20240221/google_networksecurity1/api::OrganizationLocationAddressGroupAddItemCall), [*locations address groups clone items*](https://docs.rs/google-networksecurity1/5.0.4+20240221/google_networksecurity1/api::OrganizationLocationAddressGroupCloneItemCall), [*locations address groups create*](https://docs.rs/google-networksecurity1/5.0.4+20240221/google_networksecurity1/api::OrganizationLocationAddressGroupCreateCall), [*locations address groups delete*](https://docs.rs/google-networksecurity1/5.0.4+20240221/google_networksecurity1/api::OrganizationLocationAddressGroupDeleteCall), [*locations address groups get*](https://docs.rs/google-networksecurity1/5.0.4+20240221/google_networksecurity1/api::OrganizationLocationAddressGroupGetCall), [*locations address groups list*](https://docs.rs/google-networksecurity1/5.0.4+20240221/google_networksecurity1/api::OrganizationLocationAddressGroupListCall), [*locations address groups list references*](https://docs.rs/google-networksecurity1/5.0.4+20240221/google_networksecurity1/api::OrganizationLocationAddressGroupListReferenceCall), [*locations address groups patch*](https://docs.rs/google-networksecurity1/5.0.4+20240221/google_networksecurity1/api::OrganizationLocationAddressGroupPatchCall), [*locations address groups remove items*](https://docs.rs/google-networksecurity1/5.0.4+20240221/google_networksecurity1/api::OrganizationLocationAddressGroupRemoveItemCall), [*locations operations cancel*](https://docs.rs/google-networksecurity1/5.0.4+20240221/google_networksecurity1/api::OrganizationLocationOperationCancelCall), [*locations operations delete*](https://docs.rs/google-networksecurity1/5.0.4+20240221/google_networksecurity1/api::OrganizationLocationOperationDeleteCall), [*locations operations get*](https://docs.rs/google-networksecurity1/5.0.4+20240221/google_networksecurity1/api::OrganizationLocationOperationGetCall) and [*locations operations list*](https://docs.rs/google-networksecurity1/5.0.4+20240221/google_networksecurity1/api::OrganizationLocationOperationListCall)
* projects
* [*locations address groups add items*](https://docs.rs/google-networksecurity1/5.0.4+20240221/google_networksecurity1/api::ProjectLocationAddressGroupAddItemCall), [*locations address groups clone items*](https://docs.rs/google-networksecurity1/5.0.4+20240221/google_networksecurity1/api::ProjectLocationAddressGroupCloneItemCall), [*locations address groups create*](https://docs.rs/google-networksecurity1/5.0.4+20240221/google_networksecurity1/api::ProjectLocationAddressGroupCreateCall), [*locations address groups delete*](https://docs.rs/google-networksecurity1/5.0.4+20240221/google_networksecurity1/api::ProjectLocationAddressGroupDeleteCall), [*locations address groups get*](https://docs.rs/google-networksecurity1/5.0.4+20240221/google_networksecurity1/api::ProjectLocationAddressGroupGetCall), [*locations address groups get iam policy*](https://docs.rs/google-networksecurity1/5.0.4+20240221/google_networksecurity1/api::ProjectLocationAddressGroupGetIamPolicyCall), [*locations address groups list*](https://docs.rs/google-networksecurity1/5.0.4+20240221/google_networksecurity1/api::ProjectLocationAddressGroupListCall), [*locations address groups list references*](https://docs.rs/google-networksecurity1/5.0.4+20240221/google_networksecurity1/api::ProjectLocationAddressGroupListReferenceCall), [*locations address groups patch*](https://docs.rs/google-networksecurity1/5.0.4+20240221/google_networksecurity1/api::ProjectLocationAddressGroupPatchCall), [*locations address groups remove items*](https://docs.rs/google-networksecurity1/5.0.4+20240221/google_networksecurity1/api::ProjectLocationAddressGroupRemoveItemCall), [*locations address groups set iam policy*](https://docs.rs/google-networksecurity1/5.0.4+20240221/google_networksecurity1/api::ProjectLocationAddressGroupSetIamPolicyCall), [*locations address groups test iam permissions*](https://docs.rs/google-networksecurity1/5.0.4+20240221/google_networksecurity1/api::ProjectLocationAddressGroupTestIamPermissionCall), [*locations authorization policies create*](https://docs.rs/google-networksecurity1/5.0.4+20240221/google_networksecurity1/api::ProjectLocationAuthorizationPolicyCreateCall), [*locations authorization policies delete*](https://docs.rs/google-networksecurity1/5.0.4+20240221/google_networksecurity1/api::ProjectLocationAuthorizationPolicyDeleteCall), [*locations authorization policies get*](https://docs.rs/google-networksecurity1/5.0.4+20240221/google_networksecurity1/api::ProjectLocationAuthorizationPolicyGetCall), [*locations authorization policies get iam policy*](https://docs.rs/google-networksecurity1/5.0.4+20240221/google_networksecurity1/api::ProjectLocationAuthorizationPolicyGetIamPolicyCall), [*locations authorization policies list*](https://docs.rs/google-networksecurity1/5.0.4+20240221/google_networksecurity1/api::ProjectLocationAuthorizationPolicyListCall), [*locations authorization policies patch*](https://docs.rs/google-networksecurity1/5.0.4+20240221/google_networksecurity1/api::ProjectLocationAuthorizationPolicyPatchCall), [*locations authorization policies set iam policy*](https://docs.rs/google-networksecurity1/5.0.4+20240221/google_networksecurity1/api::ProjectLocationAuthorizationPolicySetIamPolicyCall), [*locations authorization policies test iam permissions*](https://docs.rs/google-networksecurity1/5.0.4+20240221/google_networksecurity1/api::ProjectLocationAuthorizationPolicyTestIamPermissionCall), [*locations client tls policies create*](https://docs.rs/google-networksecurity1/5.0.4+20240221/google_networksecurity1/api::ProjectLocationClientTlsPolicyCreateCall), [*locations client tls policies delete*](https://docs.rs/google-networksecurity1/5.0.4+20240221/google_networksecurity1/api::ProjectLocationClientTlsPolicyDeleteCall), [*locations client tls policies get*](https://docs.rs/google-networksecurity1/5.0.4+20240221/google_networksecurity1/api::ProjectLocationClientTlsPolicyGetCall), [*locations client tls policies get iam policy*](https://docs.rs/google-networksecurity1/5.0.4+20240221/google_networksecurity1/api::ProjectLocationClientTlsPolicyGetIamPolicyCall), [*locations client tls policies list*](https://docs.rs/google-networksecurity1/5.0.4+20240221/google_networksecurity1/api::ProjectLocationClientTlsPolicyListCall), [*locations client tls policies patch*](https://docs.rs/google-networksecurity1/5.0.4+20240221/google_networksecurity1/api::ProjectLocationClientTlsPolicyPatchCall), [*locations client tls policies set iam policy*](https://docs.rs/google-networksecurity1/5.0.4+20240221/google_networksecurity1/api::ProjectLocationClientTlsPolicySetIamPolicyCall), [*locations client tls policies test iam permissions*](https://docs.rs/google-networksecurity1/5.0.4+20240221/google_networksecurity1/api::ProjectLocationClientTlsPolicyTestIamPermissionCall), [*locations gateway security policies create*](https://docs.rs/google-networksecurity1/5.0.4+20240221/google_networksecurity1/api::ProjectLocationGatewaySecurityPolicyCreateCall), [*locations gateway security policies delete*](https://docs.rs/google-networksecurity1/5.0.4+20240221/google_networksecurity1/api::ProjectLocationGatewaySecurityPolicyDeleteCall), [*locations gateway security policies get*](https://docs.rs/google-networksecurity1/5.0.4+20240221/google_networksecurity1/api::ProjectLocationGatewaySecurityPolicyGetCall), [*locations gateway security policies list*](https://docs.rs/google-networksecurity1/5.0.4+20240221/google_networksecurity1/api::ProjectLocationGatewaySecurityPolicyListCall), [*locations gateway security policies patch*](https://docs.rs/google-networksecurity1/5.0.4+20240221/google_networksecurity1/api::ProjectLocationGatewaySecurityPolicyPatchCall), [*locations gateway security policies rules create*](https://docs.rs/google-networksecurity1/5.0.4+20240221/google_networksecurity1/api::ProjectLocationGatewaySecurityPolicyRuleCreateCall), [*locations gateway security policies rules delete*](https://docs.rs/google-networksecurity1/5.0.4+20240221/google_networksecurity1/api::ProjectLocationGatewaySecurityPolicyRuleDeleteCall), [*locations gateway security policies rules get*](https://docs.rs/google-networksecurity1/5.0.4+20240221/google_networksecurity1/api::ProjectLocationGatewaySecurityPolicyRuleGetCall), [*locations gateway security policies rules list*](https://docs.rs/google-networksecurity1/5.0.4+20240221/google_networksecurity1/api::ProjectLocationGatewaySecurityPolicyRuleListCall), [*locations gateway security policies rules patch*](https://docs.rs/google-networksecurity1/5.0.4+20240221/google_networksecurity1/api::ProjectLocationGatewaySecurityPolicyRulePatchCall), [*locations get*](https://docs.rs/google-networksecurity1/5.0.4+20240221/google_networksecurity1/api::ProjectLocationGetCall), [*locations list*](https://docs.rs/google-networksecurity1/5.0.4+20240221/google_networksecurity1/api::ProjectLocationListCall), [*locations operations cancel*](https://docs.rs/google-networksecurity1/5.0.4+20240221/google_networksecurity1/api::ProjectLocationOperationCancelCall), [*locations operations delete*](https://docs.rs/google-networksecurity1/5.0.4+20240221/google_networksecurity1/api::ProjectLocationOperationDeleteCall), [*locations operations get*](https://docs.rs/google-networksecurity1/5.0.4+20240221/google_networksecurity1/api::ProjectLocationOperationGetCall), [*locations operations list*](https://docs.rs/google-networksecurity1/5.0.4+20240221/google_networksecurity1/api::ProjectLocationOperationListCall), [*locations server tls policies create*](https://docs.rs/google-networksecurity1/5.0.4+20240221/google_networksecurity1/api::ProjectLocationServerTlsPolicyCreateCall), [*locations server tls policies delete*](https://docs.rs/google-networksecurity1/5.0.4+20240221/google_networksecurity1/api::ProjectLocationServerTlsPolicyDeleteCall), [*locations server tls policies get*](https://docs.rs/google-networksecurity1/5.0.4+20240221/google_networksecurity1/api::ProjectLocationServerTlsPolicyGetCall), [*locations server tls policies get iam policy*](https://docs.rs/google-networksecurity1/5.0.4+20240221/google_networksecurity1/api::ProjectLocationServerTlsPolicyGetIamPolicyCall), [*locations server tls policies list*](https://docs.rs/google-networksecurity1/5.0.4+20240221/google_networksecurity1/api::ProjectLocationServerTlsPolicyListCall), [*locations server tls policies patch*](https://docs.rs/google-networksecurity1/5.0.4+20240221/google_networksecurity1/api::ProjectLocationServerTlsPolicyPatchCall), [*locations server tls policies set iam policy*](https://docs.rs/google-networksecurity1/5.0.4+20240221/google_networksecurity1/api::ProjectLocationServerTlsPolicySetIamPolicyCall), [*locations server tls policies test iam permissions*](https://docs.rs/google-networksecurity1/5.0.4+20240221/google_networksecurity1/api::ProjectLocationServerTlsPolicyTestIamPermissionCall), [*locations tls inspection policies create*](https://docs.rs/google-networksecurity1/5.0.4+20240221/google_networksecurity1/api::ProjectLocationTlsInspectionPolicyCreateCall), [*locations tls inspection policies delete*](https://docs.rs/google-networksecurity1/5.0.4+20240221/google_networksecurity1/api::ProjectLocationTlsInspectionPolicyDeleteCall), [*locations tls inspection policies get*](https://docs.rs/google-networksecurity1/5.0.4+20240221/google_networksecurity1/api::ProjectLocationTlsInspectionPolicyGetCall), [*locations tls inspection policies list*](https://docs.rs/google-networksecurity1/5.0.4+20240221/google_networksecurity1/api::ProjectLocationTlsInspectionPolicyListCall), [*locations tls inspection policies patch*](https://docs.rs/google-networksecurity1/5.0.4+20240221/google_networksecurity1/api::ProjectLocationTlsInspectionPolicyPatchCall), [*locations url lists create*](https://docs.rs/google-networksecurity1/5.0.4+20240221/google_networksecurity1/api::ProjectLocationUrlListCreateCall), [*locations url lists delete*](https://docs.rs/google-networksecurity1/5.0.4+20240221/google_networksecurity1/api::ProjectLocationUrlListDeleteCall), [*locations url lists get*](https://docs.rs/google-networksecurity1/5.0.4+20240221/google_networksecurity1/api::ProjectLocationUrlListGetCall), [*locations url lists list*](https://docs.rs/google-networksecurity1/5.0.4+20240221/google_networksecurity1/api::ProjectLocationUrlListListCall) and [*locations url lists patch*](https://docs.rs/google-networksecurity1/5.0.4+20240221/google_networksecurity1/api::ProjectLocationUrlListPatchCall)
# Structure of this Library
The API is structured into the following primary items:
* **[Hub](https://docs.rs/google-networksecurity1/5.0.4+20240221/google_networksecurity1/NetworkSecurity)**
* a central object to maintain state and allow accessing all *Activities*
* creates [*Method Builders*](https://docs.rs/google-networksecurity1/5.0.4+20240221/google_networksecurity1/client::MethodsBuilder) which in turn
allow access to individual [*Call Builders*](https://docs.rs/google-networksecurity1/5.0.4+20240221/google_networksecurity1/client::CallBuilder)
* **[Resources](https://docs.rs/google-networksecurity1/5.0.4+20240221/google_networksecurity1/client::Resource)**
* primary types that you can apply *Activities* to
* a collection of properties and *Parts*
* **[Parts](https://docs.rs/google-networksecurity1/5.0.4+20240221/google_networksecurity1/client::Part)**
* a collection of properties
* never directly used in *Activities*
* **[Activities](https://docs.rs/google-networksecurity1/5.0.4+20240221/google_networksecurity1/client::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_operations_get(...).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_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.0"
serde_json = "^1.0"
```
## A complete example
```Rust
extern crate hyper;
extern crate hyper_rustls;
extern crate google_networksecurity1 as networksecurity1;
use networksecurity1::api::AddressGroup;
use networksecurity1::{Result, Error};
use std::default::Default;
use networksecurity1::{NetworkSecurity, oauth2, hyper, hyper_rustls, chrono, FieldMask};
// Get an ApplicationSecret instance by some means. It contains the `client_id` and
// `client_secret`, among other things.
let secret: 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 = oauth2::InstalledFlowAuthenticator::builder(
secret,
oauth2::InstalledFlowReturnMethod::HTTPRedirect,
).build().await.unwrap();
let mut hub = NetworkSecurity::new(hyper::Client::builder().build(hyper_rustls::HttpsConnectorBuilder::new().with_native_roots().https_or_http().enable_http1().build()), 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("magna")
.address_group_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](https://docs.rs/google-networksecurity1/5.0.4+20240221/google_networksecurity1/client::Result) enumeration as return value of
the doit() methods, or handed as possibly intermediate results to either the
[Hub Delegate](https://docs.rs/google-networksecurity1/5.0.4+20240221/google_networksecurity1/client::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](https://docs.rs/google-networksecurity1/5.0.4+20240221/google_networksecurity1/client::Result), should be
read by you to obtain the media.
If such a method also supports a [Response Result](https://docs.rs/google-networksecurity1/5.0.4+20240221/google_networksecurity1/client::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](https://docs.rs/google-networksecurity1/5.0.4+20240221/google_networksecurity1/client::Delegate) to the
[Method Builder](https://docs.rs/google-networksecurity1/5.0.4+20240221/google_networksecurity1/client::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](https://docs.rs/google-networksecurity1/5.0.4+20240221/google_networksecurity1/client::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](https://docs.rs/google-networksecurity1/5.0.4+20240221/google_networksecurity1/client::RequestValue) and
[decodable](https://docs.rs/google-networksecurity1/5.0.4+20240221/google_networksecurity1/client::ResponseResult) via *json*. Optionals are used to indicate that partial requests are responses
are valid.
Most optionals are are considered [Parts](https://docs.rs/google-networksecurity1/5.0.4+20240221/google_networksecurity1/client::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](https://docs.rs/google-networksecurity1/5.0.4+20240221/google_networksecurity1/client::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](https://docs.rs/google-networksecurity1/5.0.4+20240221/google_networksecurity1/client::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
# License
The **networksecurity1** 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][repo-license].
[repo-license]: https://github.com/Byron/google-apis-rsblob/main/LICENSE.md
Reference in New Issue View Git Blame Copy Permalink