该 google-datafusion1 库允许访问 Google 数据融合服务的所有功能。

本文档是根据数据融合 crate 版本 5.0.5+20240618 生成的，其中 20240618 是由 mako 代码生成器 v5.0.5 构建的 datafusion:v1 架构的确切修订版本。

有关数据融合 v1 API 的其他所有信息，请参阅 官方文档网站。

功能

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

• 项目
• 获取位置，创建位置实例，删除位置实例，创建位置实例DNS对等，删除位置实例DNS对等，列出位置实例DNS对等，获取位置实例，获取位置实例IAM策略，列出位置实例，修补位置实例，重启位置实例，设置位置实例IAM策略，测试位置实例IAM权限，列出位置，取消位置操作，删除位置操作，获取位置操作，列出位置操作以及列出位置版本

库结构

API结构如下几个主要部分

• 枢纽
  • 一个中心对象，用于维护状态并允许访问所有活动
  • 创建方法构建器，它们反过来允许访问单个调用构建器
• 资源
  • 主要类型，可以将活动应用于它们
  • 属性和部分的集合
  • 部分
    • 属性的集合
    • 在活动中从未直接使用
• 活动
  • 应用于资源的操作

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

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

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

或者具体...

let r = hub.projects().locations_instances_create(...).doit().await
let r = hub.projects().locations_instances_delete(...).doit().await
let r = hub.projects().locations_instances_patch(...).doit().await
let r = hub.projects().locations_instances_restart(...).doit().await
let r = hub.projects().locations_operations_get(...).doit().await

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

用法

设置您的项目

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

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

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_datafusion1 as datafusion1;
use datafusion1::api::Instance;
use datafusion1::{Result, Error};
use std::default::Default;
use datafusion1::{DataFusion, 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 = DataFusion::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 = Instance::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_instances_create(req, "parent")
             .instance_id("magna")
             .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(...)。

定制和回调

您可以通过在最终Delegate调用之前向Method Builder提供Delegate来更改调用doit方法的方式。相应的函数将被调用以提供进度信息，以及确定系统在失败时是否应该重试。

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

服务器请求中的可选部分

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

构建器参数

通过方法构建器，您可以通过反复调用其方法来准备操作调用。这些方法始终接受单个参数，以下陈述适用于该参数。

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

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

Cargo 特性

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

许可证

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