12个稳定版本 (4个主要版本)

5.0.5+20240616 2024年6月27日
5.0.4+20240226 2024年3月5日
5.0.3+20230105 2023年8月24日
5.0.2+20230105 2023年3月16日
1.0.14+20200624 2020年7月10日

#2560 in Web编程


用于 google-servicedirectory1_…

MIT 许可证

515KB
6K SLoC

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

此文档是根据Service Directory crate版本 5.0.5+20240616 生成的,其中 20240616 是由 mako 代码生成器 v5.0.5 构建的 servicedirectory:v1beta1 架构的确切修订版本。

关于Service Directory v1_beta1 API的其他所有信息都可以在官方文档站点找到。

功能

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

该库的结构

API 结构分为以下主要部分

  • 中心
    • 一个中心对象,用于维护状态和允许访问所有 活动
    • 创建 方法构建器,这些构建器进而允许访问单个 调用构建器
  • 资源
    • 你可以将其应用于 Activities 的基本类型
    • 属性和 Parts 的集合
    • Parts
      • 属性的集合
      • 永远不会在 Activities 中直接使用
  • Activities
    • 应用于 Resources 的操作

所有 structures 都标记了适用的特性,以便进一步分类和简化浏览。

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

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

或者具体来说...

let r = hub.projects().locations_namespaces_services_get_iam_policy(...).doit().await
let r = hub.projects().locations_namespaces_services_set_iam_policy(...).doit().await
let r = hub.projects().locations_namespaces_workloads_get_iam_policy(...).doit().await
let r = hub.projects().locations_namespaces_workloads_set_iam_policy(...).doit().await
let r = hub.projects().locations_namespaces_get_iam_policy(...).doit().await
let r = hub.projects().locations_namespaces_set_iam_policy(...).doit().await

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

用法

设置你的项目

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

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

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_servicedirectory1_beta1 as servicedirectory1_beta1;
use servicedirectory1_beta1::api::GetIamPolicyRequest;
use servicedirectory1_beta1::{Result, Error};
use std::default::Default;
use servicedirectory1_beta1::{ServiceDirectory, 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 = ServiceDirectory::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 = GetIamPolicyRequest::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.projects().locations_namespaces_services_get_iam_policy(req, "resource")
             .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 规范将是无效的。

许可证

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

依赖项

~12–22MB
~342K SLoC