google-storage1 库允许访问 Google 存储服务的所有功能。

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

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

功能

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

• 任何地方缓存
• 禁用、获取、插入、列出、暂停、恢复 和 更新
• 存储桶访问控制
• 删除、获取、插入、列出、修补 和 更新
• 存储桶
• 删除，获取，获取 IAM 策略，获取存储布局，插入，列出，锁定保留策略，取消操作，获取操作，列出操作，更新，设置 IAM 策略，测试 IAM 权限和更新
• 通道
• 停止
• 默认对象访问控制
• 删除，获取，插入，列出，更新和更新
• 文件夹
• 删除，获取，插入，列出和重命名
• 托管文件夹
• 删除，获取，获取 IAM 策略，插入，列出，设置 IAM 策略和测试 IAM 权限
• 通知
• 删除，获取，插入和列出
• 对象访问控制
• 删除，获取，插入，列出，更新和更新
• 对象
• 批量还原，组合，复制，删除，获取，获取 IAM 策略，插入，列出，修补，还原，重写，设置 IAM 策略，测试 IAM 权限，更新和监视所有
• 项目
• 创建 HMAC 密钥，删除 HMAC 密钥，获取 HMAC 密钥，列出 HMAC 密钥，更新 HMAC 密钥和获取服务帐户

支持上传的...

• 插入对象

支持下载的...

• 获取对象

支持订阅的...

• 列出对象
• 监视所有对象

库的结构

API 结构如下主要项目

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

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

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

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

或具体...

let r = hub.objects().bulk_restore(...).doit().await
let r = hub.objects().compose(...).doit().await
let r = hub.objects().copy(...).doit().await
let r = hub.objects().delete(...).doit().await
let r = hub.objects().get(...).doit().await
let r = hub.objects().get_iam_policy(...).doit().await
let r = hub.objects().insert(...).doit().await
let r = hub.objects().list(...).doit().await
let r = hub.objects().patch(...).doit().await
let r = hub.objects().restore(...).doit().await
let r = hub.objects().rewrite(...).doit().await
let r = hub.objects().set_iam_policy(...).doit().await
let r = hub.objects().test_iam_permissions(...).doit().await
let r = hub.objects().update(...).doit().await
let r = hub.objects().watch_all(...).doit().await

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

用法

设置您的项目

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

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

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_storage1 as storage1;
use storage1::api::Object;
use storage1::{Result, Error};
use std::default::Default;
use storage1::{Storage, 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 = Storage::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 = Object::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.objects().rewrite(req, "sourceBucket", "sourceObject", "destinationBucket", "destinationObject")
             .user_project("voluptua.")
             .source_generation(-27)
             .rewrite_token("sanctus")
             .projection("sed")
             .max_bytes_rewritten_per_call(-2)
             .if_source_metageneration_not_match(-59)
             .if_source_metageneration_match(-52)
             .if_source_generation_not_match(-20)
             .if_source_generation_match(-55)
             .if_metageneration_not_match(-62)
             .if_metageneration_match(-51)
             .if_generation_not_match(-12)
             .if_generation_match(-75)
             .destination_predefined_acl("dolor")
             .destination_kms_key_name("ea")
             .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 进行 编码 和 解码。可选部分用于表示部分请求或响应是有效的。大多数可选部分都是可识别的 Parts，它们可以通过名称识别，并将发送到服务器以指示请求的已设置部分或响应中所需的 部分。

构建器参数

使用 方法构建器，您可以通过重复调用其方法来准备一个动作调用。这些方法将始终接受一个参数，以下语句是真实的。

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

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

Cargo 功能

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

许可证

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