“google-domains1”库允许访问“Google Cloud Domains”服务的所有功能。

此文档是从版本 5.0.5+20240610 的“Cloud Domains”crate生成的，其中“20240610”是mako代码生成器 v5.0.5 构建的domains:v1架构的精确修订版本。

有关“Cloud Domains” v1 API的所有其他信息，请参阅官方文档网站。

功能

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

• 项目
• 获取位置，位置列表，获取位置操作，位置操作列表，配置位置注册联系人设置，配置位置注册DNS设置，配置位置注册管理设置，删除位置注册，导出位置注册，获取位置注册，获取位置注册IAM策略，导入位置注册，启动推送转移，位置注册列表，位置注册修补，位置注册，续费域名，重置授权代码，检索授权代码，检索Google域名DNS记录，检索Google域名转发配置，检索可导入域名，检索注册参数，检索转移参数，搜索域名，设置位置注册IAM策略，测试位置注册IAM权限以及位置注册转移

库结构

API结构如下主要项

• 中心
  • 一个中心对象，用于维护状态并允许访问所有活动
  • 创建方法构建器，进而允许访问单个调用构建器
• 资源
  • 主要类型，可以将活动应用于这些类型
  • 一组属性和组件
  • 组件
    • 一组属性
    • 从未直接用于活动
• 活动
  • 应用于资源的操作

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

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

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

或者具体...

let r = hub.projects().locations_operations_get(...).doit().await
let r = hub.projects().locations_registrations_configure_contact_settings(...).doit().await
let r = hub.projects().locations_registrations_configure_dns_settings(...).doit().await
let r = hub.projects().locations_registrations_configure_management_settings(...).doit().await
let r = hub.projects().locations_registrations_delete(...).doit().await
let r = hub.projects().locations_registrations_export(...).doit().await
let r = hub.projects().locations_registrations_import(...).doit().await
let r = hub.projects().locations_registrations_initiate_push_transfer(...).doit().await
let r = hub.projects().locations_registrations_patch(...).doit().await
let r = hub.projects().locations_registrations_register(...).doit().await
let r = hub.projects().locations_registrations_renew_domain(...).doit().await
let r = hub.projects().locations_registrations_transfer(...).doit().await

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

用法

设置你的项目

要使用此库，你将在你的Cargo.toml文件中放入以下几行

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

完整示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_domains1 as domains1;
use domains1::api::Registration;
use domains1::{Result, Error};
use std::default::Default;
use domains1::{CloudDomains, 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 = CloudDomains::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 = Registration::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_registrations_patch(req, "name")
             .update_mask(FieldMask::new::<&str>(&[]))
             .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() 之前提供一个 代理 给 方法构建器 来改变 doit() 方法的调用方式。相应的函数将被调用以提供进度信息，并确定系统在失败时应否重试。

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

服务器请求的可选部分

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

构建器参数

使用 方法构建器，您可以通过反复调用其方法来准备一个动作调用。这些方法总是接受单个参数，以下陈述对此有效。

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

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

Cargo 特性

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

许可证

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