#network-connectivity #google #google-api #protocols

google-networkconnectivity1

一个完整的库,用于与networkconnectivity(协议v1)交互

8个版本 (稳定版)

5.0.5+20240618 2024年6月27日
5.0.4+20240221 2024年3月5日
5.0.3+20230105 2023年8月24日
5.0.2+20230105 2023年3月16日
3.0.0+20220210 2022年3月8日

#1959 in 网络编程

Download history 3/week @ 2024-05-19 89/week @ 2024-06-23 21/week @ 2024-06-30

每月473次 下载
用于 google-networkconnectivit…

MIT 许可证

1.5MB
16K SLoC

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

此文档是从networkconnectivity crate版本5.0.5+20240618生成的,其中20240618mako代码生成器v5.0.5构建的networkconnectivity:v1模式的精确修订。

关于networkconnectivity v1 API的所有其他信息都可以在官方文档站点找到。

特性

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

本库的结构

API结构如下主要项目

  • 中心
  • 资源
    • 可以应用于活动的主要类型
    • 一组属性和部分
    • 部分
      • 一组属性
      • 活动中从不直接使用
  • 活动
    • 应用于资源的操作

所有结构都标记了适用的特性,以进一步分类它们并简化浏览。

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

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

或者具体地 ...

let r = hub.projects().locations_global_hubs_groups_patch(...).doit().await
let r = hub.projects().locations_global_hubs_accept_spoke(...).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_global_hubs_reject_spoke(...).doit().await
let r = hub.projects().locations_global_policy_based_routes_create(...).doit().await
let r = hub.projects().locations_global_policy_based_routes_delete(...).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_regional_endpoints_create(...).doit().await
let r = hub.projects().locations_regional_endpoints_delete(...).doit().await
let r = hub.projects().locations_service_classes_delete(...).doit().await
let r = hub.projects().locations_service_classes_patch(...).doit().await
let r = hub.projects().locations_service_connection_maps_create(...).doit().await
let r = hub.projects().locations_service_connection_maps_delete(...).doit().await
let r = hub.projects().locations_service_connection_maps_patch(...).doit().await
let r = hub.projects().locations_service_connection_policies_create(...).doit().await
let r = hub.projects().locations_service_connection_policies_delete(...).doit().await
let r = hub.projects().locations_service_connection_policies_patch(...).doit().await
let r = hub.projects().locations_service_connection_tokens_create(...).doit().await
let r = hub.projects().locations_service_connection_tokens_delete(...).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 = "*"
serde = "^1.0"
serde_json = "^1.0"

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_networkconnectivity1 as networkconnectivity1;
use networkconnectivity1::api::Group;
use networkconnectivity1::{Result, Error};
use std::default::Default;
use networkconnectivity1::{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 = Group::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_groups_patch(req, "name")
             .update_mask(FieldMask::new::<&str>(&[]))
             .request_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方法表示,分别命名为uploadupload_resumable

自定义和回调

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

delegate trait有默认实现,允许您以最小的努力进行自定义。

服务器请求中的可选部分

本库提供的所有结构都旨在通过json进行编码和解码。编码和解码解码。使用可选值来表示部分请求和响应是有效的。大多数可选值被视为部分,可通过名称识别,这些部分将被发送到服务器,以指示请求的集合部分或响应中希望接收的部分。

构建器参数

通过使用方法构建器,您可以通过重复调用其方法来准备一个操作调用。这些方法始终接受单个参数,以下语句是正确的。

  • POD(普通老数据结构)通过复制传递
  • 字符串作为&str传递
  • 请求值被移动

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

Cargo功能

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

许可

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

依赖关系

~12-23MB
~346K SLoC