google-pubsub1_beta2 库允许访问 Google Pubsub 服务的所有功能。

此文档是从 Pubsub crate 版本 5.0.5+20240618 生成的，其中 20240618 是由 mako 代码生成器 v5.0.5 构建的 pubsub:v1beta2 模式的确切修订版。

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

功能

轻松从中央 中心 ...

• 项目
• 订阅确认，创建订阅，删除订阅，获取订阅，获取订阅 IAM 策略，列出订阅，修改确认截止时间，修改推送配置，拉取订阅，设置订阅 IAM 策略，测试订阅 IAM 权限，创建主题，删除主题，获取主题，获取主题 IAM 策略，列出主题，发布主题，设置主题 IAM 策略，列出主题订阅以及测试主题 IAM 权限

本库的结构

API 被组织成以下主要项

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

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

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

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

或者具体地...

let r = hub.projects().subscriptions_acknowledge(...).doit().await
let r = hub.projects().subscriptions_delete(...).doit().await
let r = hub.projects().subscriptions_modify_ack_deadline(...).doit().await
let r = hub.projects().subscriptions_modify_push_config(...).doit().await
let r = hub.projects().topics_delete(...).doit().await

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

使用方法

设置你的项目

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

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

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_pubsub1_beta2 as pubsub1_beta2;
use pubsub1_beta2::api::AcknowledgeRequest;
use pubsub1_beta2::{Result, Error};
use std::default::Default;
use pubsub1_beta2::{Pubsub, 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 = Pubsub::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 = AcknowledgeRequest::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.projects().subscriptions_acknowledge(req, "subscription")
             .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提供一个delegate来更改doit()方法的调用方式。相应的函数将被调用以提供进度信息，并确定系统在失败时是否应该重试。

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

服务器请求中的可选部分

此库提供的所有结构都是为了通过json进行编码和解码而设计的，可以通过encodable和decodable。可选部分用于表示部分请求或响应是有效的。大多数可选部分都是可识别的Parts，可以通过名称识别，这些部分将被发送到服务器以指示请求的设置部分或响应中希望接收的部分。

构建器参数

使用方法构建器，您可以通过重复调用它的方法来准备一个操作调用。这些方法始终接受一个参数，以下陈述对此适用。

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

参数将被复制或克隆到构建器中，以便它们独立于它们原始的生命周期。

Cargo功能

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

许可证

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