#google-cloud #memcached #google #protocols #memcache #google-api #web

google-memcache1_beta2

一个完整的库,用于与Google Cloud Memorystore for Memcached(协议v1beta2)交互

12个稳定版本 (4个主要版本)

5.0.5+20240614 2024年6月27日
5.0.4+20240222 2024年3月5日
5.0.3+20230103 2023年8月24日
5.0.2+20230103 2023年3月16日
1.0.14+20200608 2020年7月10日

2420Web编程 中排名

Download history 6/week @ 2024-05-19 1/week @ 2024-06-09 1/week @ 2024-06-16 94/week @ 2024-06-23 19/week @ 2024-06-30

758 每月下载次数
google-memcache1_beta2-cl… 中使用

MIT 许可证

345KB
4.5K SLoC

google-memcache1_beta2 库允许访问Google Cloud Memorystore for Memcached服务的所有功能。

本文档是从Cloud Memorystore for Memcached crate版本5.0.5+20240614生成的,其中20240614mako代码生成器v5.0.5构建的memcache:v1beta2架构的确切修订版本。

有关Cloud Memorystore for Memcached v1_beta2 API的所有其他信息,请参阅官方文档站点

功能

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

本库的结构

API结构分为以下主要项目

  • 中心
  • 资源
    • 可以应用活动到的主要类型
    • 属性和部分的集合
    • 部分
      • 属性集合
      • 从不直接用于活动
  • 活动
    • 应用到资源的操作

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

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

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

或者具体...

let r = hub.projects().locations_instances_apply_parameters(...).doit().await
let r = hub.projects().locations_instances_apply_software_update(...).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_reschedule_maintenance(...).doit().await
let r = hub.projects().locations_instances_update_parameters(...).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-memcache1_beta2 = "*"
serde = "^1.0"
serde_json = "^1.0"

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_memcache1_beta2 as memcache1_beta2;
use memcache1_beta2::api::Instance;
use memcache1_beta2::{Result, Error};
use std::default::Default;
use memcache1_beta2::{CloudMemorystoreForMemcached, 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 = CloudMemorystoreForMemcached::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 = Instance::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_instances_create(req, "parent")
             .instance_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 DelegateAuthenticator Delegate

当委托处理错误或中继值时,它们可能会有机会指导系统重试。这使得系统可能对所有类型的错误具有弹性。

上传和下载

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

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

定制和回调

您可以通过向Method Builder提供delegate来改变doit()方法的调用方式,在最终进行doit()调用之前。相应的方法将被调用以提供进度信息,以及确定系统在失败时应否重试。

delegate trait默认实现,允许您以最少的努力进行定制。

服务器请求中的可选部分

此库提供的所有结构都旨在通过json进行编码和解码encodabledecodable。可选参数用于指示部分请求或响应是有效的。大多数可选参数被视为Parts,可通过名称识别,这些名称将发送到服务器以指示请求的设置部分或所需的响应部分。

构建器参数

通过method builders,您可以通过重复调用其方法来准备一个操作调用。这些方法始终接受单个参数,以下陈述对它都是真实的。

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

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

Cargo 功能

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

许可证

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

依赖项

约 12-23MB
~343K SLoC