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

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

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

功能

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

• 项目
• 分配ID，开始事务，提交，导出，导入，创建索引，删除索引，获取索引，列出索引，查找，取消操作，删除操作，获取操作，列出操作，预留ID，回滚，运行聚合查询和运行查询

库结构

API结构如下主要项目

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

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

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

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

或具体来说...

let r = hub.projects().indexes_create(...).doit().await
let r = hub.projects().indexes_delete(...).doit().await
let r = hub.projects().operations_get(...).doit().await
let r = hub.projects().export(...).doit().await
let r = hub.projects().import(...).doit().await

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

使用方法

设置你的项目

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

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

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_datastore1 as datastore1;
use datastore1::api::GoogleDatastoreAdminV1Index;
use datastore1::{Result, Error};
use std::default::Default;
use datastore1::{Datastore, 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 = Datastore::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 = GoogleDatastoreAdminV1Index::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().indexes_create(req, "projectId")
             .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() 之前向 Method Builder 提供一个 delegate 来更改 doit() 方法的调用方式。相应的方程序将调用以提供进度信息，并确定系统在失败时是否应该重试。

delegate trait 有默认实现，这使得您可以轻松地进行自定义。

服务器请求中的可选部分

此库提供的所有结构都是为了通过 json 进行 编码 和 解码 而设计的。可选部分用于表示部分请求或响应是有效的。大多数可选部分是 Parts，可通过名称识别，将发送到服务器以指示请求的设置部分或响应中所需的部分。

构建器参数

通过使用 method builders，您可以通过反复调用其方法来准备一个动作调用。这些方法始终只接受一个参数，以下陈述适用于该参数。

• PODs 通过复制传递
• 字符串作为 &str 传递
• request values 被移动

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

Cargo 功能

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

许可证

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