该 google-networkservices1 库允许访问 Google NetworkServices 服务所有功能。

本文档是根据 NetworkServices crate 版本 5.0.5+20240620 生成的，其中 20240620 是由 mako 代码生成器 v5.0.5 构建的 networkservices:v1 架构的精确修订版。

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

功能

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

• 项目
• locations edge cache keysets get iam policy, locations edge cache keysets set iam policy, locations edge cache keysets test iam permissions, locations edge cache origins get iam policy, locations edge cache origins set iam policy, locations edge cache origins test iam permissions, locations edge cache services get iam policy, locations edge cache services set iam policy, locations edge cache services test iam permissions, locations endpoint policies create, locations endpoint policies delete, locations endpoint policies get, locations endpoint policies get iam policy, locations endpoint policies list, locations endpoint policies patch, locations endpoint policies set iam policy, locations endpoint policies test iam permissions, locations gateways create, locations gateways delete, locations gateways get, locations gateways get iam policy, locations gateways list, locations gateways patch, locations gateways set iam policy, locations gateways test iam permissions, locations get, locations grpc routes create, locations grpc routes delete, locations grpc routes get, locations grpc routes list, locations grpc routes patch, locations http routes create, locations http routes delete, locations http routes get, locations http routes list, locations http routes patch, locations lb route extensions create, locations lb route extensions delete, locations lb route extensions get, locations lb route extensions list, locations lb route extensions patch, locations lb traffic extensions create, locations lb traffic extensions delete, locations lb traffic extensions get, locations lb traffic extensions list, locations lb traffic extensions patch, locations list, locations meshes create, locations meshes delete, locations meshes get, locations meshes get iam policy, locations meshes list, locations meshes patch, locations meshes set iam policy, locations meshes test iam permissions, locations operations cancel, locations operations delete, locations operations get, locations operations list, locations service bindings create, locations service bindings delete, locations service bindings get, locations service bindings get iam policy, locations service bindings list, locations service bindings set iam policy, locations service bindings test iam permissions, locations service lb policies create, locations service lb policies delete, locations service lb policies get, locations service lb policies get iam policy, locations service lb policies list, locations service lb policies patch, locations service lb policies set iam policy, locations service lb policies test iam permissions, locations tcp routes create, locations tcp routes delete, locations tcp routes get, locations tcp routes list, locations tcp routes patch, locations tls routes create, locations tls routes delete, locations tls routes get, locations tls routes list and locations tls routes patch

本库结构

API 结构如下主要项

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

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

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

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

或具体来说 ...

let r = hub.projects().locations_endpoint_policies_create(...).doit().await
let r = hub.projects().locations_endpoint_policies_delete(...).doit().await
let r = hub.projects().locations_endpoint_policies_patch(...).doit().await
let r = hub.projects().locations_gateways_create(...).doit().await
let r = hub.projects().locations_gateways_delete(...).doit().await
let r = hub.projects().locations_gateways_patch(...).doit().await
let r = hub.projects().locations_grpc_routes_create(...).doit().await
let r = hub.projects().locations_grpc_routes_delete(...).doit().await
let r = hub.projects().locations_grpc_routes_patch(...).doit().await
let r = hub.projects().locations_http_routes_create(...).doit().await
let r = hub.projects().locations_http_routes_delete(...).doit().await
let r = hub.projects().locations_http_routes_patch(...).doit().await
let r = hub.projects().locations_lb_route_extensions_create(...).doit().await
let r = hub.projects().locations_lb_route_extensions_delete(...).doit().await
let r = hub.projects().locations_lb_route_extensions_patch(...).doit().await
let r = hub.projects().locations_lb_traffic_extensions_create(...).doit().await
let r = hub.projects().locations_lb_traffic_extensions_delete(...).doit().await
let r = hub.projects().locations_lb_traffic_extensions_patch(...).doit().await
let r = hub.projects().locations_meshes_create(...).doit().await
let r = hub.projects().locations_meshes_delete(...).doit().await
let r = hub.projects().locations_meshes_patch(...).doit().await
let r = hub.projects().locations_operations_get(...).doit().await
let r = hub.projects().locations_service_bindings_create(...).doit().await
let r = hub.projects().locations_service_bindings_delete(...).doit().await
let r = hub.projects().locations_service_lb_policies_create(...).doit().await
let r = hub.projects().locations_service_lb_policies_delete(...).doit().await
let r = hub.projects().locations_service_lb_policies_patch(...).doit().await
let r = hub.projects().locations_tcp_routes_create(...).doit().await
let r = hub.projects().locations_tcp_routes_delete(...).doit().await
let r = hub.projects().locations_tcp_routes_patch(...).doit().await
let r = hub.projects().locations_tls_routes_create(...).doit().await
let r = hub.projects().locations_tls_routes_delete(...).doit().await
let r = hub.projects().locations_tls_routes_patch(...).doit().await

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

使用方法

设置您的项目

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

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

完整示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_networkservices1 as networkservices1;
use networkservices1::api::LbRouteExtension;
use networkservices1::{Result, Error};
use std::default::Default;
use networkservices1::{NetworkServices, 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 = NetworkServices::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 = LbRouteExtension::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_lb_route_extensions_create(req, "parent")
             .request_id("magna")
             .lb_route_extension_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")。

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

自定义和回调

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

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

服务器请求中的可选部分

本库提供的所有结构都是为了通过json进行编码和解码而设计的。使用可选参数来表示部分请求或响应是有效的。大多数可选参数被认为是部分，可以通过名称进行识别，这些部分将被发送到服务器以指示请求的设置部分或响应中期望的部分。

构建器参数

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

• PODs（普通旧数据结构）通过复制传递
• 字符串作为&str传递
• 请求值被移动

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

Cargo功能

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

许可证

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