google-cloudiot1 库允许访问 Google Cloud Iot 服务的所有功能。

本文档是从 Cloud Iot crate 版本 5.0.5+0 生成的，其中 0 是由 mako 代码生成器 v5.0.5 构建的 cloudiot:v1 模式的确切修订版。

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

功能

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

• 项目
• 将设备绑定到网关的注册表位置，创建注册表位置，删除注册表位置，设备配置版本列表，创建设备，删除设备，获取设备，设备列表，修改云到设备配置，设备修补，向设备发送命令，设备状态列表，获取注册表，获取 IAM 策略，组设备列表，组获取 IAM 策略，组设置 IAM 策略，组测试 IAM 权限，注册表列表，修补注册表，设置 IAM 策略，测试 IAM 权限以及从网关解绑设备

该库的结构

API 结构如下主要项目

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

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

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

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

或者具体来说 ...

let r = hub.projects().locations_registries_groups_get_iam_policy(...).doit().await
let r = hub.projects().locations_registries_groups_set_iam_policy(...).doit().await
let r = hub.projects().locations_registries_get_iam_policy(...).doit().await
let r = hub.projects().locations_registries_set_iam_policy(...).doit().await

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

使用方法

设置您的项目

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

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

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_cloudiot1 as cloudiot1;
use cloudiot1::api::GetIamPolicyRequest;
use cloudiot1::{Result, Error};
use std::default::Default;
use cloudiot1::{CloudIot, 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 = CloudIot::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 = GetIamPolicyRequest::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.projects().locations_registries_groups_get_iam_policy(req, "resource")
             .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 规范将是无效的。

许可证

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