#google #protocols #google-api #web #web-api #api #replicapoolupdater

google-replicapoolupdater1_beta1

与 replicapoolupdater (协议 v1beta1) 交互的完整库

43 个版本 (25 个稳定版)

5.0.5+20161003 2024 年 6 月 27 日
5.0.4+20161003 2024 年 3 月 5 日
5.0.3+20161003 2023 年 8 月 24 日
5.0.2+20161003 2023 年 3 月 16 日
0.1.2+20150129 2015 年 3 月 25 日

#10 in #web-api

Download history 4/week @ 2024-05-20 2/week @ 2024-06-03 3/week @ 2024-06-10 113/week @ 2024-06-24 8/week @ 2024-07-01

每月下载量 2,555
google-replicapoolupdater… 中使用

MIT 许可证

250KB
3.5K SLoC

google-replicapoolupdater1_beta1 库允许访问 Google replicapoolupdater(协议 v1beta1)服务的所有功能。

此文档是从 replicapoolupdater crate 版本 5.0.5+20161003 生成的,其中 20161003 是由 mako 代码生成器 v5.0.5 构建的 replicapoolupdater:v1beta1 模式的确切修订版。

有关 replicapoolupdater v1_beta1 API 的其他所有信息,请参阅 官方文档网站

特性

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

该库的结构

API 结构如下几个主要项目

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

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

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

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

或者具体来说...

let r = hub.rolling_updates().cancel(...).doit().await
let r = hub.rolling_updates().get(...).doit().await
let r = hub.rolling_updates().insert(...).doit().await
let r = hub.rolling_updates().list(...).doit().await
let r = hub.rolling_updates().list_instance_updates(...).doit().await
let r = hub.rolling_updates().pause(...).doit().await
let r = hub.rolling_updates().resume(...).doit().await
let r = hub.rolling_updates().rollback(...).doit().await

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

使用方法

设置您的项目

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

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

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_replicapoolupdater1_beta1 as replicapoolupdater1_beta1;
use replicapoolupdater1_beta1::{Result, Error};
use std::default::Default;
use replicapoolupdater1_beta1::{Replicapoolupdater, 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 = Replicapoolupdater::new(hyper::Client::builder().build(hyper_rustls::HttpsConnectorBuilder::new().with_native_roots().unwrap().https_or_http().enable_http1().build()), auth);
// 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.rolling_updates().list_instance_updates("project", "zone", "rollingUpdate")
             .page_token("ipsum")
             .max_results(73)
             .filter("At")
             .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 进行 编码解码 而设计的。可选部分用于表示部分请求或响应是有效的。大多数可选部分被视为 部分,可以通过名称识别,这些部分将被发送到服务器以指示请求或响应中所需的设置部分。

构建器参数

通过使用 方法构建器,您可以通过重复调用其方法来准备一个动作调用。这些方法总是接受单个参数,以下语句对此成立。

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

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

Cargo 功能

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

许可证

replicapoolupdater1_beta1 库由 Sebastian Thiel 生成,并根据 MIT 许可证发布。您可以在存储库的 许可证文件 中阅读全文。

依赖关系

~12–22MB
~343K SLoC