google-androiddeviceprovisioning1 库允许访问 Google Android 配置伙伴 服务的所有功能。

此文档是从 Android 配置伙伴 版本 5.0.5+20240624 生成的，其中 20240624 是由 mako 代码生成器 v5.0.5 构建的 androiddeviceprovisioning:v1 架构的确切修订。

关于 Android 配置伙伴 v1 API 的其他信息可以在 官方文档网站 找到。

功能

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

• 客户
• 创建配置，删除配置，获取配置，列出配置，修补配置，应用配置到设备，获取设备，列出设备，从设备中删除配置，设备取消认领，列出 DPC 和 列出
• 操作
• 获取
• 合作伙伴
• 创建客户，列出客户，设备申领，异步设备申领，按标识符查找设备，按所有者查找设备，获取设备，获取设备SIM锁状态，设备元数据，取消设备申领，异步取消设备申领，异步更新设备元数据，供应商客户列表和供应商列表

库的结构

API结构如下主要项目

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

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

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

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

或具体来说...

let r = hub.customers().configurations_delete(...).doit().await
let r = hub.customers().devices_apply_configuration(...).doit().await
let r = hub.customers().devices_remove_configuration(...).doit().await
let r = hub.customers().devices_unclaim(...).doit().await
let r = hub.partners().devices_unclaim(...).doit().await

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

用法

设置你的项目

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

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

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_androiddeviceprovisioning1 as androiddeviceprovisioning1;
use androiddeviceprovisioning1::api::CustomerApplyConfigurationRequest;
use androiddeviceprovisioning1::{Result, Error};
use std::default::Default;
use androiddeviceprovisioning1::{AndroidProvisioningPartner, 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 = AndroidProvisioningPartner::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 = CustomerApplyConfigurationRequest::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_apply_configuration(req, "parent")
             .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方法被调用的方式。相应的会调用方法来提供进度信息，以及确定系统在失败时是否应该重试。

delegate trait默认实现，允许您以最少的努力对其进行定制。

服务器请求中的可选部分

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

构建器参数

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

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

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

Cargo 功能

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

许可证

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