google-networkmanagement1 库允许访问 Google 网络管理服务的所有功能。

此文档是从 网络管理 crate 版本 5.0.5+20240619 生成的，其中 20240619 是由 mako 代码生成器 v5.0.5 构建的 networkmanagement:v1 模式的确切修订。

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

功能

从中央 中心 ...

• 项目
• 获取位置，创建位置全局连通性测试，删除位置全局连通性测试，获取位置全局连通性测试，获取位置全局连通性测试 IAM 策略，列出位置全局连通性测试，修补位置全局连通性测试，重新运行位置全局连通性测试，设置位置全局连通性测试 IAM 策略，测试位置全局连通性测试 IAM 权限，取消位置全局操作，删除位置全局操作，获取位置全局操作，列出位置全局操作 和 列出位置

库结构

API 结构如下主要项目

• 中心
  • 一个中央对象，用于维护状态并允许访问所有 活动
  • 创建 方法构建器，该构建器进而允许访问单个 调用构建器
• 资源
  • 主要类型，可以将 活动 应用到这些类型上
  • 属性和 部分 的集合
  • 部分
    • 属性的集合
    • 通常不直接在 活动中 使用
• 活动
  • 应用到 资源 上的操作

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

一般来说，您可以调用 活动 如此...

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

或者具体来说...

let r = hub.projects().locations_global_connectivity_tests_create(...).doit().await
let r = hub.projects().locations_global_connectivity_tests_delete(...).doit().await
let r = hub.projects().locations_global_connectivity_tests_patch(...).doit().await
let r = hub.projects().locations_global_connectivity_tests_rerun(...).doit().await
let r = hub.projects().locations_global_operations_get(...).doit().await

resource 和 activity 调用创建 构建器。第二个与 Activities 处理有关，支持配置即将进行的操作（此处未显示）。它确保所有必需的参数都立即指定，而可选参数可以根据需要构建。doit 方法执行与服务器实际通信，并返回相应的结果。

用法

设置您的项目

要使用这个库，您需要将以下几行代码放入您的 Cargo.toml 文件中

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

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_networkmanagement1 as networkmanagement1;
use networkmanagement1::api::ConnectivityTest;
use networkmanagement1::{Result, Error};
use std::default::Default;
use networkmanagement1::{NetworkManagement, 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 = NetworkManagement::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 = ConnectivityTest::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_global_connectivity_tests_create(req, "parent")
             .test_id("magna")
             .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() 调用之前将 delegate 传递给 Method Builder 来改变 doit() 方法的调用方式。相应的方程序将调用以提供进度信息，并确定系统在失败时是否应该重试。

delegate trait 有默认实现，允许您以最少的努力进行定制。

服务器请求中的可选部分

此库提供的所有结构都是为了通过 json 进行 encodable 和 decodable。可选部分用于表示部分请求或响应是有效的。大多数可选部分都是可识别的 Parts，可以通过名称识别，将它们发送到服务器以指示请求的设置部分或响应中希望的部分。

构建器参数

通过 method builders，您可以通过重复调用它的方法来准备一个操作调用。这些方法将始终接受一个参数，以下是一些关于该参数的说明。

• PODs 通过复制传递
• 字符串以 &str 的形式传递
• 请求值 被移动

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

Cargo 功能

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

许可证

networkmanagement1 库是由 Sebastian Thiel 生成的，并置于 MIT 许可证之下。您可以在存储库的 许可证文件 中阅读全文。