该 google-recaptchaenterprise1 库允许访问Google Recaptcha Enterprise服务的所有功能。

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

关于Recaptcha Enterprise v1 API的其余信息可以在官方文档网站找到。

功能

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

• 项目
• 评估注释，创建评估，创建防火墙策略，删除防火墙策略，获取防火墙策略，列出防火墙策略，修补防火墙策略，重新排序防火墙策略，创建密钥，删除密钥，获取密钥，获取密钥指标，列出密钥，迁移密钥，修补密钥，检索旧版密钥，搜索相关账户组成员，列出相关账户组以及列出相关账户组成员

库结构

API 结构如下

• 中心节点
  • 一个中心对象，用于维护状态并允许访问所有 活动
  • 创建 方法构建器，它进一步允许访问单个 调用构建器
• 资源
  • 你可以应用 活动 的主要类型
  • 一系列属性和 部分
  • 部分
    • 一系列属性
    • 在 活动 中从不直接使用
• 活动
  • 应用于 资源 的操作

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

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

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

或者更具体地 ...

let r = hub.projects().keys_create(...).doit().await
let r = hub.projects().keys_get(...).doit().await
let r = hub.projects().keys_migrate(...).doit().await
let r = hub.projects().keys_patch(...).doit().await

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

用法

设置项目

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

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

完整示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_recaptchaenterprise1 as recaptchaenterprise1;
use recaptchaenterprise1::api::GoogleCloudRecaptchaenterpriseV1Key;
use recaptchaenterprise1::{Result, Error};
use std::default::Default;
use recaptchaenterprise1::{RecaptchaEnterprise, 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 = RecaptchaEnterprise::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 = GoogleCloudRecaptchaenterpriseV1Key::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().keys_patch(req, "name")
             .update_mask(FieldMask::new::<&str>(&[]))
             .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(...)`。

自定义和回调

您可以通过提供 delegate 给 Method Builder 来更改 `doit` 方法的调用方式，在最终执行 `doit` 调用之前。相关方法将被调用以提供进度信息，以及确定系统在失败时是否应该重试。

委托 trait 是默认实现的，允许您以最小的努力进行自定义。

服务器请求中的可选部分

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

构建器参数

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

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

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

Cargo 功能

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

许可

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