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