该 google-containeranalysis1_beta1 库允许访问 Google 容器分析服务（协议 v1beta1）的所有功能。

本文档是从 容器分析 库版本 5.0.5+20240625 生成的，其中 20240625 是由 mako 代码生成器 v5.0.5 构建的 containeranalysis:v1beta1 架构的确切修订版。

关于 容器分析 v1_beta1 API 的其他所有信息可以在 官方文档网站 找到。

功能

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

• 项目
• locations notes get, locations notes list, locations notes occurrences list, locations occurrences get, locations occurrences get notes, locations occurrences get vulnerability summary, locations occurrences list, locations resources export sbom, locations resources generate packages summary, notes batch create, notes create, notes delete, notes get, notes get iam policy, notes list, notes occurrences list, notes patch, notes set iam policy, notes test iam permissions, occurrences batch create, occurrences create, occurrences delete, occurrences get, occurrences get iam policy, occurrences get notes, occurrences get vulnerability summary, occurrences list, occurrences patch, occurrences set iam policy, occurrences test iam permissions, resources export sbom and resources generate packages summary

本库的结构

API 结构如下主要项目

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

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

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

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

或者具体地 ...

let r = hub.projects().locations_notes_get(...).doit().await
let r = hub.projects().locations_occurrences_get_notes(...).doit().await
let r = hub.projects().notes_create(...).doit().await
let r = hub.projects().notes_get(...).doit().await
let r = hub.projects().notes_patch(...).doit().await
let r = hub.projects().occurrences_get_notes(...).doit().await

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

用法

设置您的项目

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

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

完整示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_containeranalysis1_beta1 as containeranalysis1_beta1;
use containeranalysis1_beta1::api::Note;
use containeranalysis1_beta1::{Result, Error};
use std::default::Default;
use containeranalysis1_beta1::{ContainerAnalysis, 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 = ContainerAnalysis::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 = Note::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().notes_create(req, "parent")
             .note_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 Delegate 或 Authenticator Delegate。

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

上传和下载

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

支持上传的方法可以使用最多两种不同的协议进行上传：简单 和 可重试。每种协议的独特之处在于定制的 doit(...) 方法，分别命名为 upload(...) 和 upload_resumable(...)。

定制和回调

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

委托特质（delegate trait）默认实现，让您可以轻松地对其进行自定义。

服务器请求中的可选部分

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

构建器参数

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

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

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

Cargo 功能

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

许可证

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