google-policysimulator1 库允许访问 Google Policy Simulator 服务的所有功能。

此文档是从 Policy Simulator 软件包版本 5.0.5+20240623 生成的，其中 20240623 是由 mako 代码生成器 v5.0.5 构建的 policysimulator:v1 架构的精确修订版本。

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

功能

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

• 文件夹
• locations org policy violations previews operations get、locations replays create、locations replays get、locations replays operations get、locations replays operations list 和 locations replays results list
• 操作
• get 和 list
• 组织
• 获取组织策略违规预览操作，创建位置回放，获取位置回放，获取位置回放操作，获取位置回放操作列表和获取位置回放结果列表
• 项目
• 获取位置组织策略违规预览操作，创建位置回放，获取位置回放，获取位置回放操作，获取位置回放操作列表和获取位置回放结果列表

此库的结构

API被组织成以下主要项

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

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

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

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

或者具体...

let r = hub.folders().locations_org_policy_violations_previews_operations_get(...).doit().await
let r = hub.folders().locations_replays_operations_get(...).doit().await
let r = hub.folders().locations_replays_create(...).doit().await
let r = hub.operations().get(...).doit().await
let r = hub.organizations().locations_org_policy_violations_previews_operations_get(...).doit().await
let r = hub.organizations().locations_replays_operations_get(...).doit().await
let r = hub.organizations().locations_replays_create(...).doit().await
let r = hub.projects().locations_org_policy_violations_previews_operations_get(...).doit().await
let r = hub.projects().locations_replays_operations_get(...).doit().await
let r = hub.projects().locations_replays_create(...).doit().await

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

用法

设置你的项目

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

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

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_policysimulator1 as policysimulator1;
use policysimulator1::api::GoogleCloudPolicysimulatorV1Replay;
use policysimulator1::{Result, Error};
use std::default::Default;
use policysimulator1::{PolicySimulator, 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 = PolicySimulator::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 = GoogleCloudPolicysimulatorV1Replay::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().locations_replays_create(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()之前向Method Builder提供一个delegate来更改调用doit()方法的方式。相应的方法将被调用以提供进度信息，并确定系统在失败时是否应该重试。

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

服务器请求中的可选部分

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

构建器参数

使用method builders，您可以通过反复调用其方法来准备一个动作调用。这些方法始终接受单个参数，以下语句对此参数是正确的。

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

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

Cargo 功能

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

许可证

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