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](http://www.makotemplates.org/) code generator *v6.0.0*. Everything else about the *AI Platform Notebooks* *v1* API can be found at the [official documentation site](https://cloud.google.com/notebooks/docs/). # Features Handle the following *Resources* with ease from the central [hub](https://docs.rs/google-notebooks1/6.0.0+20240613/google_notebooks1/AIPlatformNotebooks) ... * projects * [*locations environments create*](https://docs.rs/google-notebooks1/6.0.0+20240613/google_notebooks1/api::ProjectLocationEnvironmentCreateCall), [*locations environments delete*](https://docs.rs/google-notebooks1/6.0.0+20240613/google_notebooks1/api::ProjectLocationEnvironmentDeleteCall), [*locations environments get*](https://docs.rs/google-notebooks1/6.0.0+20240613/google_notebooks1/api::ProjectLocationEnvironmentGetCall), [*locations environments list*](https://docs.rs/google-notebooks1/6.0.0+20240613/google_notebooks1/api::ProjectLocationEnvironmentListCall), [*locations executions create*](https://docs.rs/google-notebooks1/6.0.0+20240613/google_notebooks1/api::ProjectLocationExecutionCreateCall), [*locations executions delete*](https://docs.rs/google-notebooks1/6.0.0+20240613/google_notebooks1/api::ProjectLocationExecutionDeleteCall), [*locations executions get*](https://docs.rs/google-notebooks1/6.0.0+20240613/google_notebooks1/api::ProjectLocationExecutionGetCall), [*locations executions list*](https://docs.rs/google-notebooks1/6.0.0+20240613/google_notebooks1/api::ProjectLocationExecutionListCall), [*locations get*](https://docs.rs/google-notebooks1/6.0.0+20240613/google_notebooks1/api::ProjectLocationGetCall), [*locations instances create*](https://docs.rs/google-notebooks1/6.0.0+20240613/google_notebooks1/api::ProjectLocationInstanceCreateCall), [*locations instances delete*](https://docs.rs/google-notebooks1/6.0.0+20240613/google_notebooks1/api::ProjectLocationInstanceDeleteCall), [*locations instances diagnose*](https://docs.rs/google-notebooks1/6.0.0+20240613/google_notebooks1/api::ProjectLocationInstanceDiagnoseCall), [*locations instances get*](https://docs.rs/google-notebooks1/6.0.0+20240613/google_notebooks1/api::ProjectLocationInstanceGetCall), [*locations instances get iam policy*](https://docs.rs/google-notebooks1/6.0.0+20240613/google_notebooks1/api::ProjectLocationInstanceGetIamPolicyCall), [*locations instances get instance health*](https://docs.rs/google-notebooks1/6.0.0+20240613/google_notebooks1/api::ProjectLocationInstanceGetInstanceHealthCall), [*locations instances is upgradeable*](https://docs.rs/google-notebooks1/6.0.0+20240613/google_notebooks1/api::ProjectLocationInstanceIsUpgradeableCall), [*locations instances list*](https://docs.rs/google-notebooks1/6.0.0+20240613/google_notebooks1/api::ProjectLocationInstanceListCall), [*locations instances migrate*](https://docs.rs/google-notebooks1/6.0.0+20240613/google_notebooks1/api::ProjectLocationInstanceMigrateCall), [*locations instances register*](https://docs.rs/google-notebooks1/6.0.0+20240613/google_notebooks1/api::ProjectLocationInstanceRegisterCall), [*locations instances report*](https://docs.rs/google-notebooks1/6.0.0+20240613/google_notebooks1/api::ProjectLocationInstanceReportCall), [*locations instances report event*](https://docs.rs/google-notebooks1/6.0.0+20240613/google_notebooks1/api::ProjectLocationInstanceReportEventCall), [*locations instances reset*](https://docs.rs/google-notebooks1/6.0.0+20240613/google_notebooks1/api::ProjectLocationInstanceResetCall), [*locations instances rollback*](https://docs.rs/google-notebooks1/6.0.0+20240613/google_notebooks1/api::ProjectLocationInstanceRollbackCall), [*locations instances set accelerator*](https://docs.rs/google-notebooks1/6.0.0+20240613/google_notebooks1/api::ProjectLocationInstanceSetAcceleratorCall), [*locations instances set iam policy*](https://docs.rs/google-notebooks1/6.0.0+20240613/google_notebooks1/api::ProjectLocationInstanceSetIamPolicyCall), [*locations instances set labels*](https://docs.rs/google-notebooks1/6.0.0+20240613/google_notebooks1/api::ProjectLocationInstanceSetLabelCall), [*locations instances set machine type*](https://docs.rs/google-notebooks1/6.0.0+20240613/google_notebooks1/api::ProjectLocationInstanceSetMachineTypeCall), [*locations instances start*](https://docs.rs/google-notebooks1/6.0.0+20240613/google_notebooks1/api::ProjectLocationInstanceStartCall), [*locations instances stop*](https://docs.rs/google-notebooks1/6.0.0+20240613/google_notebooks1/api::ProjectLocationInstanceStopCall), [*locations instances test iam permissions*](https://docs.rs/google-notebooks1/6.0.0+20240613/google_notebooks1/api::ProjectLocationInstanceTestIamPermissionCall), [*locations instances update config*](https://docs.rs/google-notebooks1/6.0.0+20240613/google_notebooks1/api::ProjectLocationInstanceUpdateConfigCall), [*locations instances update metadata items*](https://docs.rs/google-notebooks1/6.0.0+20240613/google_notebooks1/api::ProjectLocationInstanceUpdateMetadataItemCall), [*locations instances update shielded instance config*](https://docs.rs/google-notebooks1/6.0.0+20240613/google_notebooks1/api::ProjectLocationInstanceUpdateShieldedInstanceConfigCall), [*locations instances upgrade*](https://docs.rs/google-notebooks1/6.0.0+20240613/google_notebooks1/api::ProjectLocationInstanceUpgradeCall), [*locations instances upgrade internal*](https://docs.rs/google-notebooks1/6.0.0+20240613/google_notebooks1/api::ProjectLocationInstanceUpgradeInternalCall), [*locations list*](https://docs.rs/google-notebooks1/6.0.0+20240613/google_notebooks1/api::ProjectLocationListCall), [*locations operations cancel*](https://docs.rs/google-notebooks1/6.0.0+20240613/google_notebooks1/api::ProjectLocationOperationCancelCall), [*locations operations delete*](https://docs.rs/google-notebooks1/6.0.0+20240613/google_notebooks1/api::ProjectLocationOperationDeleteCall), [*locations operations get*](https://docs.rs/google-notebooks1/6.0.0+20240613/google_notebooks1/api::ProjectLocationOperationGetCall), [*locations operations list*](https://docs.rs/google-notebooks1/6.0.0+20240613/google_notebooks1/api::ProjectLocationOperationListCall), [*locations runtimes create*](https://docs.rs/google-notebooks1/6.0.0+20240613/google_notebooks1/api::ProjectLocationRuntimeCreateCall), [*locations runtimes delete*](https://docs.rs/google-notebooks1/6.0.0+20240613/google_notebooks1/api::ProjectLocationRuntimeDeleteCall), [*locations runtimes diagnose*](https://docs.rs/google-notebooks1/6.0.0+20240613/google_notebooks1/api::ProjectLocationRuntimeDiagnoseCall), [*locations runtimes get*](https://docs.rs/google-notebooks1/6.0.0+20240613/google_notebooks1/api::ProjectLocationRuntimeGetCall), [*locations runtimes get iam policy*](https://docs.rs/google-notebooks1/6.0.0+20240613/google_notebooks1/api::ProjectLocationRuntimeGetIamPolicyCall), [*locations runtimes list*](https://docs.rs/google-notebooks1/6.0.0+20240613/google_notebooks1/api::ProjectLocationRuntimeListCall), [*locations runtimes migrate*](https://docs.rs/google-notebooks1/6.0.0+20240613/google_notebooks1/api::ProjectLocationRuntimeMigrateCall), [*locations runtimes patch*](https://docs.rs/google-notebooks1/6.0.0+20240613/google_notebooks1/api::ProjectLocationRuntimePatchCall), [*locations runtimes refresh runtime token internal*](https://docs.rs/google-notebooks1/6.0.0+20240613/google_notebooks1/api::ProjectLocationRuntimeRefreshRuntimeTokenInternalCall), [*locations runtimes report event*](https://docs.rs/google-notebooks1/6.0.0+20240613/google_notebooks1/api::ProjectLocationRuntimeReportEventCall), [*locations runtimes reset*](https://docs.rs/google-notebooks1/6.0.0+20240613/google_notebooks1/api::ProjectLocationRuntimeResetCall), [*locations runtimes set iam policy*](https://docs.rs/google-notebooks1/6.0.0+20240613/google_notebooks1/api::ProjectLocationRuntimeSetIamPolicyCall), [*locations runtimes start*](https://docs.rs/google-notebooks1/6.0.0+20240613/google_notebooks1/api::ProjectLocationRuntimeStartCall), [*locations runtimes stop*](https://docs.rs/google-notebooks1/6.0.0+20240613/google_notebooks1/api::ProjectLocationRuntimeStopCall), [*locations runtimes switch*](https://docs.rs/google-notebooks1/6.0.0+20240613/google_notebooks1/api::ProjectLocationRuntimeSwitchCall), [*locations runtimes test iam permissions*](https://docs.rs/google-notebooks1/6.0.0+20240613/google_notebooks1/api::ProjectLocationRuntimeTestIamPermissionCall), [*locations runtimes upgrade*](https://docs.rs/google-notebooks1/6.0.0+20240613/google_notebooks1/api::ProjectLocationRuntimeUpgradeCall), [*locations schedules create*](https://docs.rs/google-notebooks1/6.0.0+20240613/google_notebooks1/api::ProjectLocationScheduleCreateCall), [*locations schedules delete*](https://docs.rs/google-notebooks1/6.0.0+20240613/google_notebooks1/api::ProjectLocationScheduleDeleteCall), [*locations schedules get*](https://docs.rs/google-notebooks1/6.0.0+20240613/google_notebooks1/api::ProjectLocationScheduleGetCall), [*locations schedules list*](https://docs.rs/google-notebooks1/6.0.0+20240613/google_notebooks1/api::ProjectLocationScheduleListCall) and [*locations schedules trigger*](https://docs.rs/google-notebooks1/6.0.0+20240613/google_notebooks1/api::ProjectLocationScheduleTriggerCall) # Structure of this Library The API is structured into the following primary items: * **[Hub](https://docs.rs/google-notebooks1/6.0.0+20240613/google_notebooks1/AIPlatformNotebooks)** * a central object to maintain state and allow accessing all *Activities* * creates [*Method Builders*](https://docs.rs/google-notebooks1/6.0.0+20240613/google_notebooks1/common::MethodsBuilder) which in turn allow access to individual [*Call Builders*](https://docs.rs/google-notebooks1/6.0.0+20240613/google_notebooks1/common::CallBuilder) * **[Resources](https://docs.rs/google-notebooks1/6.0.0+20240613/google_notebooks1/common::Resource)** * primary types that you can apply *Activities* to * a collection of properties and *Parts* * **[Parts](https://docs.rs/google-notebooks1/6.0.0+20240613/google_notebooks1/common::Part)** * a collection of properties * never directly used in *Activities* * **[Activities](https://docs.rs/google-notebooks1/6.0.0+20240613/google_notebooks1/common::CallBuilder)** * 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: ```Rust,ignore let r = hub.resource().activity(...).doit().await ``` Or specifically ... ```ignore 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][builder-pattern]. 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][builder-pattern] 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: ```toml [dependencies] google-notebooks1 = "*" serde = "1" serde_json = "1" ``` ## A complete example ```Rust 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](https://docs.rs/google-notebooks1/6.0.0+20240613/google_notebooks1/common::Result) enumeration as return value of the doit() methods, or handed as possibly intermediate results to either the [Hub Delegate](https://docs.rs/google-notebooks1/6.0.0+20240613/google_notebooks1/common::Delegate), or the [Authenticator Delegate](https://docs.rs/yup-oauth2/*/yup_oauth2/trait.AuthenticatorDelegate.html). 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](https://docs.rs/google-notebooks1/6.0.0+20240613/google_notebooks1/common::Result), should be read by you to obtain the media. If such a method also supports a [Response Result](https://docs.rs/google-notebooks1/6.0.0+20240613/google_notebooks1/common::ResponseResult), 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](https://docs.rs/google-notebooks1/6.0.0+20240613/google_notebooks1/common::Delegate) to the [Method Builder](https://docs.rs/google-notebooks1/6.0.0+20240613/google_notebooks1/common::CallBuilder) 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](https://docs.rs/google-notebooks1/6.0.0+20240613/google_notebooks1/common::Delegate) 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](https://docs.rs/google-notebooks1/6.0.0+20240613/google_notebooks1/common::RequestValue) and [decodable](https://docs.rs/google-notebooks1/6.0.0+20240613/google_notebooks1/common::ResponseResult) via *json*. Optionals are used to indicate that partial requests are responses are valid. Most optionals are are considered [Parts](https://docs.rs/google-notebooks1/6.0.0+20240613/google_notebooks1/common::Part) 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](https://docs.rs/google-notebooks1/6.0.0+20240613/google_notebooks1/common::CallBuilder), 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][wiki-pod] are handed by copy * strings are passed as `&str` * [request values](https://docs.rs/google-notebooks1/6.0.0+20240613/google_notebooks1/common::RequestValue) are moved Arguments will always be copied or cloned into the builder, to make them independent of their original life times. [wiki-pod]: http://en.wikipedia.org/wiki/Plain_old_data_structure [builder-pattern]: http://en.wikipedia.org/wiki/Builder_pattern [google-go-api]: https://github.com/google/google-api-go-client ## Cargo Features * `utoipa` - Add support for [utoipa](https://crates.io/crates/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][repo-license]. [repo-license]: https://github.com/Byron/google-apis-rsblob/main/LICENSE.md