《google-datamigration1》库允许访问Google数据库迁移服务（服务版本v1）的所有功能。

本文档是从《数据库迁移服务》crate版本《5.0.5+20240621》生成的，其中《20240621》是mako代码生成器《v5.0.5》构建的《datamigration:v1》架构的确切修订版本。

关于数据库迁移服务v1 API的其他信息，请参阅官方文档网站。

功能

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

• 项目
• locations connection profiles create, locations connection profiles delete, locations connection profiles get, locations connection profiles get iam policy, locations connection profiles list, locations connection profiles patch, locations connection profiles set iam policy, locations connection profiles test iam permissions, locations conversion workspaces apply, locations conversion workspaces commit, locations conversion workspaces convert, locations conversion workspaces create, locations conversion workspaces delete, locations conversion workspaces describe conversion workspace revisions, locations conversion workspaces describe database entities, locations conversion workspaces get, locations conversion workspaces get iam policy, locations conversion workspaces list, locations conversion workspaces mapping rules create, locations conversion workspaces mapping rules delete, locations conversion workspaces mapping rules get, locations conversion workspaces mapping rules import, locations conversion workspaces mapping rules list, locations conversion workspaces patch, locations conversion workspaces rollback, locations conversion workspaces search background jobs, locations conversion workspaces seed, locations conversion workspaces set iam policy, locations conversion workspaces test iam permissions, locations fetch static ips, locations get, locations list, locations migration jobs create, locations migration jobs delete, locations migration jobs demote destination, locations migration jobs generate ssh script, locations migration jobs generate tcp proxy script, locations migration jobs get, locations migration jobs get iam policy, locations migration jobs list, locations migration jobs patch, locations migration jobs promote, locations migration jobs restart, locations migration jobs resume, locations migration jobs set iam policy, locations migration jobs start, locations migration jobs stop, locations migration jobs test iam permissions, locations migration jobs verify, locations operations cancel, locations operations delete, locations operations get, locations operations list, locations private connections create, locations private connections delete, locations private connections get, locations private connections get iam policy, locations private connections list, locations private connections set iam policy and locations private connections test iam permissions

本库的结构

API结构如下几个主要项目

• 枢纽
  • 一个中央对象，用于维护状态并允许访问所有活动
  • 创建方法构建器，进而允许访问单个调用构建器
• 资源
  • 可以应用活动的主要类型
  • 一组属性和部分
  • 部分
    • 一组属性
    • 在活动中从不直接使用
• 活动
  • 应用于资源的操作

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

一般来说，您可以通过以下方式调用活动

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

或具体来说...

let r = hub.projects().locations_connection_profiles_create(...).doit().await
let r = hub.projects().locations_connection_profiles_delete(...).doit().await
let r = hub.projects().locations_connection_profiles_patch(...).doit().await
let r = hub.projects().locations_conversion_workspaces_mapping_rules_import(...).doit().await
let r = hub.projects().locations_conversion_workspaces_apply(...).doit().await
let r = hub.projects().locations_conversion_workspaces_commit(...).doit().await
let r = hub.projects().locations_conversion_workspaces_convert(...).doit().await
let r = hub.projects().locations_conversion_workspaces_create(...).doit().await
let r = hub.projects().locations_conversion_workspaces_delete(...).doit().await
let r = hub.projects().locations_conversion_workspaces_patch(...).doit().await
let r = hub.projects().locations_conversion_workspaces_rollback(...).doit().await
let r = hub.projects().locations_conversion_workspaces_seed(...).doit().await
let r = hub.projects().locations_migration_jobs_create(...).doit().await
let r = hub.projects().locations_migration_jobs_delete(...).doit().await
let r = hub.projects().locations_migration_jobs_demote_destination(...).doit().await
let r = hub.projects().locations_migration_jobs_patch(...).doit().await
let r = hub.projects().locations_migration_jobs_promote(...).doit().await
let r = hub.projects().locations_migration_jobs_restart(...).doit().await
let r = hub.projects().locations_migration_jobs_resume(...).doit().await
let r = hub.projects().locations_migration_jobs_start(...).doit().await
let r = hub.projects().locations_migration_jobs_stop(...).doit().await
let r = hub.projects().locations_migration_jobs_verify(...).doit().await
let r = hub.projects().locations_operations_get(...).doit().await
let r = hub.projects().locations_private_connections_create(...).doit().await
let r = hub.projects().locations_private_connections_delete(...).doit().await

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

使用方法

设置您的项目

要使用这个库，您需要在您的Cargo.toml文件中添加以下行

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

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_datamigration1 as datamigration1;
use datamigration1::api::ConnectionProfile;
use datamigration1::{Result, Error};
use std::default::Default;
use datamigration1::{DatabaseMigrationService, 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 = DatabaseMigrationService::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 = ConnectionProfile::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_connection_profiles_create(req, "parent")
             .validate_only(true)
             .skip_validation(false)
             .request_id("amet.")
             .connection_profile_id("takimata")
             .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 格式。可选参数用于表示部分请求或响应是有效的。大多数可选参数都是被认为是 Parts，这些可以通过名称识别，将被发送到服务器以指示请求的集合部分或响应中期望的部分。

构建器参数

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

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

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

货物功能

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

许可证

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