google-networkconnectivity1_alpha1 库允许访问 Google 网络连接服务的所有功能。

本文档是根据 networkconnectivity crate 版本 5.0.5+20240618 生成的，其中 20240618 是由 mako 代码生成器 v5.0.5 构建的 networkconnectivity:v1alpha1 架构的确切修订版本。

有关 networkconnectivity v1_alpha1 API 的其他信息，请参阅 官方文档网站。

功能

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

• 项目
• locations get, locations global hubs create, locations global hubs delete, locations global hubs get, locations global hubs get iam policy, locations global hubs list, locations global hubs patch, locations global hubs set iam policy, locations global hubs test iam permissions, locations internal ranges create, locations internal ranges delete, locations internal ranges get, locations internal ranges get iam policy, locations internal ranges list, locations internal ranges patch, locations internal ranges set iam policy, locations internal ranges test iam permissions, locations list, locations operations cancel, locations operations delete, locations operations get, locations operations list, locations spokes create, locations spokes delete, locations spokes get, locations spokes get iam policy, locations spokes list, locations spokes patch, locations spokes set iam policy and locations spokes test iam permissions

本库的结构

API 结构如下主要项目

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

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

通常，您可以像这样调用 活动

let r = hub.resource().activity(...).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_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_operations_get(...).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

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

使用方法

设置您的项目

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

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

完整示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_networkconnectivity1_alpha1 as networkconnectivity1_alpha1;
use networkconnectivity1_alpha1::api::Hub;
use networkconnectivity1_alpha1::{Result, Error};
use std::default::Default;
use networkconnectivity1_alpha1::{Networkconnectivity, 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 = Networkconnectivity::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 = Hub::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_hubs_create(req, "parent")
             .request_id("magna")
             .hub_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(...)。

自定义和回调

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

代理 trait 默认实现，允许您以最少的努力对其进行自定义。

服务器请求中的可选部分

本库中提供的所有结构均设计为可通过 编码 和 解码 为 json 格式。使用可选类型（Optionals）来表示部分请求或响应是有效的。大多数可选类型都是 Parts，可以通过名称识别，这些将被发送到服务器，以指示请求的设置部分或响应中所需的部分。

构建器参数

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

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

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

Cargo 功能

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

许可

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