google_cloudshell1/lib.rs
1// DO NOT EDIT !
2// This file was generated automatically from 'src/generator/templates/api/lib.rs.mako'
3// DO NOT EDIT !
4
5//! This documentation was generated from *Cloud Shell* crate version *6.0.0+20240624*, where *20240624* is the exact revision of the *cloudshell:v1* schema built by the [mako](http://www.makotemplates.org/) code generator *v6.0.0*.
6//!
7//! Everything else about the *Cloud Shell* *v1* API can be found at the
8//! [official documentation site](https://cloud.google.com/shell/docs/).
9//! The original source code is [on github](https://github.com/Byron/google-apis-rs/tree/main/gen/cloudshell1).
10//! # Features
11//!
12//! Handle the following *Resources* with ease from the central [hub](CloudShell) ...
13//!
14//! * [operations](api::Operation)
15//! * [*cancel*](api::OperationCancelCall), [*delete*](api::OperationDeleteCall), [*get*](api::OperationGetCall) and [*list*](api::OperationListCall)
16//! * users
17//! * [*environments add public key*](api::UserEnvironmentAddPublicKeyCall), [*environments authorize*](api::UserEnvironmentAuthorizeCall), [*environments get*](api::UserEnvironmentGetCall), [*environments remove public key*](api::UserEnvironmentRemovePublicKeyCall) and [*environments start*](api::UserEnvironmentStartCall)
18//!
19//!
20//!
21//!
22//! Not what you are looking for ? Find all other Google APIs in their Rust [documentation index](http://byron.github.io/google-apis-rs).
23//!
24//! # Structure of this Library
25//!
26//! The API is structured into the following primary items:
27//!
28//! * **[Hub](CloudShell)**
29//! * a central object to maintain state and allow accessing all *Activities*
30//! * creates [*Method Builders*](common::MethodsBuilder) which in turn
31//! allow access to individual [*Call Builders*](common::CallBuilder)
32//! * **[Resources](common::Resource)**
33//! * primary types that you can apply *Activities* to
34//! * a collection of properties and *Parts*
35//! * **[Parts](common::Part)**
36//! * a collection of properties
37//! * never directly used in *Activities*
38//! * **[Activities](common::CallBuilder)**
39//! * operations to apply to *Resources*
40//!
41//! All *structures* are marked with applicable traits to further categorize them and ease browsing.
42//!
43//! Generally speaking, you can invoke *Activities* like this:
44//!
45//! ```Rust,ignore
46//! let r = hub.resource().activity(...).doit().await
47//! ```
48//!
49//! Or specifically ...
50//!
51//! ```ignore
52//! let r = hub.operations().cancel(...).doit().await
53//! let r = hub.operations().delete(...).doit().await
54//! let r = hub.operations().get(...).doit().await
55//! let r = hub.operations().list(...).doit().await
56//! let r = hub.users().environments_add_public_key(...).doit().await
57//! let r = hub.users().environments_authorize(...).doit().await
58//! let r = hub.users().environments_remove_public_key(...).doit().await
59//! let r = hub.users().environments_start(...).doit().await
60//! ```
61//!
62//! The `resource()` and `activity(...)` calls create [builders][builder-pattern]. The second one dealing with `Activities`
63//! supports various methods to configure the impending operation (not shown here). It is made such that all required arguments have to be
64//! specified right away (i.e. `(...)`), whereas all optional ones can be [build up][builder-pattern] as desired.
65//! The `doit()` method performs the actual communication with the server and returns the respective result.
66//!
67//! # Usage
68//!
69//! ## Setting up your Project
70//!
71//! To use this library, you would put the following lines into your `Cargo.toml` file:
72//!
73//! ```toml
74//! [dependencies]
75//! google-cloudshell1 = "*"
76//! serde = "1"
77//! serde_json = "1"
78//! ```
79//!
80//! ## A complete example
81//!
82//! ```test_harness,no_run
83//! extern crate hyper;
84//! extern crate hyper_rustls;
85//! extern crate google_cloudshell1 as cloudshell1;
86//! use cloudshell1::{Result, Error};
87//! # async fn dox() {
88//! use cloudshell1::{CloudShell, FieldMask, hyper_rustls, hyper_util, yup_oauth2};
89//!
90//! // Get an ApplicationSecret instance by some means. It contains the `client_id` and
91//! // `client_secret`, among other things.
92//! let secret: yup_oauth2::ApplicationSecret = Default::default();
93//! // Instantiate the authenticator. It will choose a suitable authentication flow for you,
94//! // unless you replace `None` with the desired Flow.
95//! // Provide your own `AuthenticatorDelegate` to adjust the way it operates and get feedback about
96//! // what's going on. You probably want to bring in your own `TokenStorage` to persist tokens and
97//! // retrieve them from storage.
98//! let auth = yup_oauth2::InstalledFlowAuthenticator::builder(
99//! secret,
100//! yup_oauth2::InstalledFlowReturnMethod::HTTPRedirect,
101//! ).build().await.unwrap();
102//!
103//! let client = hyper_util::client::legacy::Client::builder(
104//! hyper_util::rt::TokioExecutor::new()
105//! )
106//! .build(
107//! hyper_rustls::HttpsConnectorBuilder::new()
108//! .with_native_roots()
109//! .unwrap()
110//! .https_or_http()
111//! .enable_http1()
112//! .build()
113//! );
114//! let mut hub = CloudShell::new(client, auth);
115//! // You can configure optional parameters by calling the respective setters at will, and
116//! // execute the final call using `doit()`.
117//! // Values shown here are possibly random and not representative !
118//! let result = hub.operations().list("name")
119//! .page_token("At")
120//! .page_size(-8)
121//! .filter("sed")
122//! .doit().await;
123//!
124//! match result {
125//! Err(e) => match e {
126//! // The Error enum provides details about what exactly happened.
127//! // You can also just use its `Debug`, `Display` or `Error` traits
128//! Error::HttpError(_)
129//! |Error::Io(_)
130//! |Error::MissingAPIKey
131//! |Error::MissingToken(_)
132//! |Error::Cancelled
133//! |Error::UploadSizeLimitExceeded(_, _)
134//! |Error::Failure(_)
135//! |Error::BadRequest(_)
136//! |Error::FieldClash(_)
137//! |Error::JsonDecodeError(_, _) => println!("{}", e),
138//! },
139//! Ok(res) => println!("Success: {:?}", res),
140//! }
141//! # }
142//! ```
143//! ## Handling Errors
144//!
145//! All errors produced by the system are provided either as [Result](common::Result) enumeration as return value of
146//! the doit() methods, or handed as possibly intermediate results to either the
147//! [Hub Delegate](common::Delegate), or the [Authenticator Delegate](https://docs.rs/yup-oauth2/*/yup_oauth2/trait.AuthenticatorDelegate.html).
148//!
149//! When delegates handle errors or intermediate values, they may have a chance to instruct the system to retry. This
150//! makes the system potentially resilient to all kinds of errors.
151//!
152//! ## Uploads and Downloads
153//! If a method supports downloads, the response body, which is part of the [Result](common::Result), should be
154//! read by you to obtain the media.
155//! If such a method also supports a [Response Result](common::ResponseResult), it will return that by default.
156//! 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
157//! this call: `.param("alt", "media")`.
158//!
159//! Methods supporting uploads can do so using up to 2 different protocols:
160//! *simple* and *resumable*. The distinctiveness of each is represented by customized
161//! `doit(...)` methods, which are then named `upload(...)` and `upload_resumable(...)` respectively.
162//!
163//! ## Customization and Callbacks
164//!
165//! You may alter the way an `doit()` method is called by providing a [delegate](common::Delegate) to the
166//! [Method Builder](common::CallBuilder) before making the final `doit()` call.
167//! Respective methods will be called to provide progress information, as well as determine whether the system should
168//! retry on failure.
169//!
170//! The [delegate trait](common::Delegate) is default-implemented, allowing you to customize it with minimal effort.
171//!
172//! ## Optional Parts in Server-Requests
173//!
174//! All structures provided by this library are made to be [encodable](common::RequestValue) and
175//! [decodable](common::ResponseResult) via *json*. Optionals are used to indicate that partial requests are responses
176//! are valid.
177//! Most optionals are are considered [Parts](common::Part) which are identifiable by name, which will be sent to
178//! the server to indicate either the set parts of the request or the desired parts in the response.
179//!
180//! ## Builder Arguments
181//!
182//! Using [method builders](common::CallBuilder), you are able to prepare an action call by repeatedly calling it's methods.
183//! These will always take a single argument, for which the following statements are true.
184//!
185//! * [PODs][wiki-pod] are handed by copy
186//! * strings are passed as `&str`
187//! * [request values](common::RequestValue) are moved
188//!
189//! Arguments will always be copied or cloned into the builder, to make them independent of their original life times.
190//!
191//! [wiki-pod]: http://en.wikipedia.org/wiki/Plain_old_data_structure
192//! [builder-pattern]: http://en.wikipedia.org/wiki/Builder_pattern
193//! [google-go-api]: https://github.com/google/google-api-go-client
194//!
195//! ## Cargo Features
196//!
197//! * `utoipa` - Add support for [utoipa](https://crates.io/crates/utoipa) and derive `utoipa::ToSchema` on all
198//! the types. You'll have to import and register the required types in `#[openapi(schemas(...))]`, otherwise the
199//! generated `openapi` spec would be invalid.
200//!
201//!
202//!
203
204// Unused attributes happen thanks to defined, but unused structures We don't
205// warn about this, as depending on the API, some data structures or facilities
206// are never used. Instead of pre-determining this, we just disable the lint.
207// It's manually tuned to not have any unused imports in fully featured APIs.
208// Same with unused_mut.
209#![allow(unused_imports, unused_mut, dead_code)]
210
211// DO NOT EDIT !
212// This file was generated automatically from 'src/generator/templates/api/lib.rs.mako'
213// DO NOT EDIT !
214
215pub extern crate hyper;
216pub extern crate hyper_rustls;
217pub extern crate hyper_util;
218#[cfg(feature = "yup-oauth2")]
219pub extern crate yup_oauth2;
220
221pub extern crate google_apis_common as common;
222pub use common::{Delegate, Error, FieldMask, Result};
223
224pub mod api;
225pub use api::CloudShell;