#google #metastore #protocols #google-api #web #web-api

google-metastore1_beta

一个用于与Dataproc Metastore(协议v1beta)交互的完整库

11个稳定版本 (3个主要版本)

5.0.5+20240613 2024年6月27日
5.0.4+20240228 2024年3月5日
5.0.3+20230111 2023年8月24日
5.0.2+20230111 2023年3月16日
2.0.4+20210325 2021年4月15日

#2402 in Web编程

Download history 5/week @ 2024-05-19 1/week @ 2024-05-26 92/week @ 2024-06-23 27/week @ 2024-06-30

716 每月下载量
google-metastore1_beta-cl… 中使用

MIT 许可证

1MB
11K SLoC

google-metastore1_beta 库允许访问Google Dataproc Metastore服务(协议v1beta)的所有功能。

本文档是从Dataproc Metastorecrate版本5.0.5+20240613生成的,其中20240613mako代码生成器v5.0.5构建的metastore:v1beta模式的确切修订版本。

有关Dataproc Metastore v1_beta API的所有其他信息,请参阅官方文档网站

功能

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

该库的结构

API分为以下主要项

  • 枢纽
    • 一个中心对象,用于维护状态并允许访问所有活动
    • 创建方法构建器,这些构建器反过来允许访问单个调用构建器
  • 资源
    • 可以应用于活动的主要类型
    • 一组属性和部分
    • 部分
      • 一组属性
      • 活动中 never 直接使用
  • 活动
    • 应用于资源的操作

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

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

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

或具体来说 ...

let r = hub.projects().locations_federations_create(...).doit().await
let r = hub.projects().locations_federations_delete(...).doit().await
let r = hub.projects().locations_federations_patch(...).doit().await
let r = hub.projects().locations_operations_get(...).doit().await
let r = hub.projects().locations_services_backups_create(...).doit().await
let r = hub.projects().locations_services_backups_delete(...).doit().await
let r = hub.projects().locations_services_metadata_imports_create(...).doit().await
let r = hub.projects().locations_services_metadata_imports_patch(...).doit().await
let r = hub.projects().locations_services_migration_executions_delete(...).doit().await
let r = hub.projects().locations_services_alter_location(...).doit().await
let r = hub.projects().locations_services_alter_table_properties(...).doit().await
let r = hub.projects().locations_services_cancel_migration(...).doit().await
let r = hub.projects().locations_services_complete_migration(...).doit().await
let r = hub.projects().locations_services_create(...).doit().await
let r = hub.projects().locations_services_delete(...).doit().await
let r = hub.projects().locations_services_export_metadata(...).doit().await
let r = hub.projects().locations_services_move_table_to_database(...).doit().await
let r = hub.projects().locations_services_patch(...).doit().await
let r = hub.projects().locations_services_query_metadata(...).doit().await
let r = hub.projects().locations_services_restore(...).doit().await
let r = hub.projects().locations_services_start_migration(...).doit().await

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

用法

设置您的项目

要使用这个库,您需要将以下行放入您的Cargo.toml文件中

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

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_metastore1_beta as metastore1_beta;
use metastore1_beta::api::Federation;
use metastore1_beta::{Result, Error};
use std::default::Default;
use metastore1_beta::{DataprocMetastore, 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 = DataprocMetastore::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 = Federation::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_federations_create(req, "parent")
             .request_id("magna")
             .federation_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枚举提供,作为doit()方法的返回值,或者作为可能的中继结果传递给Hub DelegateAuthenticator Delegate

当代理处理错误或中间值时,它们有机会指示系统重试。这使得系统可能对所有类型的错误都有弹性。

上传和下载

如果某个方法支持下载,则响应体(它是Result的一部分)应由您读取以获取媒体。如果此类方法也支持Response Result,则默认返回该值。您可以将其视为实际媒体的元数据。要触发媒体下载,您必须通过此调用设置构建器:.param("alt", "media")

支持上传的方法可以使用多达2种不同的协议进行上传:简单可恢复。每种方法的独特性由定制的doit(...)方法表示,分别命名为upload(...)upload_resumable(...)

自定义和回调

您可以通过在最终调用doit()之前提供代理方法构建器来更改调用doit()的方法。相应的方法将被调用以提供进度信息,并确定系统是否在失败时应该重试。

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

服务器请求中的可选部分

本库提供的所有结构都是设计成可以通过 编码解码 来使用 json 格式。可选参数用来表示部分请求和响应是有效的。大多数可选参数都是 Parts,可以通过名称识别,这些部分会被发送到服务器以指示请求的哪些部分或响应中期望的哪些部分。

构建器参数

通过使用 方法构建器,您可以通过反复调用其方法来准备一个操作调用。这些方法始终接受单个参数,以下陈述对它成立。

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

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

Cargo 功能

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

许可证

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

依赖项

~12–23MB
~346K SLoC