google-orgpolicy2 库允许访问 Google OrgPolicy API 服务（协议 v2）的所有功能。

本文档是从 OrgPolicy API 包版本 5.0.5+20240621 生成的，其中 20240621 是由 mako 代码生成器 v5.0.5 构建的 orgpolicy:v2 架构的确切修订版。

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

功能

从中央 中心 无需麻烦地处理以下 资源...

• 文件夹
• 约束列表，创建策略，删除策略，获取策略，获取有效策略，列出策略 和 更新策略
• 组织
• 约束列表，创建自定义约束，删除自定义约束，获取自定义约束，自定义约束列表，自定义约束修补，创建策略，删除策略，获取策略，获取有效策略，策略列表以及策略修补
• 项目
• 约束列表，创建策略，删除策略，获取策略，获取有效策略，策略列表以及策略修补

本库的结构

API 结构如下主要项目

• 中心
  • 一个中心对象，用于维护状态并允许访问所有 活动
  • 创建 方法构建器，进而允许访问单个 调用构建器
• 资源
  • 主要类型，可以应用于 活动
  • 属性和 部分 的集合
  • 部分
    • 属性的集合
    • 在 活动 中永远不会直接使用
• 活动
  • 应用于 资源 的操作

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

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

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

或具体...

let r = hub.folders().policies_create(...).doit().await
let r = hub.folders().policies_get(...).doit().await
let r = hub.folders().policies_get_effective_policy(...).doit().await
let r = hub.folders().policies_patch(...).doit().await
let r = hub.organizations().policies_create(...).doit().await
let r = hub.organizations().policies_get(...).doit().await
let r = hub.organizations().policies_get_effective_policy(...).doit().await
let r = hub.organizations().policies_patch(...).doit().await
let r = hub.projects().policies_create(...).doit().await
let r = hub.projects().policies_get(...).doit().await
let r = hub.projects().policies_get_effective_policy(...).doit().await
let r = hub.projects().policies_patch(...).doit().await

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

用法

设置您的项目

要使用此库，您需要将以下行添加到您的 Cargo.toml 文件中

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

完整示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_orgpolicy2 as orgpolicy2;
use orgpolicy2::api::GoogleCloudOrgpolicyV2Policy;
use orgpolicy2::{Result, Error};
use std::default::Default;
use orgpolicy2::{OrgPolicyAPI, 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 = OrgPolicyAPI::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 = GoogleCloudOrgpolicyV2Policy::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().policies_patch(req, "name")
             .update_mask(FieldMask::new::<&str>(&[]))
             .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 枚举返回值提供，或者作为可能的中继结果传递给 Hub Delegate 或 Authenticator Delegate。

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

上传和下载

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

支持上传的方法可以使用最多两种协议进行上传：简单 和 可恢复。每种协议的独特性由定制的 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 规范将是无效的。

许可证

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