The `google-baremetalsolution2` library allows access to all features of the *Google baremetalsolution* service. This documentation was generated from *baremetalsolution* crate version *6.0.0+20240617*, where *20240617* is the exact revision of the *baremetalsolution:v2* schema built by the [mako](http://www.makotemplates.org/) code generator *v6.0.0*. Everything else about the *baremetalsolution* *v2* API can be found at the [official documentation site](https://cloud.google.com/bare-metal). # Features Handle the following *Resources* with ease from the central [hub](https://docs.rs/google-baremetalsolution2/6.0.0+20240617/google_baremetalsolution2/Baremetalsolution) ... * projects * [*locations get*](https://docs.rs/google-baremetalsolution2/6.0.0+20240617/google_baremetalsolution2/api::ProjectLocationGetCall), [*locations instances detach lun*](https://docs.rs/google-baremetalsolution2/6.0.0+20240617/google_baremetalsolution2/api::ProjectLocationInstanceDetachLunCall), [*locations instances disable hyperthreading*](https://docs.rs/google-baremetalsolution2/6.0.0+20240617/google_baremetalsolution2/api::ProjectLocationInstanceDisableHyperthreadingCall), [*locations instances disable interactive serial console*](https://docs.rs/google-baremetalsolution2/6.0.0+20240617/google_baremetalsolution2/api::ProjectLocationInstanceDisableInteractiveSerialConsoleCall), [*locations instances enable hyperthreading*](https://docs.rs/google-baremetalsolution2/6.0.0+20240617/google_baremetalsolution2/api::ProjectLocationInstanceEnableHyperthreadingCall), [*locations instances enable interactive serial console*](https://docs.rs/google-baremetalsolution2/6.0.0+20240617/google_baremetalsolution2/api::ProjectLocationInstanceEnableInteractiveSerialConsoleCall), [*locations instances get*](https://docs.rs/google-baremetalsolution2/6.0.0+20240617/google_baremetalsolution2/api::ProjectLocationInstanceGetCall), [*locations instances list*](https://docs.rs/google-baremetalsolution2/6.0.0+20240617/google_baremetalsolution2/api::ProjectLocationInstanceListCall), [*locations instances load auth info*](https://docs.rs/google-baremetalsolution2/6.0.0+20240617/google_baremetalsolution2/api::ProjectLocationInstanceLoadAuthInfoCall), [*locations instances patch*](https://docs.rs/google-baremetalsolution2/6.0.0+20240617/google_baremetalsolution2/api::ProjectLocationInstancePatchCall), [*locations instances reimage*](https://docs.rs/google-baremetalsolution2/6.0.0+20240617/google_baremetalsolution2/api::ProjectLocationInstanceReimageCall), [*locations instances rename*](https://docs.rs/google-baremetalsolution2/6.0.0+20240617/google_baremetalsolution2/api::ProjectLocationInstanceRenameCall), [*locations instances reset*](https://docs.rs/google-baremetalsolution2/6.0.0+20240617/google_baremetalsolution2/api::ProjectLocationInstanceResetCall), [*locations instances start*](https://docs.rs/google-baremetalsolution2/6.0.0+20240617/google_baremetalsolution2/api::ProjectLocationInstanceStartCall), [*locations instances stop*](https://docs.rs/google-baremetalsolution2/6.0.0+20240617/google_baremetalsolution2/api::ProjectLocationInstanceStopCall), [*locations list*](https://docs.rs/google-baremetalsolution2/6.0.0+20240617/google_baremetalsolution2/api::ProjectLocationListCall), [*locations networks get*](https://docs.rs/google-baremetalsolution2/6.0.0+20240617/google_baremetalsolution2/api::ProjectLocationNetworkGetCall), [*locations networks list*](https://docs.rs/google-baremetalsolution2/6.0.0+20240617/google_baremetalsolution2/api::ProjectLocationNetworkListCall), [*locations networks list network usage*](https://docs.rs/google-baremetalsolution2/6.0.0+20240617/google_baremetalsolution2/api::ProjectLocationNetworkListNetworkUsageCall), [*locations networks patch*](https://docs.rs/google-baremetalsolution2/6.0.0+20240617/google_baremetalsolution2/api::ProjectLocationNetworkPatchCall), [*locations networks rename*](https://docs.rs/google-baremetalsolution2/6.0.0+20240617/google_baremetalsolution2/api::ProjectLocationNetworkRenameCall), [*locations nfs shares create*](https://docs.rs/google-baremetalsolution2/6.0.0+20240617/google_baremetalsolution2/api::ProjectLocationNfsShareCreateCall), [*locations nfs shares delete*](https://docs.rs/google-baremetalsolution2/6.0.0+20240617/google_baremetalsolution2/api::ProjectLocationNfsShareDeleteCall), [*locations nfs shares get*](https://docs.rs/google-baremetalsolution2/6.0.0+20240617/google_baremetalsolution2/api::ProjectLocationNfsShareGetCall), [*locations nfs shares list*](https://docs.rs/google-baremetalsolution2/6.0.0+20240617/google_baremetalsolution2/api::ProjectLocationNfsShareListCall), [*locations nfs shares patch*](https://docs.rs/google-baremetalsolution2/6.0.0+20240617/google_baremetalsolution2/api::ProjectLocationNfsSharePatchCall), [*locations nfs shares rename*](https://docs.rs/google-baremetalsolution2/6.0.0+20240617/google_baremetalsolution2/api::ProjectLocationNfsShareRenameCall), [*locations operations get*](https://docs.rs/google-baremetalsolution2/6.0.0+20240617/google_baremetalsolution2/api::ProjectLocationOperationGetCall), [*locations os images get*](https://docs.rs/google-baremetalsolution2/6.0.0+20240617/google_baremetalsolution2/api::ProjectLocationOsImageGetCall), [*locations os images list*](https://docs.rs/google-baremetalsolution2/6.0.0+20240617/google_baremetalsolution2/api::ProjectLocationOsImageListCall), [*locations provisioning configs create*](https://docs.rs/google-baremetalsolution2/6.0.0+20240617/google_baremetalsolution2/api::ProjectLocationProvisioningConfigCreateCall), [*locations provisioning configs get*](https://docs.rs/google-baremetalsolution2/6.0.0+20240617/google_baremetalsolution2/api::ProjectLocationProvisioningConfigGetCall), [*locations provisioning configs patch*](https://docs.rs/google-baremetalsolution2/6.0.0+20240617/google_baremetalsolution2/api::ProjectLocationProvisioningConfigPatchCall), [*locations provisioning configs submit*](https://docs.rs/google-baremetalsolution2/6.0.0+20240617/google_baremetalsolution2/api::ProjectLocationProvisioningConfigSubmitCall), [*locations provisioning quotas list*](https://docs.rs/google-baremetalsolution2/6.0.0+20240617/google_baremetalsolution2/api::ProjectLocationProvisioningQuotaListCall), [*locations ssh keys create*](https://docs.rs/google-baremetalsolution2/6.0.0+20240617/google_baremetalsolution2/api::ProjectLocationSshKeyCreateCall), [*locations ssh keys delete*](https://docs.rs/google-baremetalsolution2/6.0.0+20240617/google_baremetalsolution2/api::ProjectLocationSshKeyDeleteCall), [*locations ssh keys list*](https://docs.rs/google-baremetalsolution2/6.0.0+20240617/google_baremetalsolution2/api::ProjectLocationSshKeyListCall), [*locations volumes evict*](https://docs.rs/google-baremetalsolution2/6.0.0+20240617/google_baremetalsolution2/api::ProjectLocationVolumeEvictCall), [*locations volumes get*](https://docs.rs/google-baremetalsolution2/6.0.0+20240617/google_baremetalsolution2/api::ProjectLocationVolumeGetCall), [*locations volumes list*](https://docs.rs/google-baremetalsolution2/6.0.0+20240617/google_baremetalsolution2/api::ProjectLocationVolumeListCall), [*locations volumes luns evict*](https://docs.rs/google-baremetalsolution2/6.0.0+20240617/google_baremetalsolution2/api::ProjectLocationVolumeLunEvictCall), [*locations volumes luns get*](https://docs.rs/google-baremetalsolution2/6.0.0+20240617/google_baremetalsolution2/api::ProjectLocationVolumeLunGetCall), [*locations volumes luns list*](https://docs.rs/google-baremetalsolution2/6.0.0+20240617/google_baremetalsolution2/api::ProjectLocationVolumeLunListCall), [*locations volumes patch*](https://docs.rs/google-baremetalsolution2/6.0.0+20240617/google_baremetalsolution2/api::ProjectLocationVolumePatchCall), [*locations volumes rename*](https://docs.rs/google-baremetalsolution2/6.0.0+20240617/google_baremetalsolution2/api::ProjectLocationVolumeRenameCall), [*locations volumes resize*](https://docs.rs/google-baremetalsolution2/6.0.0+20240617/google_baremetalsolution2/api::ProjectLocationVolumeResizeCall), [*locations volumes snapshots create*](https://docs.rs/google-baremetalsolution2/6.0.0+20240617/google_baremetalsolution2/api::ProjectLocationVolumeSnapshotCreateCall), [*locations volumes snapshots delete*](https://docs.rs/google-baremetalsolution2/6.0.0+20240617/google_baremetalsolution2/api::ProjectLocationVolumeSnapshotDeleteCall), [*locations volumes snapshots get*](https://docs.rs/google-baremetalsolution2/6.0.0+20240617/google_baremetalsolution2/api::ProjectLocationVolumeSnapshotGetCall), [*locations volumes snapshots list*](https://docs.rs/google-baremetalsolution2/6.0.0+20240617/google_baremetalsolution2/api::ProjectLocationVolumeSnapshotListCall) and [*locations volumes snapshots restore volume snapshot*](https://docs.rs/google-baremetalsolution2/6.0.0+20240617/google_baremetalsolution2/api::ProjectLocationVolumeSnapshotRestoreVolumeSnapshotCall) # Structure of this Library The API is structured into the following primary items: * **[Hub](https://docs.rs/google-baremetalsolution2/6.0.0+20240617/google_baremetalsolution2/Baremetalsolution)** * a central object to maintain state and allow accessing all *Activities* * creates [*Method Builders*](https://docs.rs/google-baremetalsolution2/6.0.0+20240617/google_baremetalsolution2/common::MethodsBuilder) which in turn allow access to individual [*Call Builders*](https://docs.rs/google-baremetalsolution2/6.0.0+20240617/google_baremetalsolution2/common::CallBuilder) * **[Resources](https://docs.rs/google-baremetalsolution2/6.0.0+20240617/google_baremetalsolution2/common::Resource)** * primary types that you can apply *Activities* to * a collection of properties and *Parts* * **[Parts](https://docs.rs/google-baremetalsolution2/6.0.0+20240617/google_baremetalsolution2/common::Part)** * a collection of properties * never directly used in *Activities* * **[Activities](https://docs.rs/google-baremetalsolution2/6.0.0+20240617/google_baremetalsolution2/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_instances_detach_lun(...).doit().await let r = hub.projects().locations_instances_disable_hyperthreading(...).doit().await let r = hub.projects().locations_instances_disable_interactive_serial_console(...).doit().await let r = hub.projects().locations_instances_enable_hyperthreading(...).doit().await let r = hub.projects().locations_instances_enable_interactive_serial_console(...).doit().await let r = hub.projects().locations_instances_patch(...).doit().await let r = hub.projects().locations_instances_reimage(...).doit().await let r = hub.projects().locations_instances_reset(...).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_networks_patch(...).doit().await let r = hub.projects().locations_nfs_shares_create(...).doit().await let r = hub.projects().locations_nfs_shares_delete(...).doit().await let r = hub.projects().locations_nfs_shares_patch(...).doit().await let r = hub.projects().locations_operations_get(...).doit().await let r = hub.projects().locations_volumes_luns_evict(...).doit().await let r = hub.projects().locations_volumes_snapshots_restore_volume_snapshot(...).doit().await let r = hub.projects().locations_volumes_evict(...).doit().await let r = hub.projects().locations_volumes_patch(...).doit().await let r = hub.projects().locations_volumes_resize(...).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-baremetalsolution2 = "*" serde = "1" serde_json = "1" ``` ## A complete example ```Rust extern crate hyper; extern crate hyper_rustls; extern crate google_baremetalsolution2 as baremetalsolution2; use baremetalsolution2::api::Instance; use baremetalsolution2::{Result, Error}; use baremetalsolution2::{Baremetalsolution, 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 = Baremetalsolution::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 = Instance::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_instances_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-baremetalsolution2/6.0.0+20240617/google_baremetalsolution2/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-baremetalsolution2/6.0.0+20240617/google_baremetalsolution2/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-baremetalsolution2/6.0.0+20240617/google_baremetalsolution2/common::Result), should be read by you to obtain the media. If such a method also supports a [Response Result](https://docs.rs/google-baremetalsolution2/6.0.0+20240617/google_baremetalsolution2/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-baremetalsolution2/6.0.0+20240617/google_baremetalsolution2/common::Delegate) to the [Method Builder](https://docs.rs/google-baremetalsolution2/6.0.0+20240617/google_baremetalsolution2/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-baremetalsolution2/6.0.0+20240617/google_baremetalsolution2/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-baremetalsolution2/6.0.0+20240617/google_baremetalsolution2/common::RequestValue) and [decodable](https://docs.rs/google-baremetalsolution2/6.0.0+20240617/google_baremetalsolution2/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-baremetalsolution2/6.0.0+20240617/google_baremetalsolution2/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-baremetalsolution2/6.0.0+20240617/google_baremetalsolution2/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-baremetalsolution2/6.0.0+20240617/google_baremetalsolution2/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 **baremetalsolution2** 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