google-serviceregistryalpha 库允许访问 Google Service Registry 服务的所有功能。

本文档是从 Service Registry 软件包版本 5.0.5+20160401 生成的，其中 20160401 是由 mako 代码生成器 v5.0.5 构建的 serviceregistry:alpha 模式的确切修订版。

有关 Service Registry alpha API 的其他所有信息，请参阅 官方文档网站。

功能

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

• 端点
• 删除、获取、插入、列表、修补 和 更新
• 操作
• 获取 和 列表

此库的结构

API 被组织成以下主要项

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

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

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

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

或者具体...

let r = hub.endpoints().delete(...).doit().await
let r = hub.endpoints().insert(...).doit().await
let r = hub.endpoints().patch(...).doit().await
let r = hub.endpoints().update(...).doit().await
let r = hub.operations().get(...).doit().await
let r = hub.operations().list(...).doit().await

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

用法

设置您的项目

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

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

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_serviceregistryalpha as serviceregistryalpha;
use serviceregistryalpha::{Result, Error};
use std::default::Default;
use serviceregistryalpha::{ServiceRegistry, 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 = ServiceRegistry::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.operations().list("project")
             .page_token("magna")
             .order_by("no")
             .max_results(46)
             .filter("voluptua.")
             .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(...)。

自定义和回调

您可以通过向Method Builder提供代理并在最终调用doit()之前来更改调用doit()方法的方式。将调用相应的方法来提供进度信息，并确定系统在失败时应否重试。

代理特质（delegate trait）默认实现，让您可以轻松自定义。

服务器请求中的可选部分

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

构建器参数

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

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

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

Cargo 功能

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

许可证

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