《google-recommender1_beta1》库允许访问 Google 推荐服务所有功能。

本文档是根据版本 5.0.5+20240623 的 Recommender 框架生成的，其中 20240623 是由 mako 代码生成器 v5.0.5 构建的 recommender:v1beta1 模式的确切版本。

Recommender v1_beta1 API 的官方文档可以在这里找到：https://cloud.google.com/recommender/docs/.

功能

轻松处理以下资源：google-recommender1_beta1/Recommender …

• 账单
• 获取位置洞察类型配置，获取位置洞察类型洞察，获取位置洞察类型洞察列表，标记位置洞察类型洞察为已接受，更新位置洞察类型配置，位置列表，获取位置推荐者配置，获取位置推荐者推荐，获取位置推荐者推荐列表，标记位置推荐者推荐为已认领，标记位置推荐者推荐为已忽略，标记位置推荐者推荐为失败，标记位置推荐者推荐为成功，以及 更新位置推荐者配置
• 文件夹
• 获取位置洞察类型洞察，获取位置洞察类型洞察列表，标记位置洞察类型洞察为已接受，位置列表，获取位置推荐者推荐，获取位置推荐者推荐列表，标记位置推荐者推荐为已认领，标记位置推荐者推荐为已忽略，标记位置推荐者推荐为失败，以及 标记位置推荐者推荐为成功
• 洞察类型
• 列表
• 组织
• 获取位置洞察类型配置，获取位置洞察类型洞察，列出位置洞察类型洞察，标记位置洞察类型洞察为已接受，更新位置洞察类型配置，列出位置，获取位置推荐者配置，获取位置推荐者推荐，列出位置推荐者推荐，标记位置推荐者推荐为已领取，标记位置推荐者推荐为已忽略，标记位置推荐者推荐为失败，标记位置推荐者推荐为成功，以及更新位置推荐者配置
• 项目
• 获取位置洞察类型配置，获取位置洞察类型洞察，列出位置洞察类型洞察，标记位置洞察类型洞察为已接受，更新位置洞察类型配置，列出位置，获取位置推荐者配置，获取位置推荐者推荐，列出位置推荐者推荐，标记位置推荐者推荐为已领取，标记位置推荐者推荐为已忽略，标记位置推荐者推荐为失败，标记位置推荐者推荐为成功，以及更新位置推荐者配置
• 推荐者
• 列表

本库的结构

API 结构如下主要项

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

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

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

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

或者具体...

let r = hub.billing_accounts().locations_recommenders_recommendations_get(...).doit().await
let r = hub.billing_accounts().locations_recommenders_recommendations_mark_claimed(...).doit().await
let r = hub.billing_accounts().locations_recommenders_recommendations_mark_dismissed(...).doit().await
let r = hub.billing_accounts().locations_recommenders_recommendations_mark_failed(...).doit().await
let r = hub.billing_accounts().locations_recommenders_recommendations_mark_succeeded(...).doit().await
let r = hub.folders().locations_recommenders_recommendations_get(...).doit().await
let r = hub.folders().locations_recommenders_recommendations_mark_claimed(...).doit().await
let r = hub.folders().locations_recommenders_recommendations_mark_dismissed(...).doit().await
let r = hub.folders().locations_recommenders_recommendations_mark_failed(...).doit().await
let r = hub.folders().locations_recommenders_recommendations_mark_succeeded(...).doit().await
let r = hub.organizations().locations_recommenders_recommendations_get(...).doit().await
let r = hub.organizations().locations_recommenders_recommendations_mark_claimed(...).doit().await
let r = hub.organizations().locations_recommenders_recommendations_mark_dismissed(...).doit().await
let r = hub.organizations().locations_recommenders_recommendations_mark_failed(...).doit().await
let r = hub.organizations().locations_recommenders_recommendations_mark_succeeded(...).doit().await
let r = hub.projects().locations_recommenders_recommendations_get(...).doit().await
let r = hub.projects().locations_recommenders_recommendations_mark_claimed(...).doit().await
let r = hub.projects().locations_recommenders_recommendations_mark_dismissed(...).doit().await
let r = hub.projects().locations_recommenders_recommendations_mark_failed(...).doit().await
let r = hub.projects().locations_recommenders_recommendations_mark_succeeded(...).doit().await

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

用法

设置项目

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

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

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_recommender1_beta1 as recommender1_beta1;
use recommender1_beta1::api::GoogleCloudRecommenderV1beta1MarkRecommendationClaimedRequest;
use recommender1_beta1::{Result, Error};
use std::default::Default;
use recommender1_beta1::{Recommender, 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 = Recommender::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 = GoogleCloudRecommenderV1beta1MarkRecommendationClaimedRequest::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.billing_accounts().locations_recommenders_recommendations_mark_claimed(req, "name")
             .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")。

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

自定义和回调

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

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

服务器请求中的可选部分

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

构建器参数

使用方法构建器，您可以通过重复调用其方法来准备一个动作调用。这些方法始终接受单个参数，以下语句是正确的。

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

参数将被复制或克隆到构建器中，以使其与原始生命周期独立。

Cargo功能

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

许可证

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