12 个稳定版本 (4 个主要版本)
5.0.5+20240616 | 2024 年 6 月 27 日 |
---|---|
5.0.4+20240214 | 2024 年 3 月 5 日 |
5.0.3+20230115 | 2023 年 8 月 23 日 |
5.0.2+20230115 | 2023 年 3 月 16 日 |
1.0.14+20200626 | 2020 年 7 月 10 日 |
#2969 in 网页编程
245KB
3K SLoC
google-bigqueryconnection1_beta1
库允许访问 Google BigQuery 连接服务 的所有功能。
本文档由 BigQuery 连接服务 版本 5.0.5+20240616 生成,其中 20240616 是由 mako 代码生成器 v5.0.5 构建的 bigqueryconnection:v1beta1 模式的确切版本。
关于 BigQuery 连接服务 v1_beta1 API 的其他信息可以在 官方文档网站 上找到。
功能
从中心 枢纽 简单地处理以下 资源 ...
本库的结构
API结构如下几个主要项目
所有结构都标记了适用的特性,以进一步分类它们并简化浏览。
一般来说,您可以像这样调用活动
let r = hub.resource().activity(...).doit().await
或具体...
let r = hub.projects().locations_connections_create(...).doit().await
let r = hub.projects().locations_connections_get(...).doit().await
let r = hub.projects().locations_connections_patch(...).doit().await
resource()
和activity(...)
调用创建构建器。第二个处理Activities
,支持各种方法来配置即将进行的操作(此处未显示)。它被设计成必须立即指定所有必需的参数(即(...)
),而所有可选的参数都可以按照所需的方式构建。doit()
方法执行与服务器的实际通信并返回相应的结果。
用法
设置您的项目
要使用此库,您需要将以下行放入您的Cargo.toml
文件中
[dependencies]
google-bigqueryconnection1_beta1 = "*"
serde = "^1.0"
serde_json = "^1.0"
一个完整的示例
extern crate hyper;
extern crate hyper_rustls;
extern crate google_bigqueryconnection1_beta1 as bigqueryconnection1_beta1;
use bigqueryconnection1_beta1::api::Connection;
use bigqueryconnection1_beta1::{Result, Error};
use std::default::Default;
use bigqueryconnection1_beta1::{BigQueryConnectionService, 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 = BigQueryConnectionService::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 = Connection::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_connections_create(req, "parent")
.connection_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进行编码和解码而设计的。可选参数用于表示部分请求和响应是有效的。大多数可选参数都是被认为是部分,可以通过名称识别,这些部分将发送到服务器,以指示请求的设置部分或响应中所需的部分。
构建器参数
通过使用方法构建器,您可以通过反复调用其方法来准备一个动作调用。这些方法始终只接受一个参数,以下陈述是真实的。
参数将始终被复制或克隆到构建器中,以确保它们与其原始生命周期独立。
Cargo功能
utoipa
- 添加对utoipa的支持,并在所有类型上派生utoipa::ToSchema
。您必须在#[openapi(schemas(...))]
中导入和注册所需类型,否则生成的openapi
规范将是无效的。
许可证
bigqueryconnection1_beta1库是由Sebastian Thiel生成的,并置于MIT许可证之下。您可以在存储库的许可证文件中阅读全文。
依赖关系
~12–22MB
~342K SLoC