该 google-cloudchannel1 库允许访问 Google Cloudchannel 服务的所有功能。

本文档是从 Cloudchannel crate 版本 5.0.5+20240625 生成的，其中 20240625 是由 mako 代码生成器 v5.0.5 构建的 cloudchannel:v1 架构的确切修订。

有关 Cloudchannel v1 API 的其他所有信息，请参阅 官方文档网站。

功能

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

• 账户
• channel partner links channel partner repricing configs create, channel partner links channel partner repricing configs delete, channel partner links channel partner repricing configs get, channel partner links channel partner repricing configs list, channel partner links channel partner repricing configs patch, channel partner links create, channel partner links customers create, channel partner links customers delete, channel partner links customers get, channel partner links customers import, channel partner links customers list, channel partner links customers patch, channel partner links get, channel partner links list, channel partner links patch, check cloud identity accounts exist, customers create, customers customer repricing configs create, customers customer repricing configs delete, customers customer repricing configs get, customers customer repricing configs list, customers customer repricing configs patch, customers delete, customers entitlements activate, customers entitlements cancel, customers entitlements change offer, customers entitlements change parameters, customers entitlements change renewal settings, customers entitlements create, customers entitlements get, customers entitlements list, customers entitlements list entitlement changes, customers entitlements lookup offer, customers entitlements start paid service, customers entitlements suspend, customers get, customers import, customers list, customers list purchasable offers, customers list purchasable skus, customers patch, customers provision cloud identity, customers query eligible billing accounts, customers transfer entitlements, customers transfer entitlements to google, list subscribers, list transferable offers, list transferable skus, offers list, register, report jobs fetch report results, reports list, reports run, sku groups billable skus list, sku groups list and unregister
• 操作
• 取消、删除、获取 和 列出
• 产品
• 列出 和 SKU 列表

本库的结构

API 结构如下主要项目

• 枢纽
  • 一个中心对象，用于维护状态并允许访问所有 活动
  • 创建 方法构建器，它们反过来允许访问单个 调用构建器
• 资源
  • 可以将 活动 应用于其上的主要类型
  • 一组属性和 部分
  • 部分
    • 一组属性
    • 永远不会直接用于 活动
• 活动
  • 应用于 资源 的操作

所有 结构 都带有适用的特质，以进一步分类它们并便于浏览。

一般来说，您可以像这样调用 活动

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

或具体来说 ...

let r = hub.accounts().customers_entitlements_activate(...).doit().await
let r = hub.accounts().customers_entitlements_cancel(...).doit().await
let r = hub.accounts().customers_entitlements_change_offer(...).doit().await
let r = hub.accounts().customers_entitlements_change_parameters(...).doit().await
let r = hub.accounts().customers_entitlements_change_renewal_settings(...).doit().await
let r = hub.accounts().customers_entitlements_create(...).doit().await
let r = hub.accounts().customers_entitlements_start_paid_service(...).doit().await
let r = hub.accounts().customers_entitlements_suspend(...).doit().await
let r = hub.accounts().customers_provision_cloud_identity(...).doit().await
let r = hub.accounts().customers_transfer_entitlements(...).doit().await
let r = hub.accounts().customers_transfer_entitlements_to_google(...).doit().await
let r = hub.accounts().reports_run(...).doit().await
let r = hub.operations().get(...).doit().await

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

使用方法

设置你的项目

要使用这个库，你需要在你的Cargo.toml文件中放入以下几行

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

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_cloudchannel1 as cloudchannel1;
use cloudchannel1::api::GoogleCloudChannelV1ActivateEntitlementRequest;
use cloudchannel1::{Result, Error};
use std::default::Default;
use cloudchannel1::{Cloudchannel, 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 = Cloudchannel::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 = GoogleCloudChannelV1ActivateEntitlementRequest::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.accounts().customers_entitlements_activate(req, "name")
             .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()方法的调用方式。相应的函数将被调用来提供进度信息，以及确定系统是否应在失败时重试。

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

许可证

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