google-ondemandscanning1 库允许访问 Google On-Demand Scanning 服务的所有功能。

此文档是从 On-Demand Scanning crate版本 5.0.5+20240624 生成的，其中 20240624 是由 mako 代码生成器 v5.0.5 构建的 ondemandscanning:v1 架构的确切修订。

有关 On-Demand Scanning v1 API的其余信息，请参阅 官方文档网站。

功能

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

• 项目
• 位置操作取消，位置操作删除，位置操作获取，位置操作列表，位置操作等待，位置扫描分析包 和 位置扫描漏洞列表

此库的结构

API结构如下

• 中心
  • 一个中心对象，用于维护状态并允许访问所有 活动
  • 创建 方法构建器，后者又允许访问单个 调用构建器
• 资源
  • 主要类型，您可以将 活动 应用到这些类型
  • 一组属性和组件
  • 组件
    • 一组属性
    • 从不直接用于活动
• 活动
  • 应用于资源的操作

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

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

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

或者具体...

let r = hub.projects().locations_operations_get(...).doit().await
let r = hub.projects().locations_operations_wait(...).doit().await
let r = hub.projects().locations_scans_analyze_packages(...).doit().await

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

用法

设置您的项目

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

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

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_ondemandscanning1 as ondemandscanning1;
use ondemandscanning1::{Result, Error};
use std::default::Default;
use ondemandscanning1::{OnDemandScanning, 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 = OnDemandScanning::new(hyper::Client::builder().build(hyper_rustls::HttpsConnectorBuilder::new().with_native_roots().unwrap().https_or_http().enable_http1().build()), auth);
// 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_operations_wait("name")
             .timeout(chrono::Duration::seconds(8946711))
             .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 进行编码和解码，使其 可编码 和 可解码。可选部分用于表示部分请求和响应是有效的。大多数可选部分都是 部分，可按名称识别，这些部分将被发送到服务器，以指示请求的设置部分或响应中期望的部分。

构建器参数

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

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

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

Cargo 功能

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

许可证

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