8个版本 (稳定版)
5.0.5+20240612 | 2024年6月27日 |
---|---|
5.0.4+20240221 | 2024年3月5日 |
5.0.3+20230111 | 2023年8月23日 |
5.0.2+20230111 | 2023年3月16日 |
3.0.0+20220207 | 2022年3月8日 |
8 在 #data-stream 中排名
467 每月下载量
用于 google-datastream1-cli
635KB
8K SLoC
该 google-datastream1
库允许访问 Google Datastream 服务所有功能。
本文档是从 Datastream crate 版本 5.0.5+20240612 生成的,其中 20240612 是由 mako 代码生成器 v5.0.5 构建的 datastream:v1 架构的精确修订版。
有关 Datastream v1 API 的其他所有信息,请参阅 官方文档站点。
功能
从中心 枢纽 轻松处理以下 资源 ...
- 项目
- 创建位置连接配置,删除位置连接配置,发现位置连接配置,获取位置连接配置,列出位置连接配置,修补位置连接配置,获取静态IP,获取位置,列出位置,取消位置操作,删除位置操作,获取位置操作,列出位置操作,创建位置私有连接,删除位置私有连接,获取位置私有连接,列出位置私有连接,创建位置私有连接路由,删除位置私有连接路由,获取位置私有连接路由,列出位置私有连接路由,创建位置流,删除位置流,获取位置流,列出位置流,获取位置流对象,列出位置流对象,查找位置流对象,启动位置流回填作业,停止位置流回填作业,修补位置流以及运行位置流
本库的结构
API结构如下主要项目
所有结构都标记了适用的特性,以进一步分类它们并简化浏览。
一般来说,您可以像这样调用活动
let r = hub.resource().activity(...).doit().await
或者具体来说...
let r = hub.projects().locations_connection_profiles_create(...).doit().await
let r = hub.projects().locations_connection_profiles_delete(...).doit().await
let r = hub.projects().locations_connection_profiles_patch(...).doit().await
let r = hub.projects().locations_operations_get(...).doit().await
let r = hub.projects().locations_private_connections_routes_create(...).doit().await
let r = hub.projects().locations_private_connections_routes_delete(...).doit().await
let r = hub.projects().locations_private_connections_create(...).doit().await
let r = hub.projects().locations_private_connections_delete(...).doit().await
let r = hub.projects().locations_streams_create(...).doit().await
let r = hub.projects().locations_streams_delete(...).doit().await
let r = hub.projects().locations_streams_patch(...).doit().await
let r = hub.projects().locations_streams_run(...).doit().await
resource()
和activity(...)
调用创建构建器。第二个构建器处理Activities
,支持各种配置即将进行操作的方法(此处未显示)。它设计成必须立即指定所有必需参数(即(...)
),而所有可选参数可以按需构建。doit()
方法执行与服务器的实际通信并返回相应的结果。
用法
设置您的项目
要使用此库,您需要将以下行放入您的Cargo.toml
文件中
[dependencies]
google-datastream1 = "*"
serde = "^1.0"
serde_json = "^1.0"
一个完整的示例
extern crate hyper;
extern crate hyper_rustls;
extern crate google_datastream1 as datastream1;
use datastream1::api::ConnectionProfile;
use datastream1::{Result, Error};
use std::default::Default;
use datastream1::{Datastream, 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 = Datastream::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 = ConnectionProfile::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_connection_profiles_create(req, "parent")
.validate_only(true)
.request_id("voluptua.")
.force(false)
.connection_profile_id("amet.")
.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
规范将是无效的。
许可证
由 Sebastian Thiel 生成的 datastream1 库,并置于 MIT 许可证之下。您可以在存储库的 许可证文件 中阅读全文。
依赖项
~12–23MB
~346K SLoC