该 google-bigqueryreservation1 库允许访问 Google BigQuery 预留服务的所有功能。

本文档由 BigQuery 预留版本 5.0.5+20240611 生成，其中 20240611 是由 mako 代码生成器 v5.0.5 构建的 bigqueryreservation:v1 架构的确切修订版。

有关 BigQuery 预留 v1 API 的其他信息，请参阅 官方文档站点。

功能

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

• 项目
• 创建位置容量承诺，删除位置容量承诺，获取位置容量承诺，列出位置容量承诺，合并位置容量承诺，修补位置容量承诺，分割位置容量承诺，获取双位置预留，创建位置预留分配，删除位置预留分配，列出位置预留分配，移动位置预留分配，修补位置预留分配，创建位置预留，删除位置预留，故障转移预留，获取位置预留，列出位置预留，修补位置预留，搜索所有分配，搜索分配以及更新双位置预留

本库的结构

API 结构如下

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

所有 结构 都标有适用的特征，以进一步分类它们并便于浏览。

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

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

或具体来说...

let r = hub.projects().locations_reservations_create(...).doit().await
let r = hub.projects().locations_reservations_failover_reservation(...).doit().await
let r = hub.projects().locations_reservations_get(...).doit().await
let r = hub.projects().locations_reservations_patch(...).doit().await

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

用法

设置项目

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

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

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_bigqueryreservation1 as bigqueryreservation1;
use bigqueryreservation1::api::Reservation;
use bigqueryreservation1::{Result, Error};
use std::default::Default;
use bigqueryreservation1::{BigQueryReservation, 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 = BigQueryReservation::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 = Reservation::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_reservations_create(req, "parent")
             .reservation_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")。

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

自定义和回调

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

delegate trait 具有默认实现，这使得您可以用最少的努力对其进行自定义。

服务器请求中的可选部分

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

构建器参数

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

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

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

Cargo 特性

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

许可协议

bigqueryreservation1 库由 Sebastian Thiel 创建，并置于 MIT 许可协议之下。您可以在存储库的 许可文件 中阅读完整内容。