google-dns2 库允许访问 Google Dns 服务的所有功能。

本文档由 Dnscrate 版本 5.0.5+20240616 生成，其中 20240616 是由 mako 代码生成器 v5.0.5 构建的 dns:v2 架构的确切修订版本。

有关 Dns v2 API 的其他所有信息，请参阅 官方文档站点。

特性

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

• 更改
• 创建，获取 和 列表
• dns 密钥
• 获取 和 列表
• 托管区域操作
• 获取 和 列表
• 托管区域
• 创建，删除，获取，获取 IAM 策略，列表，修补，设置 IAM 策略，测试 IAM 权限 和 更新
• 策略
• 创建，删除，获取，列表，修补和更新
• 项目
• 获取
• 资源记录集
• 创建，删除，获取，列表和修补
• 响应策略
• 创建，删除，获取，列表，修补和更新
• 响应策略规则
• 创建，删除，获取，列表，修补和更新

此库的结构

API结构如下

• 中心
  • 一个中心对象，用于维护状态和允许访问所有活动
  • 创建方法构建器，这又允许访问单个调用构建器
• 资源
  • 您可以将活动应用到的主要类型
  • 属性和部分的集合
  • 部分
    • 属性的集合
    • 在活动中从未直接使用
• 活动
  • 应用到资源的操作

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

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

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

或者具体...

let r = hub.managed_zones().create(...).doit().await
let r = hub.managed_zones().delete(...).doit().await
let r = hub.managed_zones().get(...).doit().await
let r = hub.managed_zones().get_iam_policy(...).doit().await
let r = hub.managed_zones().list(...).doit().await
let r = hub.managed_zones().patch(...).doit().await
let r = hub.managed_zones().set_iam_policy(...).doit().await
let r = hub.managed_zones().test_iam_permissions(...).doit().await
let r = hub.managed_zones().update(...).doit().await

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

用法

设置您的项目

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

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

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_dns2 as dns2;
use dns2::{Result, Error};
use std::default::Default;
use dns2::{Dns, 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 = Dns::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.managed_zones().list("project", "location")
             .page_token("no")
             .max_results(-55)
             .dns_name("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(...)。

自定义和回调

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

delegate trait有默认实现，允许您以最小的努力进行自定义。

服务器请求中的可选部分

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

构建器参数

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

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

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

Cargo功能

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

许可证

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