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

google-billingbudgets1_beta1

一个完整的库,用于与 CloudBillingBudget (协议 v1beta1) 交互

12 个稳定版本 (4 个主要版本)

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 日
1.0.14+20200704 2020 年 7 月 10 日

#153 in #api

每月 22 次下载
google-billingbudgets1_be… 中使用

MIT 许可证

180KB
2.5K SLoC

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

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

有关 CloudBillingBudget v1_beta1 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_beta1 = "*"
serde = "^1.0"
serde_json = "^1.0"

完整示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_billingbudgets1_beta1 as billingbudgets1_beta1;
use billingbudgets1_beta1::api::GoogleCloudBillingBudgetsV1beta1CreateBudgetRequest;
use billingbudgets1_beta1::{Result, Error};
use std::default::Default;
use billingbudgets1_beta1::{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 = GoogleCloudBillingBudgetsV1beta1CreateBudgetRequest::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_create(req, "parent")
             .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()调用之前向Method Builder提供一个代理来更改调用doit()方法的方式。相应的方将调用以提供进度信息,以及确定系统是否在失败时应重试。

delegate trait默认实现,允许您以最小努力进行自定义。

服务器请求中的可选部分

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

构建器参数

通过使用方法构建器,您可以通过反复调用其方法来准备一个操作调用。这些方法始终接受一个参数,以下陈述适用于该参数。

  • 原始数据结构(PODs)通过复制传递
  • 字符串作为&str传递
  • 请求值被移动

参数将始终复制或克隆到构建器中,以确保它们与原始生命周期独立。

Cargo特性

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

许可证

billingbudgets1_beta1库由Sebastian Thiel生成,并置于MIT许可证下。您可以在存储库的许可证文件中阅读完整内容。

依赖项

~12–23MB
~342K SLoC