《google-pubsublite1》库允许访问 Google PubsubLite 服务所有功能。

本文档是从 PubsubLite crate 版本 5.0.5+20240614 生成的，其中 20240614 是由 mako 代码生成器 v5.0.5 构建的 pubsublite:v1 模式的确切修订版本。

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

特性

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

• 管理员
• 项目位置操作取消，项目位置操作删除，项目位置操作获取，项目位置操作列表，项目位置预留创建，项目位置预留删除，项目位置预留获取，项目位置预留列表，项目位置预留更新，项目位置预留主题列表，项目位置订阅创建，项目位置订阅删除，项目位置订阅获取，项目位置订阅列表，项目位置订阅更新，项目位置订阅定位，项目位置主题创建，项目位置主题删除，项目位置主题获取，项目位置主题分区获取，项目位置主题列表，项目位置主题更新以及项目位置主题订阅列表
• 游标
• 项目位置订阅提交游标和项目位置订阅游标列表
• 主题统计
• 项目位置主题计算头部游标，项目位置主题计算消息统计和项目位置主题计算时间游标

本库结构

API结构如下主要项目

• 中心
  • 一个中央对象，用于维护状态并允许访问所有活动
  • 创建方法构建器，后者允许访问单个调用构建器
• 资源
  • 可以将活动应用于的主要类型
  • 一组属性和部分
  • 部分
    • 一组属性
    • 不得直接在 活动 中使用
• 活动
  • 应用于 资源 的操作

所有 结构 都已标记适用的特性，以进一步分类并便于浏览。

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

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

或者具体...

let r = hub.admin().projects_locations_operations_cancel(...).doit().await
let r = hub.admin().projects_locations_operations_delete(...).doit().await
let r = hub.admin().projects_locations_reservations_delete(...).doit().await
let r = hub.admin().projects_locations_subscriptions_delete(...).doit().await
let r = hub.admin().projects_locations_topics_delete(...).doit().await

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

用法

设置项目

要使用此库，您需要将以下行放入您的 Cargo.toml 文件中

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

完整示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_pubsublite1 as pubsublite1;
use pubsublite1::api::CancelOperationRequest;
use pubsublite1::{Result, Error};
use std::default::Default;
use pubsublite1::{PubsubLite, 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 = PubsubLite::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 = CancelOperationRequest::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.admin().projects_locations_operations_cancel(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() 方法的调用方式。在执行最终的 doit() 调用之前，将调用相应的方方法来提供进度信息，并确定系统在失败时是否应该重试。

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

服务器请求中的可选部分

此库提供所有结构，均通过 json 进行 编码 和 解码。可选参数用于表示部分请求和响应是有效的。大多数可选参数都是可识别的 部分，它们可以通过名称标识，将被发送到服务器以指示请求的设置部分或响应中期望的部分。

构建器参数

使用 方法构建器，您可以通过反复调用其方法来准备一个操作调用。这些方法始终接受单个参数，以下陈述是真实的。

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

参数始终会被复制或克隆到构建器中，以使其与原始生命周期独立。

Cargo 功能

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

许可

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