google-containeranalysis1 库允许访问 Google 容器分析服务的所有功能。

本文档由 Container Analysiscrate 版本 5.0.5+20240625 生成，其中 20240625 是由 mako 代码生成器 v5.0.5 构建的 containeranalysis:v1 架构的精确修订。

有关 Container Analysis v1 API 的其他所有信息，请参阅 官方文档站点。

功能

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

• 项目
• 获取位置注释，列出位置注释，列出位置注释发生情况，获取位置发生情况，获取位置发生情况注释，获取位置发生情况漏洞摘要，列出位置发生情况，位置资源导出SBOM，批量创建注释，创建注释，删除注释，获取注释，获取注释IAM策略，列出注释，列出注释发生情况，修补注释，设置注释IAM策略，测试注释IAM权限，批量创建发生情况，创建发生情况，删除发生情况，获取发生情况，获取发生情况IAM策略，获取发生情况注释，获取发生情况漏洞摘要，列出发生情况，修补发生情况，设置发生情况IAM策略，测试发生情况IAM权限以及资源导出SBOM

本库的结构

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 = "*"
serde = "^1.0"
serde_json = "^1.0"

完整示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_containeranalysis1 as containeranalysis1;
use containeranalysis1::api::Note;
use containeranalysis1::{Result, Error};
use std::default::Default;
use containeranalysis1::{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。

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

上传和下载

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

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

自定义和回调

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

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

服务器请求中的可选部分

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

构建器参数

使用method builders，您可以通过反复调用其方法来准备操作调用。这些方法始终接受单个参数，以下语句对它适用。

• PODs通过复制传递
• 字符串作为&str传递
• request values被移动

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

Cargo功能

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

许可证

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