该 google-file1 库允许访问Google Cloud Filestore服务的所有功能。

本文档由Cloud Filestore crate版本 5.0.5+20240608 生成，其中 20240608 是由 mako 代码生成器 v5.0.5 构建的 file:v1 模式的确切版本。

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

功能

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

• 项目
• 创建位置备份，删除位置备份，获取位置备份，列出位置备份，更新位置备份，获取位置，创建位置实例，删除位置实例，获取位置实例，列出位置实例，更新位置实例，提升副本，还原实例，回滚实例，创建实例快照，删除实例快照，获取实例快照，列出实例快照，更新实例快照，列出位置，取消位置操作，删除位置操作，获取位置操作以及列出位置操作

本库的结构

API 结构分为以下主要项目

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

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

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

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

或具体来说 ...

let r = hub.projects().locations_backups_create(...).doit().await
let r = hub.projects().locations_backups_delete(...).doit().await
let r = hub.projects().locations_backups_patch(...).doit().await
let r = hub.projects().locations_instances_snapshots_create(...).doit().await
let r = hub.projects().locations_instances_snapshots_delete(...).doit().await
let r = hub.projects().locations_instances_snapshots_patch(...).doit().await
let r = hub.projects().locations_instances_create(...).doit().await
let r = hub.projects().locations_instances_delete(...).doit().await
let r = hub.projects().locations_instances_patch(...).doit().await
let r = hub.projects().locations_instances_promote_replica(...).doit().await
let r = hub.projects().locations_instances_restore(...).doit().await
let r = hub.projects().locations_instances_revert(...).doit().await
let r = hub.projects().locations_operations_get(...).doit().await

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

用法

设置您的项目

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

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

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_file1 as file1;
use file1::api::Backup;
use file1::{Result, Error};
use std::default::Default;
use file1::{CloudFilestore, 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 = CloudFilestore::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 = Backup::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().locations_backups_create(req, "parent")
             .backup_id("magna")
             .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代理或认证代理。

当代理处理错误或中间值时，它们有机会指示系统重试。这使得系统可能对所有类型的错误具有弹性。

上传和下载

如果某个方法支持下载，则响应体（是Result的一部分）应该由您读取以获取媒体。如果该方法还支持Response Result，则默认返回该结果。您可以将它视为实际媒体的数据。要触发媒体下载，您必须通过以下调用设置构建器：.param("alt", "media")。

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

自定义和回调

您可以通过在最终doit()调用之前向Method Builder提供一个代理来更改doit()方法的调用方式。相应的方法将被调用以提供进度信息，并确定系统在失败时是否应该重试。

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

服务器请求中的可选部分

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

构建器参数

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

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

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

Cargo 功能

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

许可证

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