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

本文档是从版本 apigateway 5.0.5+20240529 生成的，其中 20240529 是由 mako 代码生成器 v5.0.5 构建的 apigateway:v1 架构的精确修订。

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

特性

从中心 枢纽 简单地处理以下 资源...

• 项目
• 创建位置API配置，删除位置API配置，获取位置API配置，获取位置API配置IAM策略，列出位置API配置，修补位置API配置，设置位置API配置IAM策略，测试位置API配置IAM权限，创建位置API，删除位置API，获取位置API，获取位置APIIAM策略，列出位置API，修补位置API，设置位置APIIAM策略，测试位置APIIAM权限，创建位置网关，删除位置网关，获取位置网关，获取位置网关IAM策略，列出位置网关，修补位置网关，设置位置网关IAM策略，测试位置网关IAM权限，获取位置，列出位置，取消位置操作，删除位置操作，获取位置操作和列出位置操作

该库的结构

API结构如下几个主要项目

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

所有结构都标记了相应的特性和易于浏览。

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

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

或者具体来说...

let r = hub.projects().locations_apis_configs_create(...).doit().await
let r = hub.projects().locations_apis_configs_delete(...).doit().await
let r = hub.projects().locations_apis_configs_patch(...).doit().await
let r = hub.projects().locations_apis_create(...).doit().await
let r = hub.projects().locations_apis_delete(...).doit().await
let r = hub.projects().locations_apis_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_operations_get(...).doit().await

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

用法

设置你的项目

要使用这个库，你需要在你的Cargo.toml文件中添加以下行

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

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_apigateway1 as apigateway1;
use apigateway1::api::ApigatewayApiConfig;
use apigateway1::{Result, Error};
use std::default::Default;
use apigateway1::{Apigateway, 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 = Apigateway::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 = ApigatewayApiConfig::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_apis_configs_create(req, "parent")
             .api_config_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()之前提供一个委托给方法构建器来更改调用doit()的方式。相应的方程序将被调用来提供进度信息，以及确定系统是否应在失败时重试。

委托特质默认实现，允许您以最小的努力对其进行定制。

服务器请求中的可选部分

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

构建器参数

使用 方法构建器，您可以通过重复调用它的方法来准备一个操作调用。这些方法始终接受单个参数，以下语句对它成立。

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

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

Cargo 特性

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

许可证

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