mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2025-12-31 08:33:44 +01:00
227 lines
12 KiB
Rust
227 lines
12 KiB
Rust
// DO NOT EDIT !
|
|
// This file was generated automatically from 'src/mako/api/lib.rs.mako'
|
|
// DO NOT EDIT !
|
|
|
|
//! This documentation was generated from *appengine* crate version *2.0.0+20210324*, where *20210324* is the exact revision of the *appengine:v1* schema built by the [mako](http://www.makotemplates.org/) code generator *v2.0.0*.
|
|
//!
|
|
//! Everything else about the *appengine* *v1* API can be found at the
|
|
//! [official documentation site](https://cloud.google.com/appengine/docs/admin-api/).
|
|
//! The original source code is [on github](https://github.com/Byron/google-apis-rs/tree/master/gen/appengine1).
|
|
//! # Features
|
|
//!
|
|
//! Handle the following *Resources* with ease from the central [hub](Appengine) ...
|
|
//!
|
|
//! * apps
|
|
//! * [*authorized certificates create*](api::AppAuthorizedCertificateCreateCall), [*authorized certificates delete*](api::AppAuthorizedCertificateDeleteCall), [*authorized certificates get*](api::AppAuthorizedCertificateGetCall), [*authorized certificates list*](api::AppAuthorizedCertificateListCall), [*authorized certificates patch*](api::AppAuthorizedCertificatePatchCall), [*authorized domains list*](api::AppAuthorizedDomainListCall), [*create*](api::AppCreateCall), [*domain mappings create*](api::AppDomainMappingCreateCall), [*domain mappings delete*](api::AppDomainMappingDeleteCall), [*domain mappings get*](api::AppDomainMappingGetCall), [*domain mappings list*](api::AppDomainMappingListCall), [*domain mappings patch*](api::AppDomainMappingPatchCall), [*firewall ingress rules batch update*](api::AppFirewallIngressRuleBatchUpdateCall), [*firewall ingress rules create*](api::AppFirewallIngressRuleCreateCall), [*firewall ingress rules delete*](api::AppFirewallIngressRuleDeleteCall), [*firewall ingress rules get*](api::AppFirewallIngressRuleGetCall), [*firewall ingress rules list*](api::AppFirewallIngressRuleListCall), [*firewall ingress rules patch*](api::AppFirewallIngressRulePatchCall), [*get*](api::AppGetCall), [*locations get*](api::AppLocationGetCall), [*locations list*](api::AppLocationListCall), [*operations get*](api::AppOperationGetCall), [*operations list*](api::AppOperationListCall), [*patch*](api::AppPatchCall), [*repair*](api::AppRepairCall), [*services delete*](api::AppServiceDeleteCall), [*services get*](api::AppServiceGetCall), [*services list*](api::AppServiceListCall), [*services patch*](api::AppServicePatchCall), [*services versions create*](api::AppServiceVersionCreateCall), [*services versions delete*](api::AppServiceVersionDeleteCall), [*services versions get*](api::AppServiceVersionGetCall), [*services versions instances debug*](api::AppServiceVersionInstanceDebugCall), [*services versions instances delete*](api::AppServiceVersionInstanceDeleteCall), [*services versions instances get*](api::AppServiceVersionInstanceGetCall), [*services versions instances list*](api::AppServiceVersionInstanceListCall), [*services versions list*](api::AppServiceVersionListCall) and [*services versions patch*](api::AppServiceVersionPatchCall)
|
|
//!
|
|
//!
|
|
//!
|
|
//!
|
|
//! Not what you are looking for ? Find all other Google APIs in their Rust [documentation index](http://byron.github.io/google-apis-rs).
|
|
//!
|
|
//! # Structure of this Library
|
|
//!
|
|
//! The API is structured into the following primary items:
|
|
//!
|
|
//! * **[Hub](Appengine)**
|
|
//! * a central object to maintain state and allow accessing all *Activities*
|
|
//! * creates [*Method Builders*](client::MethodsBuilder) which in turn
|
|
//! allow access to individual [*Call Builders*](client::CallBuilder)
|
|
//! * **[Resources](client::Resource)**
|
|
//! * primary types that you can apply *Activities* to
|
|
//! * a collection of properties and *Parts*
|
|
//! * **[Parts](client::Part)**
|
|
//! * a collection of properties
|
|
//! * never directly used in *Activities*
|
|
//! * **[Activities](client::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.apps().domain_mappings_create(...).doit().await
|
|
//! let r = hub.apps().domain_mappings_delete(...).doit().await
|
|
//! let r = hub.apps().domain_mappings_patch(...).doit().await
|
|
//! let r = hub.apps().operations_get(...).doit().await
|
|
//! let r = hub.apps().services_versions_instances_debug(...).doit().await
|
|
//! let r = hub.apps().services_versions_instances_delete(...).doit().await
|
|
//! let r = hub.apps().services_versions_create(...).doit().await
|
|
//! let r = hub.apps().services_versions_delete(...).doit().await
|
|
//! let r = hub.apps().services_versions_patch(...).doit().await
|
|
//! let r = hub.apps().services_delete(...).doit().await
|
|
//! let r = hub.apps().services_patch(...).doit().await
|
|
//! let r = hub.apps().create(...).doit().await
|
|
//! let r = hub.apps().patch(...).doit().await
|
|
//! let r = hub.apps().repair(...).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-appengine1 = "*"
|
|
//! # This project intentionally uses an old version of Hyper. See
|
|
//! # https://github.com/Byron/google-apis-rs/issues/173 for more
|
|
//! # information.
|
|
//! hyper = "^0.14"
|
|
//! hyper-rustls = "^0.22"
|
|
//! serde = "^1.0"
|
|
//! serde_json = "^1.0"
|
|
//! yup-oauth2 = "^5.0"
|
|
//! ```
|
|
//!
|
|
//! ## A complete example
|
|
//!
|
|
//! ```test_harness,no_run
|
|
//! extern crate hyper;
|
|
//! extern crate hyper_rustls;
|
|
//! extern crate yup_oauth2 as oauth2;
|
|
//! extern crate google_appengine1 as appengine1;
|
|
//! use appengine1::api::DebugInstanceRequest;
|
|
//! use appengine1::{Result, Error};
|
|
//! # async fn dox() {
|
|
//! use std::default::Default;
|
|
//! use oauth2;
|
|
//! use appengine1::Appengine;
|
|
//!
|
|
//! // Get an ApplicationSecret instance by some means. It contains the `client_id` and
|
|
//! // `client_secret`, among other things.
|
|
//! let secret: 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 mut hub = Appengine::new(hyper::Client::builder().build(hyper_rustls::HttpsConnector::with_native_roots()), 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 = DebugInstanceRequest::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.apps().services_versions_instances_debug(req, "appsId", "servicesId", "versionsId", "instancesId")
|
|
//! .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](client::Result) enumeration as return value of
|
|
//! the doit() methods, or handed as possibly intermediate results to either the
|
|
//! [Hub Delegate](client::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](client::Result), should be
|
|
//! read by you to obtain the media.
|
|
//! If such a method also supports a [Response Result](client::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](client::Delegate) to the
|
|
//! [Method Builder](client::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](client::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](client::RequestValue) and
|
|
//! [decodable](client::ResponseResult) via *json*. Optionals are used to indicate that partial requests are responses
|
|
//! are valid.
|
|
//! Most optionals are are considered [Parts](client::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](client::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](client::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
|
|
//!
|
|
//!
|
|
|
|
// Unused attributes happen thanks to defined, but unused structures
|
|
// We don't warn about this, as depending on the API, some data structures or facilities are never used.
|
|
// Instead of pre-determining this, we just disable the lint. It's manually tuned to not have any
|
|
// unused imports in fully featured APIs. Same with unused_mut ... .
|
|
#![allow(unused_imports, unused_mut, dead_code)]
|
|
|
|
// DO NOT EDIT !
|
|
// This file was generated automatically from 'src/mako/api/lib.rs.mako'
|
|
// DO NOT EDIT !
|
|
|
|
#[macro_use]
|
|
extern crate serde_derive;
|
|
|
|
extern crate hyper;
|
|
extern crate serde;
|
|
extern crate serde_json;
|
|
extern crate yup_oauth2 as oauth2;
|
|
extern crate mime;
|
|
extern crate url;
|
|
|
|
pub mod api;
|
|
pub mod client;
|
|
|
|
// Re-export the hub type and some basic client structs
|
|
pub use api::Appengine;
|
|
pub use client::{Result, Error, Delegate};
|