google-sts1 库允许访问 Google Cloud Security Token 服务的所有功能。

此文档是从 Cloud Security Token crate 版本 5.0.5+20240612 生成的，其中 20240612 是由 mako 代码生成器 v5.0.5 构建的 sts:v1 架构的精确版本。

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

功能

从中央 中心 无需费力地使用以下功能 ...

• 令牌

该库的结构

API 结构如下主要项目

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

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

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

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

或者更具体地 ...

let r = hub.methods().token(...).doit().await

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

用法

设置项目

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

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

完整示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_sts1 as sts1;
use sts1::api::GoogleIdentityStsV1ExchangeTokenRequest;
use sts1::{Result, Error};
use std::default::Default;
use sts1::{CloudSecurityToken, 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 = CloudSecurityToken::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 = GoogleIdentityStsV1ExchangeTokenRequest::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.methods().token(req)
             .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进行编码和解码。使用可选类型来表示部分请求和响应是有效的。大多数可选类型被认为是部分，可以通过名称识别，这些部分将被发送到服务器，以指示请求的设置部分或响应中所需的部分。

构建器参数

通过使用方法构建器，您可以通过重复调用它的方法来准备一个动作调用。这些方法始终只接受一个参数，以下陈述适用于该参数。

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

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

Cargo特性

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

许可证

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