16 个稳定版本 (4 个主要版本)
5.0.5+20200405 | 2024 年 6 月 27 日 |
---|---|
5.0.4+20200405 | 2024 年 3 月 5 日 |
5.0.3+20200405 | 2023 年 8 月 23 日 |
5.0.2+20200405 | 2023 年 3 月 16 日 |
1.0.10+20190622 | 2019 年 7 月 6 日 |
#2846 in 网页编程
535KB
6.5K SLoC
google-cloudprivatecatalogproducer1_beta1
库允许访问 Google Cloud PrivateCatalog Producer 服务的所有功能。
本文档是由 Cloud PrivateCatalog Producer crate 版本 5.0.5+20200405 生成的,其中 20200405 是由 mako 代码生成器 v5.0.5 构建的 cloudprivatecatalogproducer:v1beta1 方案的精确修订版本。
关于 Cloud PrivateCatalog Producer v1_beta1 API 的其他信息可以在 官方文档网站 找到。
功能
从中央 中心轻松处理以下 资源 ...
- 目录
- 创建关联,删除关联,获取关联,列出关联,创建,删除,获取,获取 IAM 策略,列出,修补,复制产品,创建产品,删除产品,获取产品,上传产品图标,列出产品,修补产品,创建产品版本,删除产品版本,获取产品版本,列出产品版本,修补产品版本,设置 IAM 策略,测试 IAM 权限和撤销删除
- 操作
- 取消,删除,获取和列出
库的结构
API 结构如下几个主要项目
所有 结构 都标有适用特性,以便进一步分类和便于浏览。
通常来说,您可以像这样调用 活动
let r = hub.resource().activity(...).doit().await
或者具体来说 ...
let r = hub.catalogs().associations_delete(...).doit().await
let r = hub.catalogs().products_icons_upload(...).doit().await
let r = hub.catalogs().products_versions_delete(...).doit().await
let r = hub.catalogs().products_delete(...).doit().await
let r = hub.operations().cancel(...).doit().await
let r = hub.operations().delete(...).doit().await
代码 resource()
和 activity(...)
调用创建 构建器。第二个处理 活动
支持各种配置即将执行的操作的方法(此处未显示)。它被设计成必须立即指定所有必需的参数(即 (...)
),而所有可选的都可以按需 构建。doit()
方法执行与服务器实际通信并返回相应的结果。
使用方法
设置您的项目
要使用此库,您需要将以下行放入您的 Cargo.toml
文件
[dependencies]
google-cloudprivatecatalogproducer1_beta1 = "*"
serde = "^1.0"
serde_json = "^1.0"
一个完整的示例
extern crate hyper;
extern crate hyper_rustls;
extern crate google_cloudprivatecatalogproducer1_beta1 as cloudprivatecatalogproducer1_beta1;
use cloudprivatecatalogproducer1_beta1::api::GoogleCloudPrivatecatalogproducerV1beta1UploadIconRequest;
use cloudprivatecatalogproducer1_beta1::{Result, Error};
use std::default::Default;
use cloudprivatecatalogproducer1_beta1::{CloudPrivateCatalogProducer, 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 = CloudPrivateCatalogProducer::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 = GoogleCloudPrivatecatalogproducerV1beta1UploadIconRequest::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.catalogs().products_icons_upload(req, "product")
.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()
方法的调用方式,在执行最终的 doit()
调用之前。相应的会调用方法来提供进度信息,以及确定系统在失败时是否应该重试。
默认实现了 代理 trait,允许您以最小的努力进行自定义。
服务器请求中的可选部分
此库提供的所有结构都设计成可以通过 json 编码和解码为 可编码 和 可解码。可选部分用于表示部分请求或响应是有效的。大多数可选部分都是可识别的 部分,通过名称标识,这些部分将被发送到服务器,以指示请求的设置部分或响应中所需的部分。
构建器参数
通过使用 方法构建器,您可以通过反复调用其方法来准备一个动作调用。这些方法总是接受单个参数,以下陈述对此适用。
参数总是被复制或克隆到构建器中,以使它们与其原始生命周期独立。
Cargo 功能
utoipa
- 为所有类型添加对 utoipa 的支持,并派生utoipa::ToSchema
。您必须在#[openapi(schemas(...))]
中导入和注册所需的类型,否则生成的openapi
规范将是无效的。
许可证
由 Sebastian Thiel 生成的 cloudprivatecatalogproducer1_beta1 库,并置于 MIT 许可证之下。您可以在存储库的 许可证文件 中阅读全文。
依赖关系
~12–23MB
~343K SLoC