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

此文档是根据 Cloud Redis crate 版本 5.0.5+20240613 生成的，其中 20240613 是由 mako 代码生成器 v5.0.5 构建的 redis:v1 模式的确切修订版本。

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

功能

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

• 项目
• 创建位置集群，删除位置集群，获取位置集群，获取证书授权，列出位置集群，修改位置集群，获取位置，创建位置实例，删除位置实例，导出位置实例，故障转移位置实例，获取位置实例，获取认证字符串，导入位置实例，列出位置实例，修改位置实例，重新安排维护时间，升级位置实例，列出位置，取消位置操作，删除位置操作，获取位置操作以及列出位置操作

该库的结构

API结构分为以下主要项目

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

所有结构都标有适用的特性，以进一步分类它们并便于浏览。

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

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

或者具体...

let r = hub.projects().locations_clusters_create(...).doit().await
let r = hub.projects().locations_clusters_delete(...).doit().await
let r = hub.projects().locations_clusters_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_export(...).doit().await
let r = hub.projects().locations_instances_failover(...).doit().await
let r = hub.projects().locations_instances_import(...).doit().await
let r = hub.projects().locations_instances_patch(...).doit().await
let r = hub.projects().locations_instances_reschedule_maintenance(...).doit().await
let r = hub.projects().locations_instances_upgrade(...).doit().await
let r = hub.projects().locations_operations_get(...).doit().await

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

使用方法

设置您的项目

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

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

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_redis1 as redis1;
use redis1::api::Cluster;
use redis1::{Result, Error};
use std::default::Default;
use redis1::{CloudRedis, 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 = CloudRedis::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 = Cluster::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_clusters_create(req, "parent")
             .request_id("magna")
             .cluster_id("no")
             .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()方法的返回值作为Result枚举提供，或者作为可能的中间结果传递给Hub Delegate，或者Authenticator Delegate。

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

上传和下载

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

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

定制和回调

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

代理trait默认实现，允许您以最小的努力进行定制。

服务器请求中的可选部分

本库提供的所有结构都设计成可以通过 编码 和 解码 通过 json。使用可选值来表示部分请求或响应是有效的。大多数可选值被认为是 部分，可以通过名称识别，这些部分将被发送到服务器以指示请求的设置部分或所需的响应部分。

构建器参数

使用 方法构建器，您可以通过反复调用其方法来准备一个动作调用。这些方法始终接受一个参数，以下陈述对此参数成立。

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

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

Cargo 功能

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

许可证

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