36 个版本 (稳定)
5.0.5+20240614 | 2024年6月27日 |
---|---|
5.0.4+20240214 | 2024年3月5日 |
5.0.3+20221206 | 2023年8月23日 |
5.0.2+20221206 | 2023年3月16日 |
0.1.9+20150903 | 2015年10月19日 |
在 网页编程 中排名第 2492
每月下载量 2,121
在 google-cloudbilling1-cli 中使用
400KB
4.5K SLoC
google-cloudbilling1
库允许访问 Google Cloudbilling 服务的所有功能。
本文档由 Cloudbilling 库版本 5.0.5+20240614 生成,其中 20240614 是由 mako 代码生成器 v5.0.5 构建的 cloudbilling:v1 架构的确切版本。
有关 Cloudbilling v1 API 的其他信息,请参阅 官方文档网站。
功能
从中央 枢纽 轻松处理以下 资源...
- 计费账户
- 创建、获取、获取 IAM 策略、列表、移动、修补、项目列表、设置 IAM 策略、创建子账户、列表子账户 和 测试 IAM 权限
- 组织
- 创建计费账户,列出计费账户和移动计费账户
- 项目
- 获取计费信息和更新计费信息
- 服务
- 列出和SKU 列表
库的结构
API结构分为以下主要项
所有结构都带有适用的特性,以进一步分类它们并简化浏览。
一般来说,您可以像这样调用活动
let r = hub.resource().activity(...).doit().await
或具体来说...
let r = hub.billing_accounts().projects_list(...).doit().await
let r = hub.billing_accounts().sub_accounts_create(...).doit().await
let r = hub.billing_accounts().sub_accounts_list(...).doit().await
let r = hub.billing_accounts().create(...).doit().await
let r = hub.billing_accounts().get(...).doit().await
let r = hub.billing_accounts().get_iam_policy(...).doit().await
let r = hub.billing_accounts().list(...).doit().await
let r = hub.billing_accounts().move_(...).doit().await
let r = hub.billing_accounts().patch(...).doit().await
let r = hub.billing_accounts().set_iam_policy(...).doit().await
let r = hub.billing_accounts().test_iam_permissions(...).doit().await
let r = hub.organizations().billing_accounts_create(...).doit().await
let r = hub.organizations().billing_accounts_move(...).doit().await
resource()
和activity(...)
调用创建构建器。第二个处理Activities
,支持各种方法来配置即将进行的操作(此处未显示)。它被设计成必须立即指定所有必需的参数(即(...)
),而所有可选的都可以按需要构建。doit()
方法执行与服务器实际通信并返回相应的结果。
用法
设置您的项目
要使用此库,您需要将以下行放入您的Cargo.toml
文件中
[dependencies]
google-cloudbilling1 = "*"
serde = "^1.0"
serde_json = "^1.0"
一个完整的示例
extern crate hyper;
extern crate hyper_rustls;
extern crate google_cloudbilling1 as cloudbilling1;
use cloudbilling1::{Result, Error};
use std::default::Default;
use cloudbilling1::{Cloudbilling, 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 = Cloudbilling::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.billing_accounts().sub_accounts_list("parent")
.page_token("magna")
.page_size(-11)
.filter("ipsum")
.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的一部分)应由您读取以获取媒体。如果此类方法还支持响应结果,则默认情况下将返回该结果。您可以将它视为实际媒体的元数据。要触发媒体下载,您必须通过以下调用设置构建器:.param("alt", "media")
。
支持上传的方法可以使用最多2种不同的协议:简单和可重传。每种协议的独特性通过自定义的doit(...)
方法来表示,分别命名为upload(...)
和upload_resumable(...)
。
定制和回调
您可以通过在执行最终的doit()
调用之前向Method Builder
提供一个委托来更改doit()
方法的调用方式。将调用相应的方法来提供进度信息,并确定系统在失败时是否应该重试。
delegate trait具有默认实现,允许您以最小的努力进行定制。
服务器请求中的可选部分
此库提供的所有结构都是为了通过json进行编码和解码而设计的。可选参数用于表示部分请求和响应是有效的。大多数可选参数都是被视为Parts的,这些部分可以通过名称识别,并将被发送到服务器,以指示请求中的设置部分或响应中期望的部分。
构建器参数
通过方法构建器,您可以通过反复调用其方法来准备一个操作调用。这些方法始终接受单个参数,以下陈述是正确的。
参数将始终被复制或克隆到构建器中,以使它们与其原始生命周期独立。
Cargo功能
utoipa
- 添加对 utoipa 的支持,并为所有类型派生utoipa::ToSchema
。您需要在#[openapi(schemas(...))]
中导入和注册所需类型,否则生成的openapi
规范将无效。
许可证
cloudbilling1 库由 Sebastian Thiel 创建,并置于 MIT 许可证之下。您可以在存储库的 许可证文件 中阅读全文。
依赖项
~12–23MB
~343K SLoC