#google-api #google #协议 #API #google-service #web-api #replicapool

google-replicapool1_beta2

用于与 replicapool(协议 v1beta2)交互的完整库

41 个版本 (24 个稳定版本)

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

网页开发 中排名 2418

Download history 5/week @ 2024-05-19 1/week @ 2024-06-02 1/week @ 2024-06-09 1/week @ 2024-06-16 111/week @ 2024-06-23 17/week @ 2024-06-30

每月下载量 2,431
用于 google-replicapool1_beta2…

MIT 许可证

290KB
3.5K SLoC

google-replicapool1_beta2 库允许访问 Google replicapool 服务(协议 v1beta2)的所有功能。

本文档由 replicapool 库版本 5.0.5+20160512 生成,其中 20160512 是由 mako 代码生成器 v5.0.5 构建的 replicapool:v1beta2 架构的确切修订版。

有关 replicapool v1_beta2 API 的其他所有信息,请参阅 官方文档站点

功能

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

本库的结构

API结构如下几个主要项

  • 中心节点
  • 资源
    • 你可以将活动应用于的主要类型
    • 一组属性和部分
    • 部分
      • 一组属性
      • 永远不会直接用于活动
  • 活动
    • 应用于资源的操作

所有结构都标记了相应的特征,以便进一步分类并便于浏览。

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

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

或者具体来说...

let r = hub.instance_group_managers().abandon_instances(...).doit().await
let r = hub.instance_group_managers().delete(...).doit().await
let r = hub.instance_group_managers().delete_instances(...).doit().await
let r = hub.instance_group_managers().get(...).doit().await
let r = hub.instance_group_managers().insert(...).doit().await
let r = hub.instance_group_managers().list(...).doit().await
let r = hub.instance_group_managers().recreate_instances(...).doit().await
let r = hub.instance_group_managers().resize(...).doit().await
let r = hub.instance_group_managers().set_instance_template(...).doit().await
let r = hub.instance_group_managers().set_target_pools(...).doit().await

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

用法

设置您的项目

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

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

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_replicapool1_beta2 as replicapool1_beta2;
use replicapool1_beta2::{Result, Error};
use std::default::Default;
use replicapool1_beta2::{Replicapool, 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 = Replicapool::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.instance_group_managers().list("project", "zone")
             .page_token("no")
             .max_results(46)
             .filter("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()方法的返回值,或者作为可能的中间结果传递给中心代理,或者认证代理

当代理处理错误或中间值时,它们有机会指示系统重试。这使得系统对各种错误具有潜在的抗性。

上传和下载

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

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

自定义和回调

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

代理特质默认实现,允许您以最小的努力进行自定义。

服务器请求中的可选部分

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

构建器参数

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

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

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

Cargo功能

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

许可证

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

依赖关系

~12–23MB
~343K SLoC