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

5.0.5+20240613	2024 年 6 月 27 日
5.0.4+20231227	2024 年 3 月 5 日
5.0.3+20221213	2023 年 8 月 24 日
5.0.2+20221213	2023 年 3 月 17 日
2.0.4+20210305	2021 年 4 月 15 日

#2221 in 网页编程

713 每月下载次数
用于 google-notebooks1-cli

MIT 许可证

1MB
13K SLoC

该 google-notebooks1 库允许访问 Google AI 平台笔记本服务（协议 v1）的所有功能。

本文档由 AI 平台笔记本 库版本 5.0.5+20240613 生成，其中 20240613 是由 mako 代码生成器 v5.0.5 构建的 notebooks:v1 模式的确切版本。

关于 AI 平台笔记本 v1 API 的其他所有信息都可以在官方文档网站上找到。

特性

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

本库结构

API 结构为以下主要项目

中心
- 一个中央对象，用于维护状态并允许访问所有活动
- 创建 方法构建器，后者反过来允许访问单个 调用构建器
资源
- 可以将其应用于活动的主要类型
- 一组属性和部分
- 部分
  - 一组属性
  - 在活动中 never 直接使用
活动
- 应用于资源的操作

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

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

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

或具体地 ...

let r = hub.projects().locations_environments_create(...).doit().await
let r = hub.projects().locations_environments_delete(...).doit().await
let r = hub.projects().locations_executions_create(...).doit().await
let r = hub.projects().locations_executions_delete(...).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_diagnose(...).doit().await
let r = hub.projects().locations_instances_migrate(...).doit().await
let r = hub.projects().locations_instances_register(...).doit().await
let r = hub.projects().locations_instances_report(...).doit().await
let r = hub.projects().locations_instances_report_event(...).doit().await
let r = hub.projects().locations_instances_reset(...).doit().await
let r = hub.projects().locations_instances_rollback(...).doit().await
let r = hub.projects().locations_instances_set_accelerator(...).doit().await
let r = hub.projects().locations_instances_set_labels(...).doit().await
let r = hub.projects().locations_instances_set_machine_type(...).doit().await
let r = hub.projects().locations_instances_start(...).doit().await
let r = hub.projects().locations_instances_stop(...).doit().await
let r = hub.projects().locations_instances_update_config(...).doit().await
let r = hub.projects().locations_instances_update_shielded_instance_config(...).doit().await
let r = hub.projects().locations_instances_upgrade(...).doit().await
let r = hub.projects().locations_instances_upgrade_internal(...).doit().await
let r = hub.projects().locations_operations_get(...).doit().await
let r = hub.projects().locations_runtimes_create(...).doit().await
let r = hub.projects().locations_runtimes_delete(...).doit().await
let r = hub.projects().locations_runtimes_diagnose(...).doit().await
let r = hub.projects().locations_runtimes_migrate(...).doit().await
let r = hub.projects().locations_runtimes_patch(...).doit().await
let r = hub.projects().locations_runtimes_report_event(...).doit().await
let r = hub.projects().locations_runtimes_reset(...).doit().await
let r = hub.projects().locations_runtimes_start(...).doit().await
let r = hub.projects().locations_runtimes_stop(...).doit().await
let r = hub.projects().locations_runtimes_switch(...).doit().await
let r = hub.projects().locations_runtimes_upgrade(...).doit().await
let r = hub.projects().locations_schedules_create(...).doit().await
let r = hub.projects().locations_schedules_delete(...).doit().await
let r = hub.projects().locations_schedules_trigger(...).doit().await

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

使用方法

设置您的项目

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

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

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_notebooks1 as notebooks1;
use notebooks1::api::Runtime;
use notebooks1::{Result, Error};
use std::default::Default;
use notebooks1::{AIPlatformNotebooks, 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 = AIPlatformNotebooks::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 = Runtime::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_runtimes_create(req, "parent")
             .runtime_id("magna")
             .request_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 Delegate或Authenticator Delegate。

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

上传和下载

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

支持上传的方法可以使用最多两种不同的协议进行上传：简单和可恢复。每种的独特性都通过定制的doit(...)方法表示，这些方法分别命名为upload(...)和upload_resumable(...)。

自定义和回调

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

默认实现了委托trait，允许您以最小的努力进行自定义。

服务器请求中的可选部分

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

构建器参数

通过使用方法构建器，您可以重复调用其方法来准备一个动作调用。这些方法总是接受单个参数，以下陈述适用于该参数。

POD通过复制传递
字符串作为&str传递
请求值是移动的

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

Cargo功能

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

许可证

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

依赖项

约12-23MB
~343K SLoC