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

此文档是根据版本 Service Control crate 5.0.5+20240607 生成的，其中 20240607 是由 mako 代码生成器 v5.0.5 构建的 servicecontrol:v1 模式的确切修订版。

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

特性

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

• 服务
• 分配配额，检查 和 报告

本库结构

API被结构化为以下主要项

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

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

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

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

或者具体地 ...

let r = hub.services().check(...).doit().await

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

使用方法

设置你的项目

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

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

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_servicecontrol1 as servicecontrol1;
use servicecontrol1::api::CheckRequest;
use servicecontrol1::{Result, Error};
use std::default::Default;
use servicecontrol1::{ServiceControl, 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 = ServiceControl::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 = CheckRequest::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.services().check(req, "serviceName")
             .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(...)。

自定义和回调

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

委托特质（delegate trait）默认实现，让您以最小努力进行自定义。

服务器请求中的可选部分

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

构建器参数

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

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

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

Cargo 功能

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

许可证

服务控制库（servicecontrol1）由 Sebastian Thiel 生成，并置于 MIT 许可证之下。您可以在存储库的 许可证文件 中阅读全文。