#google #protocols #deployment-manager #google-api #web #api-version #web-api

google-deploymentmanager2_beta2

与 Deployment Manager (协议 v2beta2) 交互的完整库

32 个版本 (稳定版)

5.0.5+20160201 2024 年 6 月 27 日
5.0.4+20160201 2024 年 3 月 5 日
5.0.3+20160201 2023 年 8 月 23 日
5.0.2+20160201 2023 年 3 月 16 日
0.1.9+20150831 2015 年 10 月 19 日

#2274 in 网页编程

Download history 4/week @ 2024-05-21 1/week @ 2024-05-28 3/week @ 2024-06-04 7/week @ 2024-06-11 88/week @ 2024-06-25 7/week @ 2024-07-02

1,903 每月下载量
用于 google-deploymentmanager2…

MIT 许可证

310KB
4K SLoC

google-deploymentmanager2_beta2 库允许访问 Google Deployment Manager 服务所有功能。

本文档是根据 Deployment Manager 库版本 5.0.5+20160201 生成的,其中 20160201 是由 mako 代码生成器 v5.0.5 构建的 deploymentmanager:v2beta2 模式的确切版本。

关于 Deployment Manager v2_beta2 API 的其他信息可以在 官方文档站点 找到。

功能

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

该库的结构

API 被组织成以下主要项目

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

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

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

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

或者具体来说...

let r = hub.deployments().delete(...).doit().await
let r = hub.deployments().insert(...).doit().await
let r = hub.deployments().patch(...).doit().await
let r = hub.deployments().update(...).doit().await
let r = hub.operations().get(...).doit().await
let r = hub.operations().list(...).doit().await

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

用法

设置您的项目

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

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

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_deploymentmanager2_beta2 as deploymentmanager2_beta2;
use deploymentmanager2_beta2::api::Deployment;
use deploymentmanager2_beta2::{Result, Error};
use std::default::Default;
use deploymentmanager2_beta2::{DeploymentManager, 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 = DeploymentManager::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 = Deployment::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.deployments().patch(req, "project", "deployment")
             .update_policy("no")
             .delete_policy("ipsum")
             .create_policy("voluptua.")
             .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 DelegateAuthenticator Delegate

当代理处理错误或中间值时,它们可能会有机会指示系统重试。这使得系统可能对所有类型的错误都具有弹性。

上传和下载

如果方法支持下载,则应读取响应体(它是 Result 的一部分)以获取媒体。如果此类方法还支持 Response Result,则默认返回该结果。您可以将其视为实际媒体的元数据。要触发媒体下载,您必须通过此调用设置构建器:.param("alt", "media")

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

定制和回调

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

默认实现了代理特质,允许您以最少的努力对其进行定制。

服务器请求中的可选部分

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

构建器参数

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

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

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

Cargo功能

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

许可

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

依赖项

~12–22MB
~343K SLoC