《google-file1_beta1》库允许访问 Google Cloud Filestore 服务的所有功能。

本文档由 Cloud Filestore 包版本 5.0.5+20240619 生成，其中 20240619 是由 mako 代码生成器 v5.0.5 构建的 file:v1beta1 方案的精确修订。

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

特性

从中心 枢纽 ...

• 项目
• 创建位置备份，删除位置备份，获取位置备份，列出位置备份，修补位置备份，获取位置，创建位置实例，删除位置实例，获取位置实例，列出位置实例，修补位置实例，提升副本，恢复实例，回滚实例，创建共享，删除共享，获取共享，列出共享，修补共享，创建快照，删除快照，获取快照，列出快照，修补快照，列出位置，取消操作，删除操作，获取操作和列出操作

本库的结构

API 被结构化为以下主要项目

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

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

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

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_shares_create(...).doit().await
let r = hub.projects().locations_instances_shares_delete(...).doit().await
let r = hub.projects().locations_instances_shares_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_beta1 = "*"
serde = "^1.0"
serde_json = "^1.0"

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_file1_beta1 as file1_beta1;
use file1_beta1::api::Backup;
use file1_beta1::{Result, Error};
use std::default::Default;
use file1_beta1::{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),
}

处理错误

系统产生的所有错误都作为(...)枚举值提供，作为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 规范将是无效的。

许可证

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