The google-notebooks1 library allows access to all features of the Google AI Platform Notebooks service.

This documentation was generated from AI Platform Notebooks crate version 6.0.0+20240613, where 20240613 is the exact revision of the notebooks:v1 schema built by the mako code generator v6.0.0.

Everything else about the AI Platform Notebooks v1 API can be found at the official documentation site.

Features

Handle the following Resources with ease from the central hub ...

• projects

• locations environments create, locations environments delete, locations environments get, locations environments list, locations executions create, locations executions delete, locations executions get, locations executions list, locations get, locations instances create, locations instances delete, locations instances diagnose, locations instances get, locations instances get iam policy, locations instances get instance health, locations instances is upgradeable, locations instances list, locations instances migrate, locations instances register, locations instances report, locations instances report event, locations instances reset, locations instances rollback, locations instances set accelerator, locations instances set iam policy, locations instances set labels, locations instances set machine type, locations instances start, locations instances stop, locations instances test iam permissions, locations instances update config, locations instances update metadata items, locations instances update shielded instance config, locations instances upgrade, locations instances upgrade internal, locations list, locations operations cancel, locations operations delete, locations operations get, locations operations list, locations runtimes create, locations runtimes delete, locations runtimes diagnose, locations runtimes get, locations runtimes get iam policy, locations runtimes list, locations runtimes migrate, locations runtimes patch, locations runtimes refresh runtime token internal, locations runtimes report event, locations runtimes reset, locations runtimes set iam policy, locations runtimes start, locations runtimes stop, locations runtimes switch, locations runtimes test iam permissions, locations runtimes upgrade, locations schedules create, locations schedules delete, locations schedules get, locations schedules list and locations schedules trigger

Structure of this Library

The API is structured into the following primary items:

• Hub
  • a central object to maintain state and allow accessing all Activities
  • creates Method Builders which in turn allow access to individual Call Builders
• Resources
  • primary types that you can apply Activities to
  • a collection of properties and Parts
  • Parts
    • a collection of properties
    • never directly used in Activities
• Activities
  • operations to apply to Resources

All structures are marked with applicable traits to further categorize them and ease browsing.

Generally speaking, you can invoke Activities like this:

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

Or specifically ...

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

The resource() and activity(...) calls create builders. The second one dealing with Activities supports various methods to configure the impending operation (not shown here). It is made such that all required arguments have to be specified right away (i.e. (...)), whereas all optional ones can be build up as desired. The doit() method performs the actual communication with the server and returns the respective result.

Usage

Setting up your Project

To use this library, you would put the following lines into your Cargo.toml file:

[dependencies]
google-notebooks1 = "*"
serde = "1"
serde_json = "1"

A complete example

extern crate hyper;
extern crate hyper_rustls;
extern crate google_notebooks1 as notebooks1;
use notebooks1::api::Runtime;
use notebooks1::{Result, Error};
use notebooks1::{AIPlatformNotebooks, FieldMask, hyper_rustls, hyper_util, yup_oauth2};

// Get an ApplicationSecret instance by some means. It contains the `client_id` and
// `client_secret`, among other things.
let secret: yup_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 = yup_oauth2::InstalledFlowAuthenticator::builder(
    secret,
    yup_oauth2::InstalledFlowReturnMethod::HTTPRedirect,
).build().await.unwrap();

let client = hyper_util::client::legacy::Client::builder(
    hyper_util::rt::TokioExecutor::new()
)
.build(
    hyper_rustls::HttpsConnectorBuilder::new()
        .with_native_roots()
        .unwrap()
        .https_or_http()
        .enable_http1()
        .build()
);
let mut hub = AIPlatformNotebooks::new(client, 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),
}

Handling Errors

All errors produced by the system are provided either as Result enumeration as return value of the doit() methods, or handed as possibly intermediate results to either the Hub Delegate, or the Authenticator Delegate.

When delegates handle errors or intermediate values, they may have a chance to instruct the system to retry. This makes the system potentially resilient to all kinds of errors.

Uploads and Downloads

If a method supports downloads, the response body, which is part of the Result, should be read by you to obtain the media. If such a method also supports a Response Result, it will return that by default. You can see it as meta-data for the actual media. To trigger a media download, you will have to set up the builder by making this call: .param("alt", "media").

Methods supporting uploads can do so using up to 2 different protocols: simple and resumable. The distinctiveness of each is represented by customized doit(...) methods, which are then named upload(...) and upload_resumable(...) respectively.

Customization and Callbacks

You may alter the way an doit() method is called by providing a delegate to the Method Builder before making the final doit() call. Respective methods will be called to provide progress information, as well as determine whether the system should retry on failure.

The delegate trait is default-implemented, allowing you to customize it with minimal effort.

Optional Parts in Server-Requests

All structures provided by this library are made to be encodable and decodable via json. Optionals are used to indicate that partial requests are responses are valid. Most optionals are are considered Parts which are identifiable by name, which will be sent to the server to indicate either the set parts of the request or the desired parts in the response.

Builder Arguments

Using method builders, you are able to prepare an action call by repeatedly calling it's methods. These will always take a single argument, for which the following statements are true.

• PODs are handed by copy
• strings are passed as &str
• request values are moved

Arguments will always be copied or cloned into the builder, to make them independent of their original life times.

Cargo Features

• utoipa - Add support for utoipa and derive utoipa::ToSchema on all the types. You'll have to import and register the required types in #[openapi(schemas(...))], otherwise the generated openapi spec would be invalid.

License

The notebooks1 library was generated by Sebastian Thiel, and is placed under the MIT license. You can read the full text at the repository's license file.