该 google-dataproc1 库允许访问 Google Dataproc 服务的所有功能。

此文档是从 Dataproc crate 版本 5.0.5+20240617 生成的，其中 20240617 是由 mako 代码生成器 v5.0.5 构建的 dataproc:v1 模式的确切修订版。

有关 Dataproc v1 API 的其他所有信息，请参阅 官方文档站点。

功能

从中心 枢纽 简单地处理以下 资源 ...

• 项目
• locations autoscaling policies create, locations autoscaling policies delete, locations autoscaling policies get, locations autoscaling policies get iam policy, locations autoscaling policies list, locations autoscaling policies set iam policy, locations autoscaling policies test iam permissions, locations autoscaling policies update, locations batches analyze, locations batches create, locations batches delete, locations batches get, locations batches list, locations operations cancel, locations operations delete, locations operations get, locations operations list, locations session templates create, locations session templates delete, locations session templates get, locations session templates list, locations session templates patch, locations sessions create, locations sessions delete, locations sessions get, locations sessions list, locations sessions terminate, locations workflow templates create, locations workflow templates delete, locations workflow templates get, locations workflow templates get iam policy, locations workflow templates instantiate, locations workflow templates instantiate inline, locations workflow templates list, locations workflow templates set iam policy, locations workflow templates test iam permissions, locations workflow templates update, regions autoscaling policies create, regions autoscaling policies delete, regions autoscaling policies get, regions autoscaling policies get iam policy, regions autoscaling policies list, regions autoscaling policies set iam policy, regions autoscaling policies test iam permissions, regions autoscaling policies update, regions clusters create, regions clusters delete, regions clusters diagnose, regions clusters get, regions clusters get iam policy, regions clusters inject credentials, regions clusters list, regions clusters node groups create, regions clusters node groups get, regions clusters node groups repair, regions clusters node groups resize, regions clusters patch, regions clusters repair, regions clusters set iam policy, regions clusters start, regions clusters stop, regions clusters test iam permissions, regions jobs cancel, regions jobs delete, regions jobs get, regions jobs get iam policy, regions jobs list, regions jobs patch, regions jobs set iam policy, regions jobs submit, regions jobs submit as operation, regions jobs test iam permissions, regions operations cancel, regions operations delete, regions operations get, regions operations get iam policy, regions operations list, regions operations set iam policy, regions operations test iam permissions, regions workflow templates create, regions workflow templates delete, regions workflow templates get, regions workflow templates get iam policy, regions workflow templates instantiate, regions workflow templates instantiate inline, regions workflow templates list, regions workflow templates set iam policy, regions workflow templates test iam permissions and regions workflow templates update

本库结构

API 结构如下主要项

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

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

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

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

或者具体来说 ...

let r = hub.projects().locations_batches_analyze(...).doit().await
let r = hub.projects().locations_batches_create(...).doit().await
let r = hub.projects().locations_operations_get(...).doit().await
let r = hub.projects().locations_sessions_create(...).doit().await
let r = hub.projects().locations_sessions_delete(...).doit().await
let r = hub.projects().locations_sessions_terminate(...).doit().await
let r = hub.projects().locations_workflow_templates_instantiate(...).doit().await
let r = hub.projects().locations_workflow_templates_instantiate_inline(...).doit().await
let r = hub.projects().regions_clusters_node_groups_create(...).doit().await
let r = hub.projects().regions_clusters_node_groups_repair(...).doit().await
let r = hub.projects().regions_clusters_node_groups_resize(...).doit().await
let r = hub.projects().regions_clusters_create(...).doit().await
let r = hub.projects().regions_clusters_delete(...).doit().await
let r = hub.projects().regions_clusters_diagnose(...).doit().await
let r = hub.projects().regions_clusters_inject_credentials(...).doit().await
let r = hub.projects().regions_clusters_patch(...).doit().await
let r = hub.projects().regions_clusters_repair(...).doit().await
let r = hub.projects().regions_clusters_start(...).doit().await
let r = hub.projects().regions_clusters_stop(...).doit().await
let r = hub.projects().regions_jobs_submit_as_operation(...).doit().await
let r = hub.projects().regions_operations_get(...).doit().await
let r = hub.projects().regions_workflow_templates_instantiate(...).doit().await
let r = hub.projects().regions_workflow_templates_instantiate_inline(...).doit().await

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

用法

设置您的项目

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

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

完整示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_dataproc1 as dataproc1;
use dataproc1::api::Cluster;
use dataproc1::{Result, Error};
use std::default::Default;
use dataproc1::{Dataproc, 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 = Dataproc::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 = Cluster::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().regions_clusters_patch(req, "projectId", "region", "clusterName")
             .update_mask(FieldMask::new::<&str>(&[]))
             .request_id("ipsum")
             .graceful_decommission_timeout(chrono::Duration::seconds(9579437))
             .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(...)。

定制和回调

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

delegate trait 具有默认实现，允许您以最小的努力对其进行定制。

服务器请求中的可选部分

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

构建器参数

使用 method builders，您可以通过反复调用其方法来准备一个操作调用。这些方法将始终接受单个参数，以下语句对它适用。

• PODs（原始数据结构）是通过复制传递的。
• 字符串作为 &str 传递。
• 请求值会被移动。

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

Cargo 功能

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

许可证

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