The `google-ml1` library allows access to all features of the *Google Cloud Machine Learning Engine* service. This documentation was generated from *Cloud Machine Learning Engine* crate version *6.0.0+20240607*, where *20240607* is the exact revision of the *ml:v1* schema built by the [mako](http://www.makotemplates.org/) code generator *v6.0.0*. Everything else about the *Cloud Machine Learning Engine* *v1* API can be found at the [official documentation site](https://cloud.google.com/ml/). # Features Handle the following *Resources* with ease from the central [hub](https://docs.rs/google-ml1/6.0.0+20240607/google_ml1/CloudMachineLearningEngine) ... * projects * [*explain*](https://docs.rs/google-ml1/6.0.0+20240607/google_ml1/api::ProjectExplainCall), [*get config*](https://docs.rs/google-ml1/6.0.0+20240607/google_ml1/api::ProjectGetConfigCall), [*jobs cancel*](https://docs.rs/google-ml1/6.0.0+20240607/google_ml1/api::ProjectJobCancelCall), [*jobs create*](https://docs.rs/google-ml1/6.0.0+20240607/google_ml1/api::ProjectJobCreateCall), [*jobs get*](https://docs.rs/google-ml1/6.0.0+20240607/google_ml1/api::ProjectJobGetCall), [*jobs get iam policy*](https://docs.rs/google-ml1/6.0.0+20240607/google_ml1/api::ProjectJobGetIamPolicyCall), [*jobs list*](https://docs.rs/google-ml1/6.0.0+20240607/google_ml1/api::ProjectJobListCall), [*jobs patch*](https://docs.rs/google-ml1/6.0.0+20240607/google_ml1/api::ProjectJobPatchCall), [*jobs set iam policy*](https://docs.rs/google-ml1/6.0.0+20240607/google_ml1/api::ProjectJobSetIamPolicyCall), [*jobs test iam permissions*](https://docs.rs/google-ml1/6.0.0+20240607/google_ml1/api::ProjectJobTestIamPermissionCall), [*locations get*](https://docs.rs/google-ml1/6.0.0+20240607/google_ml1/api::ProjectLocationGetCall), [*locations list*](https://docs.rs/google-ml1/6.0.0+20240607/google_ml1/api::ProjectLocationListCall), [*locations operations cancel*](https://docs.rs/google-ml1/6.0.0+20240607/google_ml1/api::ProjectLocationOperationCancelCall), [*locations operations get*](https://docs.rs/google-ml1/6.0.0+20240607/google_ml1/api::ProjectLocationOperationGetCall), [*locations studies create*](https://docs.rs/google-ml1/6.0.0+20240607/google_ml1/api::ProjectLocationStudyCreateCall), [*locations studies delete*](https://docs.rs/google-ml1/6.0.0+20240607/google_ml1/api::ProjectLocationStudyDeleteCall), [*locations studies get*](https://docs.rs/google-ml1/6.0.0+20240607/google_ml1/api::ProjectLocationStudyGetCall), [*locations studies list*](https://docs.rs/google-ml1/6.0.0+20240607/google_ml1/api::ProjectLocationStudyListCall), [*locations studies trials add measurement*](https://docs.rs/google-ml1/6.0.0+20240607/google_ml1/api::ProjectLocationStudyTrialAddMeasurementCall), [*locations studies trials check early stopping state*](https://docs.rs/google-ml1/6.0.0+20240607/google_ml1/api::ProjectLocationStudyTrialCheckEarlyStoppingStateCall), [*locations studies trials complete*](https://docs.rs/google-ml1/6.0.0+20240607/google_ml1/api::ProjectLocationStudyTrialCompleteCall), [*locations studies trials create*](https://docs.rs/google-ml1/6.0.0+20240607/google_ml1/api::ProjectLocationStudyTrialCreateCall), [*locations studies trials delete*](https://docs.rs/google-ml1/6.0.0+20240607/google_ml1/api::ProjectLocationStudyTrialDeleteCall), [*locations studies trials get*](https://docs.rs/google-ml1/6.0.0+20240607/google_ml1/api::ProjectLocationStudyTrialGetCall), [*locations studies trials list*](https://docs.rs/google-ml1/6.0.0+20240607/google_ml1/api::ProjectLocationStudyTrialListCall), [*locations studies trials list optimal trials*](https://docs.rs/google-ml1/6.0.0+20240607/google_ml1/api::ProjectLocationStudyTrialListOptimalTrialCall), [*locations studies trials stop*](https://docs.rs/google-ml1/6.0.0+20240607/google_ml1/api::ProjectLocationStudyTrialStopCall), [*locations studies trials suggest*](https://docs.rs/google-ml1/6.0.0+20240607/google_ml1/api::ProjectLocationStudyTrialSuggestCall), [*models create*](https://docs.rs/google-ml1/6.0.0+20240607/google_ml1/api::ProjectModelCreateCall), [*models delete*](https://docs.rs/google-ml1/6.0.0+20240607/google_ml1/api::ProjectModelDeleteCall), [*models get*](https://docs.rs/google-ml1/6.0.0+20240607/google_ml1/api::ProjectModelGetCall), [*models get iam policy*](https://docs.rs/google-ml1/6.0.0+20240607/google_ml1/api::ProjectModelGetIamPolicyCall), [*models list*](https://docs.rs/google-ml1/6.0.0+20240607/google_ml1/api::ProjectModelListCall), [*models patch*](https://docs.rs/google-ml1/6.0.0+20240607/google_ml1/api::ProjectModelPatchCall), [*models set iam policy*](https://docs.rs/google-ml1/6.0.0+20240607/google_ml1/api::ProjectModelSetIamPolicyCall), [*models test iam permissions*](https://docs.rs/google-ml1/6.0.0+20240607/google_ml1/api::ProjectModelTestIamPermissionCall), [*models versions create*](https://docs.rs/google-ml1/6.0.0+20240607/google_ml1/api::ProjectModelVersionCreateCall), [*models versions delete*](https://docs.rs/google-ml1/6.0.0+20240607/google_ml1/api::ProjectModelVersionDeleteCall), [*models versions get*](https://docs.rs/google-ml1/6.0.0+20240607/google_ml1/api::ProjectModelVersionGetCall), [*models versions list*](https://docs.rs/google-ml1/6.0.0+20240607/google_ml1/api::ProjectModelVersionListCall), [*models versions patch*](https://docs.rs/google-ml1/6.0.0+20240607/google_ml1/api::ProjectModelVersionPatchCall), [*models versions set default*](https://docs.rs/google-ml1/6.0.0+20240607/google_ml1/api::ProjectModelVersionSetDefaultCall), [*operations cancel*](https://docs.rs/google-ml1/6.0.0+20240607/google_ml1/api::ProjectOperationCancelCall), [*operations get*](https://docs.rs/google-ml1/6.0.0+20240607/google_ml1/api::ProjectOperationGetCall), [*operations list*](https://docs.rs/google-ml1/6.0.0+20240607/google_ml1/api::ProjectOperationListCall) and [*predict*](https://docs.rs/google-ml1/6.0.0+20240607/google_ml1/api::ProjectPredictCall) # Structure of this Library The API is structured into the following primary items: * **[Hub](https://docs.rs/google-ml1/6.0.0+20240607/google_ml1/CloudMachineLearningEngine)** * a central object to maintain state and allow accessing all *Activities* * creates [*Method Builders*](https://docs.rs/google-ml1/6.0.0+20240607/google_ml1/common::MethodsBuilder) which in turn allow access to individual [*Call Builders*](https://docs.rs/google-ml1/6.0.0+20240607/google_ml1/common::CallBuilder) * **[Resources](https://docs.rs/google-ml1/6.0.0+20240607/google_ml1/common::Resource)** * primary types that you can apply *Activities* to * a collection of properties and *Parts* * **[Parts](https://docs.rs/google-ml1/6.0.0+20240607/google_ml1/common::Part)** * a collection of properties * never directly used in *Activities* * **[Activities](https://docs.rs/google-ml1/6.0.0+20240607/google_ml1/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_operations_get(...).doit().await let r = hub.projects().locations_studies_trials_check_early_stopping_state(...).doit().await let r = hub.projects().locations_studies_trials_suggest(...).doit().await let r = hub.projects().models_versions_create(...).doit().await let r = hub.projects().models_versions_delete(...).doit().await let r = hub.projects().models_versions_patch(...).doit().await let r = hub.projects().models_delete(...).doit().await let r = hub.projects().models_patch(...).doit().await let r = hub.projects().operations_get(...).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-ml1 = "*" serde = "1" serde_json = "1" ``` ## A complete example ```Rust extern crate hyper; extern crate hyper_rustls; extern crate google_ml1 as ml1; use ml1::api::GoogleCloudMlV1__Version; use ml1::{Result, Error}; use ml1::{CloudMachineLearningEngine, 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 = CloudMachineLearningEngine::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 = GoogleCloudMlV1__Version::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().models_versions_patch(req, "name") .update_mask(FieldMask::new::<&str>(&[])) .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-ml1/6.0.0+20240607/google_ml1/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-ml1/6.0.0+20240607/google_ml1/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-ml1/6.0.0+20240607/google_ml1/common::Result), should be read by you to obtain the media. If such a method also supports a [Response Result](https://docs.rs/google-ml1/6.0.0+20240607/google_ml1/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-ml1/6.0.0+20240607/google_ml1/common::Delegate) to the [Method Builder](https://docs.rs/google-ml1/6.0.0+20240607/google_ml1/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-ml1/6.0.0+20240607/google_ml1/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-ml1/6.0.0+20240607/google_ml1/common::RequestValue) and [decodable](https://docs.rs/google-ml1/6.0.0+20240607/google_ml1/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-ml1/6.0.0+20240607/google_ml1/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-ml1/6.0.0+20240607/google_ml1/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-ml1/6.0.0+20240607/google_ml1/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 **ml1** 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