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

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

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

功能

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

• Google 服务帐户
• 获取
• 项目
• 创建代理池，删除代理池，获取代理池，列出代理池 和 修补代理池
• 传输作业
• 创建，删除，获取，列出，修补 和 运行
• 传输操作
• 取消，获取，列出，暂停和恢复

库结构

API结构如下主要项

• 枢纽
  • 一个中心对象，用于维护状态并允许访问所有活动
  • 创建方法构建器，进而允许访问单个调用构建器
• 资源
  • 主要类型，可以将活动应用于其上
  • 属性和部分的集合
  • 部分
    • 属性的集合
    • 在活动中从不直接使用
• 活动
  • 应用于资源的操作

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

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

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

或具体来说...

let r = hub.transfer_jobs().create(...).doit().await
let r = hub.transfer_jobs().delete(...).doit().await
let r = hub.transfer_jobs().get(...).doit().await
let r = hub.transfer_jobs().list(...).doit().await
let r = hub.transfer_jobs().patch(...).doit().await
let r = hub.transfer_jobs().run(...).doit().await

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

用法

设置您的项目

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

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

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_storagetransfer1 as storagetransfer1;
use storagetransfer1::{Result, Error};
use std::default::Default;
use storagetransfer1::{Storagetransfer, 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 = Storagetransfer::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 `doit()`.
// Values shown here are possibly random and not representative !
let result = hub.transfer_jobs().list("filter")
             .page_token("magna")
             .page_size(-11)
             .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")。

支持上传的方法可以使用最多两种协议：简单的和可恢复的。每种协议的独特性通过定制的 doit(...) 方法来表示，这些方法分别被命名为 upload(...) 和 upload_resumable(...)。

定制和回调

您可以通过在最终调用 doit() 之前提供给 委托 给 方法构建器 来更改调用 doit() 方式。相应的函数将被调用以提供进度信息，并确定系统在失败时应否重试。

委托特质 默认实现，允许您以最小的努力进行定制。

服务器请求中的可选部分

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

构建器参数

通过 方法构建器，您可以通过重复调用其方法来准备一个动作调用。这些方法总是接受单个参数，以下语句对于该参数都是成立的。

• POD 通过复制传递
• 字符串作为 &str 传递
• 请求值 是移动的

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

Cargo 功能

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

许可证

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