该 google-cloudasset1_beta1 库允许访问 Google Cloud Asset 服务的所有功能。

此文档是从 Cloud Asset 库版本 5.0.5+20240621 生成的，其中 20240621 是由 mako 代码生成器 v5.0.5 构建的 cloudasset:v1beta1 模式的确切修订版。

有关 Cloud Asset v1_beta1 API 的其他所有信息，请参阅 官方文档站点。

功能

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

• 文件夹
• 导出资产 和 获取操作
• 组织
• 批量获取资产历史记录、导出资产 和 获取操作
• 项目
• 批量获取资产历史记录、导出资产 和 获取操作

本库的结构

API 结构如下主要项

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

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

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

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

或者具体...

let r = hub.folders().operations_get(...).doit().await
let r = hub.folders().export_assets(...).doit().await
let r = hub.organizations().operations_get(...).doit().await
let r = hub.organizations().export_assets(...).doit().await
let r = hub.projects().operations_get(...).doit().await
let r = hub.projects().export_assets(...).doit().await

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

用法

设置您的项目

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

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

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_cloudasset1_beta1 as cloudasset1_beta1;
use cloudasset1_beta1::api::ExportAssetsRequest;
use cloudasset1_beta1::{Result, Error};
use std::default::Default;
use cloudasset1_beta1::{CloudAsset, 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 = CloudAsset::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 = ExportAssetsRequest::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.folders().export_assets(req, "parent")
             .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 规范将是无效的。

许可证

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