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

此文档是从 sasportal crate 版本 5.0.5+20240615 生成的，其中 20240615 是由 mako 代码生成器 v5.0.5 构建的 sasportal:v1alpha1 方案的精确修订版本。

关于 sasportal 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-sasportal1_alpha1 = "*"
serde = "^1.0"
serde_json = "^1.0"

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_sasportal1_alpha1 as sasportal1_alpha1;
use sasportal1_alpha1::api::SasPortalDevice;
use sasportal1_alpha1::{Result, Error};
use std::default::Default;
use sasportal1_alpha1::{Sasportal, 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 = Sasportal::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(...)。

定制和回调

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

代理特质默认实现，让您可以轻松定制。

服务器请求中的可选部分

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

构建器参数

使用方法构建器，您可以通过重复调用其方法来准备一个操作调用。这些方法始终接受单个参数，以下陈述是正确的。

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

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

Cargo功能

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

许可

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