#iam #google #protocols

google-iam1

与Iam(协议v1)交互的完整库

30个稳定版本 (5个主要版本)

5.0.5+20240621 2024年6月27日
5.0.4+20240220 2024年3月5日
5.0.3+20230112 2023年8月23日
5.0.2+20230112 2023年3月16日
0.1.11+20160129 2016年1月30日

#620身份验证

Download history 4/week @ 2024-05-18 1/week @ 2024-05-25 79/week @ 2024-06-22 13/week @ 2024-06-29 20/week @ 2024-07-06

2,061 每月下载量
用于 google-iam1-cli

MIT 许可证

1.5MB
19K SLoC

google-iam1 库允许访问Google Iam服务的所有功能。

此文档是从Iamcrate版本5.0.5+20240621生成的,其中20240621mako代码生成器v5.0.5构建的iam:v1架构的确切修订。

有关Iam v1 API的所有其他信息,请参阅官方文档网站

功能

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

库的结构

API 结构如下主要项

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

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

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

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

或者具体...

let r = hub.locations().workforce_pools_operations_get(...).doit().await
let r = hub.locations().workforce_pools_providers_keys_operations_get(...).doit().await
let r = hub.locations().workforce_pools_providers_keys_create(...).doit().await
let r = hub.locations().workforce_pools_providers_keys_delete(...).doit().await
let r = hub.locations().workforce_pools_providers_keys_undelete(...).doit().await
let r = hub.locations().workforce_pools_providers_operations_get(...).doit().await
let r = hub.locations().workforce_pools_providers_create(...).doit().await
let r = hub.locations().workforce_pools_providers_delete(...).doit().await
let r = hub.locations().workforce_pools_providers_patch(...).doit().await
let r = hub.locations().workforce_pools_providers_undelete(...).doit().await
let r = hub.locations().workforce_pools_subjects_operations_get(...).doit().await
let r = hub.locations().workforce_pools_subjects_delete(...).doit().await
let r = hub.locations().workforce_pools_subjects_undelete(...).doit().await
let r = hub.locations().workforce_pools_create(...).doit().await
let r = hub.locations().workforce_pools_delete(...).doit().await
let r = hub.locations().workforce_pools_patch(...).doit().await
let r = hub.locations().workforce_pools_undelete(...).doit().await
let r = hub.projects().locations_workload_identity_pools_namespaces_managed_identities_operations_get(...).doit().await
let r = hub.projects().locations_workload_identity_pools_namespaces_managed_identities_workload_sources_operations_get(...).doit().await
let r = hub.projects().locations_workload_identity_pools_namespaces_operations_get(...).doit().await
let r = hub.projects().locations_workload_identity_pools_operations_get(...).doit().await
let r = hub.projects().locations_workload_identity_pools_providers_keys_operations_get(...).doit().await
let r = hub.projects().locations_workload_identity_pools_providers_keys_create(...).doit().await
let r = hub.projects().locations_workload_identity_pools_providers_keys_delete(...).doit().await
let r = hub.projects().locations_workload_identity_pools_providers_keys_undelete(...).doit().await
let r = hub.projects().locations_workload_identity_pools_providers_operations_get(...).doit().await
let r = hub.projects().locations_workload_identity_pools_providers_create(...).doit().await
let r = hub.projects().locations_workload_identity_pools_providers_delete(...).doit().await
let r = hub.projects().locations_workload_identity_pools_providers_patch(...).doit().await
let r = hub.projects().locations_workload_identity_pools_providers_undelete(...).doit().await
let r = hub.projects().locations_workload_identity_pools_create(...).doit().await
let r = hub.projects().locations_workload_identity_pools_delete(...).doit().await
let r = hub.projects().locations_workload_identity_pools_patch(...).doit().await
let r = hub.projects().locations_workload_identity_pools_undelete(...).doit().await

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

用法

设置你的项目

要使用这个库,你需要在你的Cargo.toml文件中放入以下行

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

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_iam1 as iam1;
use iam1::api::WorkforcePoolProviderKey;
use iam1::{Result, Error};
use std::default::Default;
use iam1::{Iam, 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 = Iam::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 = WorkforcePoolProviderKey::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.locations().workforce_pools_providers_keys_create(req, "parent")
             .workforce_pool_provider_key_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() 方法调用的方式。在执行最终的 doit() 调用之前,将调用相应的方法以提供进度信息,并确定系统是否在失败时应该重试。

代理特质 默认实现,允许您以最小的努力对其进行自定义。

服务器请求的可选部分

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

构建器参数

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

  • POD 通过复制传递
  • 字符串作为 &str 传递
  • 请求值 是移动的

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

Cargo 功能

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

许可证

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

依赖关系

~12–23MB
~345K SLoC