#google #google-api #protocols #web #web-api #api #smartdevicemanagemen

google-smartdevicemanagement1

一个用于与智能设备管理(协议 v1)交互的完整库

10 个稳定版本 (3 个主要版本)

5.0.5+20240616 2024 年 6 月 27 日
5.0.4+20240218 2024 年 3 月 5 日
5.0.3+20230112 2023 年 8 月 24 日
5.0.2+20230112 2023 年 3 月 17 日
2.0.4+20210319 2021 年 4 月 15 日

#2599 in 网页开发


用于 google-smartdevicemanagem…

MIT 许可证

185KB
2.5K SLoC

google-smartdevicemanagement1 库允许访问 Google 智能设备管理服务的所有功能。

本文档是从 智能设备管理 crate 版本 5.0.5+20240616 生成的,其中 20240616 是由 mako 代码生成器 v5.0.5 构建的 smartdevicemanagement:v1 架构的确切修订。

有关智能设备管理 v1 API 的其他所有信息,请参阅 官方文档网站

功能

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

库的结构

API 结构如下

  • 枢纽
  • 资源
    • 可以应用于 活动 的主要类型
    • 属性和 部分 的集合
    • 部分
      • 属性集合
      • 活动 中从不直接使用
  • 活动
    • 资源 适用的操作

所有 结构 都带有适用的属性,以便进一步分类它们并简化浏览。

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

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

或者具体来说...

let r = hub.enterprises().devices_get(...).doit().await

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

用法

设置你的项目

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

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

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_smartdevicemanagement1 as smartdevicemanagement1;
use smartdevicemanagement1::{Result, Error};
use std::default::Default;
use smartdevicemanagement1::{SmartDeviceManagement, 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 = SmartDeviceManagement::new(hyper::Client::builder().build(hyper_rustls::HttpsConnectorBuilder::new().with_native_roots().unwrap().https_or_http().enable_http1().build()), auth);
// 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.enterprises().devices_get("name")
             .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 DelegateAuthenticator 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 规范将无效。

许可证

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

依赖关系

~12–23MB
~343K SLoC