#google #google-api #protocols #web #web-api #billingbudgets #api

google-billingbudgets1

用于与 CloudBillingBudget (协议 v1) 交互的完整库

11 个稳定版本 (3 个主要版本)

5.0.5+20240623 2024 年 6 月 27 日
5.0.4+20240225 2024 年 3 月 5 日
5.0.3+20230117 2023 年 8 月 23 日
5.0.2+20230117 2023 年 3 月 16 日
2.0.4+20210326 2021 年 4 月 14 日

网页编程 中排名第 2819

Download history 4/week @ 2024-05-19 1/week @ 2024-06-09 86/week @ 2024-06-23 35/week @ 2024-06-30

每月下载量 702
google-billingbudgets1-cl… 中使用

MIT 许可证

180KB
2.5K SLoC

google-billingbudgets1 库允许访问 Google CloudBillingBudget 服务(协议 v1)的所有功能。

此文档是从 CloudBillingBudgetcrate 版本 5.0.5+20240623 生成的,其中 20240623 是由 mako 代码生成器 v5.0.5 构建的 billingbudgets:v1 模式的确切修订。

关于 CloudBillingBudget v1 API 的其他所有信息都可以在 官方文档网站 上找到。

功能

轻松从中心 枢纽 处理以下 资源...

本库的结构

API 被组织成以下主要项目

  • 枢纽
  • 资源
    • 可以将 活动 应用到的 主要类型
    • 一组属性和 部分
    • 部分
      • 一组属性
      • 活动 中永远不会直接使用
  • 活动
    • 应用到 资源 上的操作

所有结构都被标记了相应的特性,以进一步分类并便于浏览。

一般来说,你可以这样调用活动

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

或者具体来说...

let r = hub.billing_accounts().budgets_create(...).doit().await
let r = hub.billing_accounts().budgets_get(...).doit().await
let r = hub.billing_accounts().budgets_patch(...).doit().await

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

用法

设置你的项目

要使用这个库,你需要在你的Cargo.toml文件中添加以下几行:

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

完整示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_billingbudgets1 as billingbudgets1;
use billingbudgets1::api::GoogleCloudBillingBudgetsV1Budget;
use billingbudgets1::{Result, Error};
use std::default::Default;
use billingbudgets1::{CloudBillingBudget, 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 = CloudBillingBudget::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 = GoogleCloudBillingBudgetsV1Budget::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.billing_accounts().budgets_patch(req, "name")
             .update_mask(FieldMask::new::<&str>(&[]))
             .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),
}

处理错误

系统产生的所有错误都作为(...)方法的返回值提供,或者作为可能的中间结果传递给(...)(...)(...)

当代理处理错误或中间值时,它们有机会指示系统重试。这使得系统可能对所有类型的错误都有抵抗力。

上传和下载

如果某个方法支持下载,则应该读取响应体以获取媒体,响应体是构建器的一部分。如果这样的方法也支持构建器,它将默认返回。你可以将其视为实际媒体的数据。要触发媒体下载,你需要通过以下调用设置构建器:.param("alt", "media")

支持上传的方法可以使用最多2种不同的协议:简单可恢复。每种协议的独特之处体现在定制的doit(...)方法上,这些方法分别命名为upload(...)upload_resumable(...)

自定义和回调

您可以通过提供一个委托方法构建器,在执行最终的doit()调用之前,修改doit()方法被调用的方式。相应的函数将被调用以提供进度信息,并确定系统在失败时是否应该重试。

委托特例默认实现,允许您以最小的努力对其进行自定义。

服务器请求中的可选部分

此库提供的所有结构都是通过json进行编码解码的。可选部分用于表示部分请求或响应是有效的。大多数可选部分都是被认为是部分,这些部分可以通过名称识别,并将发送到服务器以指示请求的设置部分或响应中所需的部分。

构建器参数

通过使用方法构建器,您可以通过重复调用其方法来准备一个操作调用。这些方法总是接受单个参数,以下陈述对参数有效。

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

参数总是被复制或克隆到构建器中,以便它们独立于其原始生命周期。

Cargo功能

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

许可证

billingbudgets1库由Sebastian Thiel生成,并置于MIT许可证之下。您可以在存储库的许可证文件中阅读全文。

依赖关系

~12–22MB
~342K SLoC