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

本文档由 Dns 包版本 5.0.5+20240616 生成，其中 20240616 是由 mako 代码生成器 v5.0.5 构建的 dns:v1 模式的确切版本。

有关 Dns v1 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(...) 调用创建 构建器。第二个处理 Activities，支持各种方法来配置即将进行的操作（此处未显示）。它设计成必须立即指定所有必需的参数（即 (...)），而所有可选参数都可以按所需的方式 构建。 doit() 方法执行与服务器的实际通信并返回相应的结果。

用法

设置您的项目

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

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

完整示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_dns1 as dns1;
use dns1::{Result, Error};
use std::default::Default;
use dns1::{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")
             .page_token("magna")
             .max_results(-11)
             .dns_name("ipsum")
             .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() 之前将一个 delegate 提供给 Method Builder 来更改 doit() 方法的调用方式。相应的方法将被调用以提供进度信息，以及确定系统在失败时是否应该重试。

delegate trait 默认实现，允许您以最少的努力进行定制。

服务器请求中的可选部分

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

构建器参数

使用 method builders，您可以通过重复调用其方法来准备一个动作调用。这些方法将始终接受一个参数，以下陈述对此参数是真实的。

• PODs 通过复制传递
• 字符串作为 &str 传递
• request values 通过移动传递

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

货物功能

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

许可证

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