google-networksecurity1库允许访问Google NetworkSecurity服务的所有功能。

本文档由NetworkSecurity crate版本5.0.5+20240606生成，其中20240606是mako代码生成器v5.0.5构建的networksecurity:v1模式的精确版本。

关于NetworkSecurity v1 API的其他所有信息，请参阅官方文档网站。

功能

从中心枢纽轻松处理以下资源...

• 组织
• 地址组添加项，地址组克隆项，创建地址组，删除地址组，获取地址组，列出地址组，列出地址组引用，修补地址组，删除地址组项，创建防火墙端点，删除防火墙端点，获取防火墙端点，列出防火墙端点，修补防火墙端点，取消操作，删除操作，获取操作，列出操作，创建安全配置文件组，删除安全配置文件组，获取安全配置文件组，列出安全配置文件组，修补安全配置文件组，创建安全配置文件，删除安全配置文件，获取安全配置文件，列出安全配置文件和修补安全配置文件
• 项目
• locations address groups add items, locations address groups clone items, locations address groups create, locations address groups delete, locations address groups get, locations address groups get iam policy, locations address groups list, locations address groups list references, locations address groups patch, locations address groups remove items, locations address groups set iam policy, locations address groups test iam permissions, locations authorization policies create, locations authorization policies delete, locations authorization policies get, locations authorization policies get iam policy, locations authorization policies list, locations authorization policies patch, locations authorization policies set iam policy, locations authorization policies test iam permissions, locations client tls policies create, locations client tls policies delete, locations client tls policies get, locations client tls policies get iam policy, locations client tls policies list, locations client tls policies patch, locations client tls policies set iam policy, locations client tls policies test iam permissions, locations firewall endpoint associations create, locations firewall endpoint associations delete, locations firewall endpoint associations get, locations firewall endpoint associations list, locations firewall endpoint associations patch, locations gateway security policies create, locations gateway security policies delete, locations gateway security policies get, locations gateway security policies list, locations gateway security policies patch, locations gateway security policies rules create, locations gateway security policies rules delete, locations gateway security policies rules get, locations gateway security policies rules list, locations gateway security policies rules patch, locations get, locations list, locations operations cancel, locations operations delete, locations operations get, locations operations list, locations server tls policies create, locations server tls policies delete, locations server tls policies get, locations server tls policies get iam policy, locations server tls policies list, locations server tls policies patch, locations server tls policies set iam policy, locations server tls policies test iam permissions, locations tls inspection policies create, locations tls inspection policies delete, locations tls inspection policies get, locations tls inspection policies list, locations tls inspection policies patch, locations url lists create, locations url lists delete, locations url lists get, locations url lists list and locations url lists patch

本库的结构

API结构如下主要项

• 中心
  • 一个中心对象，用于维护状态并允许访问所有活动
  • 创建 方法构建器，进而允许访问单个 调用构建器
• 资源
  • 可以应用 活动 的主要类型
  • 一系列属性和 部分
  • 部分
    • 一系列属性
    • 从未在 活动 中直接使用
• 活动
  • 应用于 资源 的操作

所有 结构 都带有适用特质，以进一步分类它们并方便浏览。

一般来说，您可以这样调用 活动

let r = hub.resource().activity(...).doit().await

或者具体...

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

resource() 和 activity(...) 调用创建 构建器。第二个处理 Activities，支持各种配置即将进行的操作（此处未显示）的方法。它是这样设计的，即所有必需的参数必须立即指定（即 (...)），而所有可选的都可以按需 构建。doit() 方法执行与服务器的实际通信并返回相应的结果。

使用方法

设置您的项目

要使用此库，您需要将以下行放入您的 Cargo.toml 文件中

[dependencies]
google-networksecurity1 = "*"
serde = "^1.0"
serde_json = "^1.0"

一个完整的示例

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().unwrap().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),
}

处理错误

系统产生的所有错误都作为 Result 枚举提供，作为 doit() 方法的返回值，或者作为可能的中继结果传递给 Hub Delegate 或 Authenticator Delegate。

当代理处理错误或中间值时，它们可能会有机会指示系统重试。这使得系统可能对所有类型的错误都具有弹性。

上传和下载

如果方法支持下载，则应该由您读取响应体（它是 Result 的一部分）以获取媒体。如果此类方法还支持 Response Result，则默认情况下会返回该结果。您可以将其视为实际媒体的元数据。要触发媒体下载，您必须通过此调用设置构建器：.param("alt", "media")。

支持上传的方法可以使用多达 2 种不同的协议进行上传：简单 和 可恢复。每种协议的独特之处由定制的 doit(...) 方法表示，分别命名为 upload(...) 和 upload_resumable(...)。

自定义和回调

您可以通过在执行最终的 doit() 调用之前，向 方法构建器 提供一个 代理 来更改 doit() 方法调用的方式。相应的函数将被调用以提供进度信息，并确定系统在失败时是否应该重试。

代理特质 默认实现，让您可以以最小的努力对其进行自定义。

服务器请求中的可选部分

此库提供的所有结构都旨在通过 json 进行 编码 和 解码。可选项用于表示部分请求和响应都是有效的。大多数可选项都是 部分，可以通过名称识别，这些部分将发送到服务器以指示请求的设置部分或响应中所需的部分。

构建器参数

使用 方法构建器，您可以通过反复调用其方法来准备一个操作调用。这些方法始终接受单个参数，以下陈述对此适用。

• POD 通过复制传递
• 字符串作为 &str 传递
• 请求值 被移动

参数将始终被复制或克隆到构建器中，以确保它们与其原始生命周期独立。

Cargo 特性

• utoipa - 添加对 utoipa 的支持，并在所有类型上派生 utoipa::ToSchema。您必须在 #[openapi(schemas(...))] 中导入和注册所需的类型，否则生成的 openapi 规范将是无效的。

许可证

networksecurity1 库由 Sebastian Thiel 创建，并置于 MIT 许可证之下。您可以在存储库的 许可证文件 中阅读全文。