8 个版本 (稳定)
5.0.5+20240613 | 2024年6月27日 |
---|---|
5.0.4+20240222 | 2024年3月5日 |
5.0.3+20230119 | 2023年8月24日 |
5.0.2+20230119 | 2023年3月16日 |
3.0.0+20220225 | 2022年3月8日 |
#2519 in 网页编程
1MB
13K SLoC
该 google-vmmigration1
库允许访问 Google VM 迁移服务(服务 v1)的所有功能。
此文档是根据 VM 迁移服务 crate 版本 5.0.5+20240613 生成的,其中 20240613 是由 mako 代码生成器 v5.0.5 构建的 vmmigration:v1 架构的确切修订版本。
有关 VM 迁移服务 v1 API 的其他所有信息,请参阅 官方文档网站。
功能
从中央 中心轻松处理以下 资源...
- 项目
- locations get, locations groups add group migration, locations groups create, locations groups delete, locations groups get, locations groups list, locations groups patch, locations groups remove group migration, locations image imports create, locations image imports delete, locations image imports get, locations image imports image import jobs cancel, locations image imports image import jobs get, locations image imports image import jobs list, locations image imports list, locations list, locations operations cancel, locations operations delete, locations operations get, locations operations list, locations sources create, locations sources datacenter connectors create, locations sources datacenter connectors delete, locations sources datacenter connectors get, locations sources datacenter connectors list, locations sources datacenter connectors upgrade appliance, locations sources delete, locations sources fetch inventory, locations sources get, locations sources list, locations sources migrating vms clone jobs cancel, locations sources migrating vms clone jobs create, locations sources migrating vms clone jobs get, locations sources migrating vms clone jobs list, locations sources migrating vms create, locations sources migrating vms cutover jobs cancel, locations sources migrating vms cutover jobs create, locations sources migrating vms cutover jobs get, locations sources migrating vms cutover jobs list, locations sources migrating vms delete, locations sources migrating vms finalize migration, locations sources migrating vms get, locations sources migrating vms list, locations sources migrating vms patch, locations sources migrating vms pause migration, locations sources migrating vms replication cycles get, locations sources migrating vms replication cycles list, locations sources migrating vms resume migration, locations sources migrating vms start migration, locations sources patch, locations sources utilization reports create, locations sources utilization reports delete, locations sources utilization reports get, locations sources utilization reports list, locations target projects create, locations target projects delete, locations target projects get, locations target projects list and locations target projects patch
本库的结构
API 被结构化为以下主要项目
所有 结构 都用适用特性标记,以便进一步分类并简化浏览。
一般来说,您可以像这样调用 活动
let r = hub.resource().activity(...).doit().await
或者具体地说...
let r = hub.projects().locations_groups_add_group_migration(...).doit().await
let r = hub.projects().locations_groups_create(...).doit().await
let r = hub.projects().locations_groups_delete(...).doit().await
let r = hub.projects().locations_groups_patch(...).doit().await
let r = hub.projects().locations_groups_remove_group_migration(...).doit().await
let r = hub.projects().locations_image_imports_image_import_jobs_cancel(...).doit().await
let r = hub.projects().locations_image_imports_create(...).doit().await
let r = hub.projects().locations_image_imports_delete(...).doit().await
let r = hub.projects().locations_operations_get(...).doit().await
let r = hub.projects().locations_sources_datacenter_connectors_create(...).doit().await
let r = hub.projects().locations_sources_datacenter_connectors_delete(...).doit().await
let r = hub.projects().locations_sources_datacenter_connectors_upgrade_appliance(...).doit().await
let r = hub.projects().locations_sources_migrating_vms_clone_jobs_cancel(...).doit().await
let r = hub.projects().locations_sources_migrating_vms_clone_jobs_create(...).doit().await
let r = hub.projects().locations_sources_migrating_vms_cutover_jobs_cancel(...).doit().await
let r = hub.projects().locations_sources_migrating_vms_cutover_jobs_create(...).doit().await
let r = hub.projects().locations_sources_migrating_vms_create(...).doit().await
let r = hub.projects().locations_sources_migrating_vms_delete(...).doit().await
let r = hub.projects().locations_sources_migrating_vms_finalize_migration(...).doit().await
let r = hub.projects().locations_sources_migrating_vms_patch(...).doit().await
let r = hub.projects().locations_sources_migrating_vms_pause_migration(...).doit().await
let r = hub.projects().locations_sources_migrating_vms_resume_migration(...).doit().await
let r = hub.projects().locations_sources_migrating_vms_start_migration(...).doit().await
let r = hub.projects().locations_sources_utilization_reports_create(...).doit().await
let r = hub.projects().locations_sources_utilization_reports_delete(...).doit().await
let r = hub.projects().locations_sources_create(...).doit().await
let r = hub.projects().locations_sources_delete(...).doit().await
let r = hub.projects().locations_sources_patch(...).doit().await
let r = hub.projects().locations_target_projects_create(...).doit().await
let r = hub.projects().locations_target_projects_delete(...).doit().await
let r = hub.projects().locations_target_projects_patch(...).doit().await
资源(resource)和活动(activity)的调用创建构建器。第二个与Activities
相关,支持配置即将进行的操作的各种方法(此处未展示)。它设计得要求立即指定所有必需的参数(即(...)
),而所有可选的则可以按照需求逐步构建。doit()
方法执行与服务器的实际通信,并返回相应的结果。
用法
设置项目
要使用这个库,您需要将以下行放入您的Cargo.toml
文件中
[dependencies]
google-vmmigration1 = "*"
serde = "^1.0"
serde_json = "^1.0"
一个完整的示例
extern crate hyper;
extern crate hyper_rustls;
extern crate google_vmmigration1 as vmmigration1;
use vmmigration1::api::Group;
use vmmigration1::{Result, Error};
use std::default::Default;
use vmmigration1::{VMMigrationService, 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 = VMMigrationService::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 = Group::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_groups_create(req, "parent")
.request_id("magna")
.group_id("no")
.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
枚举的返回值提供,或者作为中间结果传递给Hub Delegate或Authenticator Delegate。
当代理处理错误或中间值时,它们有机会指示系统重试。这使得系统可能对各种错误具有弹性。
上传和下载
如果方法支持下载,响应体,作为Result的一部分,应由您读取以获取媒体。如果此类方法也支持Response Result,则默认返回该结果。您可以将它视为实际媒体的元数据。要触发媒体下载,您必须通过此调用设置构建器:.param("alt", "media")
。
支持上传的方法可以使用最多2种不同的协议:简单和可恢复。每种的区别由自定义的doit(...)
方法表示,分别命名为upload(...)
和upload_resumable(...)
。
定制和回调
您可以通过在最终doit()
调用之前向Method Builder
提供一个代理来更改doit()
方法的调用方式。相应的方法将被调用以提供进度信息,并确定系统在失败时是否应该重试。
代理特质默认实现,允许您以最小的努力进行自定义。
服务器请求中的可选部分
本库提供的所有结构都设计为可以通过json进行编码和解码。可选参数用于表示部分请求或响应是有效的。大多数可选参数被视为部分,可以通过名称识别,这些部分将被发送到服务器以指示请求或响应中的指定部分。
构建器参数
通过使用方法构建器,您可以通过多次调用其方法来准备操作调用。这些方法始终接受单个参数,以下陈述适用于这些参数。
参数将被复制或克隆到构建器中,以确保它们与其原始的生命周期独立。
Cargo功能
utoipa
- 添加对utoipa的支持,并在所有类型上派生utoipa::ToSchema
。您必须在#[openapi(schemas(...))]
中导入和注册所需类型,否则生成的openapi
规范将是无效的。
许可证
vmmigration1库由Sebastian Thiel生成,并置于MIT许可证之下。您可以在存储库的许可证文件中阅读全文。
依赖关系
~12–23MB
~344K SLoC