“google-webrisk1”库允许访问 Google Web Risk 服务（协议 v1）的所有功能。

本文档是根据 Web Risk 包版本 5.0.5+20240623 生成的，其中 20240623 是由 mako 代码生成器 v5.0.5 构建的 webrisk:v1 架构的确切版本。

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

功能

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

• 散列值
• 搜索
• 项目
• 操作取消、操作删除、操作获取、操作列表 和 提交创建
• 威胁列表
• 计算差异
• 统一资源标识符（URI）
• 搜索

本库的结构

API 结构如下主要项目

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

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

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

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

或具体...

let r = hub.projects().operations_cancel(...).doit().await
let r = hub.projects().operations_delete(...).doit().await

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

用法

设置您的项目

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

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

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_webrisk1 as webrisk1;
use webrisk1::api::GoogleLongrunningCancelOperationRequest;
use webrisk1::{Result, Error};
use std::default::Default;
use webrisk1::{WebRisk, 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 = WebRisk::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 = GoogleLongrunningCancelOperationRequest::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().operations_cancel(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),
}

处理错误

系统产生的所有错误都作为 枚举 提供为 doit() 方法的返回值，或者作为中间结果传递给 Hub 代理 或 认证代理。

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

上传和下载

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

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

定制和回调

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

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

服务器请求中的可选部分

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

构建器参数

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

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

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

Cargo特性

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

许可证

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