“google-groupsmigration1”库允许访问“Google Groups Migration”服务的所有功能。

本文档由“Groups Migration”版本5.0.5+20240625生成，其中20240625是mako代码生成器v5.0.5构建的groupsmigration:v1模式的精确修订。

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

特性

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

• 存档
• 插入

支持的上传 ...

• 插入存档

库的结构

API结构如下

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

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

通常，您可以通过以下方式调用 活动

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

或者具体地说 ...

let r = hub.archive().insert(...).doit().await

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

使用方法

设置项目

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

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

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_groupsmigration1 as groupsmigration1;
use groupsmigration1::{Result, Error};
use std::fs;
use std::default::Default;
use groupsmigration1::{GroupsMigration, 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 = GroupsMigration::new(hyper::Client::builder().build(hyper_rustls::HttpsConnectorBuilder::new().with_native_roots().unwrap().https_or_http().enable_http1().build()), auth);
// You can configure optional parameters by calling the respective setters at will, and
// execute the final call using `upload(...)`.
// Values shown here are possibly random and not representative !
let result = hub.archive().insert("groupId")
             .upload(fs::File::open("file.ext").unwrap(), "application/octet-stream".parse().unwrap()).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 规范将无效。

许可证

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