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

本文档是从 Service Directory crate 版本 5.0.5+20240616 生成的，其中 20240616 是由 mako 代码生成器 v5.0.5 构建的 servicedirectory:v1 模式的确切修订版。

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

功能

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

• 项目
• 获取位置，位置列表，创建位置命名空间，删除位置命名空间，获取位置命名空间，获取位置命名空间 IAM 策略，位置命名空间列表，修复位置命名空间，创建位置命名空间服务，删除位置命名空间服务，创建位置命名空间服务端点，删除位置命名空间服务端点，获取位置命名空间服务端点，位置命名空间服务端点列表，修复位置命名空间服务端点，获取位置命名空间服务，获取位置命名空间服务 IAM 策略，位置命名空间服务列表，修复位置命名空间服务，解析位置命名空间服务，设置位置命名空间服务 IAM 策略，测试位置命名空间服务 IAM 权限，设置位置命名空间 IAM 策略和测试位置命名空间 IAM 权限

该库的结构

API 结构如下主要项

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

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

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

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_get_iam_policy(...).doit().await
let r = hub.projects().locations_namespaces_set_iam_policy(...).doit().await

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

用法

设置你的项目

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

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

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_servicedirectory1 as servicedirectory1;
use servicedirectory1::api::GetIamPolicyRequest;
use servicedirectory1::{Result, Error};
use std::default::Default;
use servicedirectory1::{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),
}

处理错误

系统产生的所有错误都通过doit()方法的返回值作为枚举提供，或者作为可能的中继结果传递给Hub代理或认证代理。

当代理处理错误或中间值时，它们有机会指导系统重试。这使得系统可能对所有类型的错误具有弹性。

上传和下载

如果方法支持下载，则应该由你读取响应体以获取媒体，该响应体是结果的一部分。如果该方法还支持响应结果，则默认返回该结果。你可以将其视为实际媒体的元数据。要触发媒体下载，你必须通过以下调用设置构建器：.param("alt", "media")。

支持上传的方法可以使用最多2种不同的协议：简单和可恢复。每种协议的独特性由定制的doit(...)方法表示，分别命名为upload(...)和upload_resumable(...)。

定制和回调

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

代理特质默认实现，允许您以最小的努力进行定制。

服务器请求中的可选部分

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

构建器参数

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

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

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

Cargo 功能

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

许可证

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