google-prod_tt_sasportal1_alpha1 库允许访问 Google SAS 门户测试 服务的所有功能。

本文档是根据 SAS 门户测试 包版本 5.0.5+20240626 生成的，其中 20240626 是由 mako 代码生成器 v5.0.5 构建的 prod_tt_sasportal:v1alpha1 架构的确切修订版。

有关 SAS 门户测试 v1_alpha1 API 的其他信息，请参阅 官方文档网站。

功能

从中心 枢纽 简单地处理以下 资源 ...

• 客户
• deployments create, deployments delete, deployments devices create, deployments devices create signed, deployments devices list, deployments get, deployments list, deployments move, deployments patch, devices create, devices create signed, devices delete, devices get, devices list, devices move, devices patch, devices sign device, devices update signed, get, list, list gcp project deployments, list legacy organizations, migrate organization, nodes create, nodes delete, nodes deployments create, nodes deployments list, nodes devices create, nodes devices create signed, nodes devices list, nodes get, nodes list, nodes move, nodes nodes create, nodes nodes list, nodes patch, patch, provision deployment and setup sas analytics
• 部署
• 设备删除、设备获取、设备移动、设备修补、设备签名、更新签名 和 获取
• 安装程序
• 生成密钥 和 验证
• 节点
• 删除部署，创建设备，创建签名设备，列出设备，获取部署，列出部署，移动部署，修补部署，创建设备，创建签名设备，删除设备，获取设备，列出设备，移动设备，修补设备，签名设备，更新签名，获取，创建节点，删除节点，创建节点部署，列出节点部署，创建节点设备，创建签名节点设备，列出节点设备，获取节点，列出节点，移动节点，创建节点节点，列出节点节点以及修补节点
• 策略
• 获取，设置和测试

该库的结构

API 被组织为以下主要项目

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

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

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

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

或者具体来说...

let r = hub.customers().deployments_devices_create(...).doit().await
let r = hub.customers().deployments_devices_create_signed(...).doit().await
let r = hub.customers().devices_create(...).doit().await
let r = hub.customers().devices_create_signed(...).doit().await
let r = hub.customers().devices_get(...).doit().await
let r = hub.customers().devices_patch(...).doit().await
let r = hub.customers().devices_update_signed(...).doit().await
let r = hub.customers().nodes_devices_create(...).doit().await
let r = hub.customers().nodes_devices_create_signed(...).doit().await
let r = hub.deployments().devices_get(...).doit().await
let r = hub.deployments().devices_patch(...).doit().await
let r = hub.deployments().devices_update_signed(...).doit().await
let r = hub.nodes().deployments_devices_create(...).doit().await
let r = hub.nodes().deployments_devices_create_signed(...).doit().await
let r = hub.nodes().devices_create(...).doit().await
let r = hub.nodes().devices_create_signed(...).doit().await
let r = hub.nodes().devices_get(...).doit().await
let r = hub.nodes().devices_patch(...).doit().await
let r = hub.nodes().devices_update_signed(...).doit().await
let r = hub.nodes().nodes_devices_create(...).doit().await
let r = hub.nodes().nodes_devices_create_signed(...).doit().await

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

用法

设置项目

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

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

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_prod_tt_sasportal1_alpha1 as prod_tt_sasportal1_alpha1;
use prod_tt_sasportal1_alpha1::api::SasPortalDevice;
use prod_tt_sasportal1_alpha1::{Result, Error};
use std::default::Default;
use prod_tt_sasportal1_alpha1::{SASPortalTesting, 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 = SASPortalTesting::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 = SasPortalDevice::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.customers().devices_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()枚举提供，作为doit()方法的返回值，或者作为可能的中间结果传递给Hub Delegate()或Authenticator Delegate()。

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

上传和下载

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

支持上传的方法可以使用多达2种不同的协议进行上传：简单和可恢复。每种协议的独特性通过定制的doit(...)方法表示，分别命名为upload(...)和upload_resumable(...)。

自定义和回调

您可以通过向 Method Builder 提供一个 代理 来修改 doit() 方法的调用方式，在最终进行 doit() 调用之前。相关方法将被调用以提供进度信息，并确定系统是否应在失败时重试。

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

服务器请求中的可选部分

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

构建器参数

使用 方法构建器，您可以通过重复调用其方法来准备操作调用。这些方法始终接受一个参数，以下语句对其成立。

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

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

Cargo 功能

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

许可证

prod_tt_sasportal1_alpha1 库由 Sebastian Thiel 创建，并置于 MIT 许可证下。您可以在存储库的 许可证文件 中阅读全文。