// DO NOT EDIT ! // This file was generated automatically from 'src/mako/api/lib.rs.mako' // DO NOT EDIT ! //! This documentation was generated from *Maps Engine* crate version *0.1.9+20150629*, where *20150629* is the exact revision of the *mapsengine:v1* schema built by the [mako](http://www.makotemplates.org/) code generator *v0.1.9*. //! //! Everything else about the *Maps Engine* *v1* API can be found at the //! [official documentation site](https://developers.google.com/maps-engine/). //! The original source code is [on github](https://github.com/Byron/google-apis-rs/tree/master/gen/mapsengine1). //! # Features //! //! Handle the following *Resources* with ease from the central [hub](struct.MapsEngine.html) ... //! //! * [assets](struct.Asset.html) //! * [*get*](struct.AssetGetCall.html), [*list*](struct.AssetListCall.html), [*parents list*](struct.AssetParentListCall.html) and [*permissions list*](struct.AssetPermissionListCall.html) //! * [layers](struct.Layer.html) //! * [*cancel processing*](struct.LayerCancelProcessingCall.html), [*create*](struct.LayerCreateCall.html), [*delete*](struct.LayerDeleteCall.html), [*get*](struct.LayerGetCall.html), [*get published*](struct.LayerGetPublishedCall.html), [*list*](struct.LayerListCall.html), [*list published*](struct.LayerListPublishedCall.html), [*parents list*](struct.LayerParentListCall.html), [*patch*](struct.LayerPatchCall.html), [*permissions batch delete*](struct.LayerPermissionBatchDeleteCall.html), [*permissions batch update*](struct.LayerPermissionBatchUpdateCall.html), [*permissions list*](struct.LayerPermissionListCall.html), [*process*](struct.LayerProcesCall.html), [*publish*](struct.LayerPublishCall.html) and [*unpublish*](struct.LayerUnpublishCall.html) //! * [maps](struct.Map.html) //! * [*create*](struct.MapCreateCall.html), [*delete*](struct.MapDeleteCall.html), [*get*](struct.MapGetCall.html), [*get published*](struct.MapGetPublishedCall.html), [*list*](struct.MapListCall.html), [*list published*](struct.MapListPublishedCall.html), [*patch*](struct.MapPatchCall.html), [*permissions batch delete*](struct.MapPermissionBatchDeleteCall.html), [*permissions batch update*](struct.MapPermissionBatchUpdateCall.html), [*permissions list*](struct.MapPermissionListCall.html), [*publish*](struct.MapPublishCall.html) and [*unpublish*](struct.MapUnpublishCall.html) //! * [projects](struct.Project.html) //! * [*icons create*](struct.ProjectIconCreateCall.html), [*icons get*](struct.ProjectIconGetCall.html), [*icons list*](struct.ProjectIconListCall.html) and [*list*](struct.ProjectListCall.html) //! * [raster collections](struct.RasterCollection.html) //! * [*cancel processing*](struct.RasterCollectionCancelProcessingCall.html), [*create*](struct.RasterCollectionCreateCall.html), [*delete*](struct.RasterCollectionDeleteCall.html), [*get*](struct.RasterCollectionGetCall.html), [*list*](struct.RasterCollectionListCall.html), [*parents list*](struct.RasterCollectionParentListCall.html), [*patch*](struct.RasterCollectionPatchCall.html), [*permissions batch delete*](struct.RasterCollectionPermissionBatchDeleteCall.html), [*permissions batch update*](struct.RasterCollectionPermissionBatchUpdateCall.html), [*permissions list*](struct.RasterCollectionPermissionListCall.html), [*process*](struct.RasterCollectionProcesCall.html), [*rasters batch delete*](struct.RasterCollectionRasterBatchDeleteCall.html), [*rasters batch insert*](struct.RasterCollectionRasterBatchInsertCall.html) and [*rasters list*](struct.RasterCollectionRasterListCall.html) //! * [rasters](struct.Raster.html) //! * [*delete*](struct.RasterDeleteCall.html), [*files insert*](struct.RasterFileInsertCall.html), [*get*](struct.RasterGetCall.html), [*list*](struct.RasterListCall.html), [*parents list*](struct.RasterParentListCall.html), [*patch*](struct.RasterPatchCall.html), [*permissions batch delete*](struct.RasterPermissionBatchDeleteCall.html), [*permissions batch update*](struct.RasterPermissionBatchUpdateCall.html), [*permissions list*](struct.RasterPermissionListCall.html), [*process*](struct.RasterProcesCall.html) and [*upload*](struct.RasterUploadCall.html) //! * [tables](struct.Table.html) //! * [*create*](struct.TableCreateCall.html), [*delete*](struct.TableDeleteCall.html), [*features batch delete*](struct.TableFeatureBatchDeleteCall.html), [*features batch insert*](struct.TableFeatureBatchInsertCall.html), [*features batch patch*](struct.TableFeatureBatchPatchCall.html), [*features get*](struct.TableFeatureGetCall.html), [*features list*](struct.TableFeatureListCall.html), [*files insert*](struct.TableFileInsertCall.html), [*get*](struct.TableGetCall.html), [*list*](struct.TableListCall.html), [*parents list*](struct.TableParentListCall.html), [*patch*](struct.TablePatchCall.html), [*permissions batch delete*](struct.TablePermissionBatchDeleteCall.html), [*permissions batch update*](struct.TablePermissionBatchUpdateCall.html), [*permissions list*](struct.TablePermissionListCall.html), [*process*](struct.TableProcesCall.html) and [*upload*](struct.TableUploadCall.html) //! //! //! Upload supported by ... //! //! * [*icons create projects*](struct.ProjectIconCreateCall.html) //! * [*files insert tables*](struct.TableFileInsertCall.html) //! * [*files insert rasters*](struct.RasterFileInsertCall.html) //! //! Download supported by ... //! //! * [*icons get projects*](struct.ProjectIconGetCall.html) //! //! //! //! Not what you are looking for ? Find all other Google APIs in their Rust [documentation index](../index.html). //! //! # Structure of this Library //! //! The API is structured into the following primary items: //! //! * **[Hub](struct.MapsEngine.html)** //! * a central object to maintain state and allow accessing all *Activities* //! * creates [*Method Builders*](trait.MethodsBuilder.html) which in turn //! allow access to individual [*Call Builders*](trait.CallBuilder.html) //! * **[Resources](trait.Resource.html)** //! * primary types that you can apply *Activities* to //! * a collection of properties and *Parts* //! * **[Parts](trait.Part.html)** //! * a collection of properties //! * never directly used in *Activities* //! * **[Activities](trait.CallBuilder.html)** //! * 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() //! ``` //! //! Or specifically ... //! //! ```ignore //! let r = hub.tables().features_batch_insert(...).doit() //! let r = hub.tables().list(...).doit() //! let r = hub.tables().patch(...).doit() //! let r = hub.tables().get(...).doit() //! let r = hub.tables().files_insert(...).doit() //! let r = hub.tables().features_batch_delete(...).doit() //! let r = hub.tables().permissions_batch_delete(...).doit() //! let r = hub.tables().permissions_batch_update(...).doit() //! let r = hub.tables().features_list(...).doit() //! let r = hub.tables().process(...).doit() //! let r = hub.tables().upload(...).doit() //! let r = hub.tables().delete(...).doit() //! let r = hub.tables().parents_list(...).doit() //! let r = hub.tables().features_batch_patch(...).doit() //! let r = hub.tables().permissions_list(...).doit() //! let r = hub.tables().features_get(...).doit() //! let r = hub.tables().create(...).doit() //! ``` //! //! 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-mapsengine1 = "*" //! ``` //! //! ## A complete example //! //! ```test_harness,no_run //! extern crate hyper; //! extern crate yup_oauth2 as oauth2; //! extern crate google_mapsengine1 as mapsengine1; //! use mapsengine1::{Result, Error}; //! # #[test] fn egal() { //! use std::default::Default; //! use oauth2::{Authenticator, DefaultAuthenticatorDelegate, ApplicationSecret, MemoryStorage}; //! use mapsengine1::MapsEngine; //! //! // Get an ApplicationSecret instance by some means. It contains the `client_id` and //! // `client_secret`, among other things. //! let secret: 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 = Authenticator::new(&secret, DefaultAuthenticatorDelegate, //! hyper::Client::new(), //! ::default(), None); //! let mut hub = MapsEngine::new(hyper::Client::new(), auth); //! // 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.tables().list() //! .tags("Lorem") //! .search("consetetur") //! .role("consetetur") //! .project_id("eirmod") //! .processing_status("labore") //! .page_token("gubergren") //! .modified_before("et") //! .modified_after("sadipscing") //! .max_results(28) //! .creator_email("magna") //! .created_before("Lorem") //! .created_after("rebum.") //! .bbox("et") //! .doit(); //! //! 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::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](enum.Result.html) enumeration as return value of //! the doit() methods, or handed as possibly intermediate results to either the //! [Hub Delegate](trait.Delegate.html), or the [Authenticator Delegate](../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](enum.Result.html), should be //! read by you to obtain the media. //! If such a method also supports a [Response Result](trait.ResponseResult.html), 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](trait.Delegate.html) to the //! [Method Builder](trait.CallBuilder.html) 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](trait.Delegate.html) 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 [enocodable](trait.RequestValue.html) and //! [decodable](trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses //! are valid. //! Most optionals are are considered [Parts](trait.Part.html) 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](trait.CallBuilder.html), 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](trait.RequestValue.html) 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)] include!(concat!(env!("OUT_DIR"), "/lib.rs"));