#google-api #google #web-api

google-admin1_directory

与目录(协议 directory_v1)交互的完整库

35 个版本 (18 个稳定版本)

使用旧的 Rust 2015

1.0.13+20200204 2020年4月12日
1.0.12+20190214 2019年12月9日
1.0.10+20190214 2019年7月6日
1.0.8+20180917 2018年10月14日
0.1.2+20150123 2015年3月25日

#2858网络编程


用于 google-admin1_directory-c…

MIT 许可证

1.5MB
21K SLoC

google-admin1_directory 库允许访问 Google 目录服务的所有功能。

此文档是从 directory crate 版本 1.0.13+20200204 生成的,其中 20200204 是由 mako 代码生成器 v1.0.13 构建的 admin:directory_v1 架构的确切修订。

有关 directory v1_directory API 的其他信息,请参阅 官方文档网站

功能

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

由...支持的订阅

此库的结构

API 结构如下主要项目

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

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

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

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

或者具体地说...

let r = hub.users().photos_patch(...).doit()
let r = hub.users().aliases_delete(...).doit()
let r = hub.users().undelete(...).doit()
let r = hub.users().photos_get(...).doit()
let r = hub.users().update(...).doit()
let r = hub.users().aliases_watch(...).doit()
let r = hub.users().insert(...).doit()
let r = hub.users().photos_delete(...).doit()
let r = hub.users().patch(...).doit()
let r = hub.users().photos_update(...).doit()
let r = hub.users().watch(...).doit()
let r = hub.users().get(...).doit()
let r = hub.users().aliases_insert(...).doit()
let r = hub.users().make_admin(...).doit()
let r = hub.users().aliases_list(...).doit()
let r = hub.users().list(...).doit()
let r = hub.users().delete(...).doit()

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

用法

设置项目

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

[dependencies]
google-admin1_directory = "*"
# This project intentionally uses an old version of Hyper. See
# https://github.com/Byron/google-apis-rs/issues/173 for more
# information.
hyper = "^0.10"
hyper-rustls = "^0.6"
serde = "^1.0"
serde_json = "^1.0"
yup-oauth2 = "^1.0"

完整示例

extern crate hyper;
extern crate hyper_rustls;
extern crate yup_oauth2 as oauth2;
extern crate google_admin1_directory as admin1_directory;
use admin1_directory::Channel;
use admin1_directory::{Result, Error};
use std::default::Default;
use oauth2::{Authenticator, DefaultAuthenticatorDelegate, ApplicationSecret, MemoryStorage};
use admin1_directory::Directory;

// Get an ApplicationSecret instance by some means. It contains the `client_id` and 
// `client_secret`, among other things.
let secret: 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 = Authenticator::new(&secret, DefaultAuthenticatorDelegate,
                              hyper::Client::with_connector(hyper::net::HttpsConnector::new(hyper_rustls::TlsClient::new())),
                              <MemoryStorage as Default>::default(), None);
let mut hub = Directory::new(hyper::Client::with_connector(hyper::net::HttpsConnector::new(hyper_rustls::TlsClient::new())), 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 = Channel::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.users().watch(req)
             .view_type("eirmod")
             .sort_order("sit")
             .show_deleted("Stet")
             .query("sed")
             .projection("et")
             .page_token("dolores")
             .order_by("kasd")
             .max_results(-22)
             .event("takimata")
             .domain("justo")
             .customer("amet.")
             .custom_field_mask("erat")
             .doit();

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::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(...)

定制和回调

您可以通过提供 delegateMethod Builder 来修改 doit() 方法的调用方式,在最终 doit() 调用之前。将调用相应的方法以提供进度信息,并确定系统是否在失败时应该重试。

默认实现了 委托特质,允许您以最小的努力进行自定义。

服务器请求中的可选部分

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

构建器参数

通过使用 方法构建器,您可以通过反复调用其方法来准备一个动作调用。这些方法始终接受单个参数,以下陈述对此适用。

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

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

许可证

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

依赖项

~6–17MB
~285K SLoC