Crate google_appengine1 [−] [src]
This documentation was generated from appengine crate version 0.1.14+20160802, where 20160802 is the exact revision of the appengine:v1 schema built by the mako code generator v0.1.14.
Everything else about the appengine v1 API can be found at the official documentation site. The original source code is on github.
Features
Handle the following Resources with ease from the central hub ...
- apps
- get, locations get, locations list, operations get, operations list, repair, services delete, services get, services list, services patch, services versions create, services versions delete, services versions get, services versions instances debug, services versions instances delete, services versions instances get, services versions instances list, services versions list and services versions patch
Not what you are looking for ? Find all other Google APIs in their Rust documentation index.
Structure of this Library
The API is structured into the following primary items:
- Hub
- a central object to maintain state and allow accessing all Activities
- creates Method Builders which in turn allow access to individual Call Builders
- Resources
- primary types that you can apply Activities to
- a collection of properties and Parts
- Parts
- a collection of properties
- never directly used in Activities
- Activities
- 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:
let r = hub.resource().activity(...).doit()
Or specifically ...
let r = hub.apps().services_versions_create(...).doit() let r = hub.apps().services_versions_instances_debug(...).doit() let r = hub.apps().services_versions_instances_delete(...).doit() let r = hub.apps().services_versions_patch(...).doit() let r = hub.apps().operations_get(...).doit() let r = hub.apps().repair(...).doit() let r = hub.apps().services_versions_delete(...).doit() let r = hub.apps().services_patch(...).doit() let r = hub.apps().services_delete(...).doit()
The resource()
and activity(...)
calls create builders. 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 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:
[dependencies]
google-appengine1 = "*"
A complete example
extern crate hyper; extern crate yup_oauth2 as oauth2; extern crate google_appengine1 as appengine1; use appengine1::DebugInstanceRequest; use appengine1::{Result, Error}; use std::default::Default; use oauth2::{Authenticator, DefaultAuthenticatorDelegate, ApplicationSecret, MemoryStorage}; use appengine1::Appengine; // 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(), <MemoryStorage as Default>::default(), None); let mut hub = Appengine::new(hyper::Client::new(), 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(); 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 enumeration as return value of the doit() methods, or handed as possibly intermediate results to either the Hub Delegate, or the Authenticator Delegate.
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, should be
read by you to obtain the media.
If such a method also supports a Response Result, 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 to the
Method Builder 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 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 and decodable via json. Optionals are used to indicate that partial requests are responses are valid. Most optionals are are considered Parts 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, 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 are handed by copy
- strings are passed as
&str
- request values are moved
Arguments will always be copied or cloned into the builder, to make them independent of their original life times.
Structs
ApiConfigHandler |
Google Cloud Endpoints configuration for API handlers. |
ApiEndpointHandler |
Uses Google Cloud Endpoints to handle requests. |
AppGetCall |
Gets information about an application. |
AppLocationGetCall |
Get information about a location. |
AppLocationListCall |
Lists information about the supported locations for this service. |
AppMethods |
A builder providing access to all methods supported on app resources.
It is not used directly, but through the |
AppOperationGetCall |
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. |
AppOperationListCall |
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns |
AppRepairCall |
Recreates the required App Engine features for the application in your project, for example a Cloud Storage bucket or App Engine service account. Use this method if you receive an error message about a missing feature, for example "*Error retrieving the App Engine service account*". |
AppServiceDeleteCall |
Deletes the specified service and all enclosed versions. |
AppServiceGetCall |
Gets the current configuration of the specified service. |
AppServiceListCall |
Lists all the services in the application. |
AppServicePatchCall |
Updates the configuration of the specified service. |
AppServiceVersionCreateCall |
Deploys code and resource files to a new version. |
AppServiceVersionDeleteCall |
Deletes an existing Version resource. |
AppServiceVersionGetCall |
Gets the specified Version resource. By default, only a |
AppServiceVersionInstanceDebugCall |
Enables debugging on a VM instance. This allows you to use the SSH command to connect to the virtual machine where the instance lives. While in "debug mode", the instance continues to serve live traffic. You should delete the instance when you are done debugging and then allow the system to take over and determine if another instance should be started. Only applicable for instances in App Engine flexible environment. |
AppServiceVersionInstanceDeleteCall |
Stops a running instance. |
AppServiceVersionInstanceGetCall |
Gets instance information. |
AppServiceVersionInstanceListCall |
Lists the instances of a version. |
AppServiceVersionListCall |
Lists the versions of a service. |
AppServiceVersionPatchCall |
Updates the specified Version resource. You can specify the following fields depending on the App Engine environment and type of scaling that the version resource uses: * |
Appengine |
Central instance to access all Appengine related resource activities |
Application |
An Application resource contains the top-level configuration of an App Engine application. |
AutomaticScaling |
Automatic scaling is based on request rate, response latencies, and other application metrics. |
BasicScaling |
A service with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity. |
ContainerInfo |
Docker image that is used to start a VM container for the version you deploy. |
CpuUtilization |
Target scaling by CPU usage. |
DebugInstanceRequest |
Request message for |
DefaultDelegate |
A delegate with a conservative default implementation, which is used if no other delegate is set. |
Deployment |
Code and application artifacts used to deploy a version to App Engine. |
DiskUtilization |
Target scaling by disk usage. Only applicable for VM runtimes. |
ErrorHandler |
Custom static error page to be served when an error occurs. |
ErrorResponse |
A utility to represent detailed errors we might see in case there are BadRequests. The latter happen if the sent parameters or request structures are unsound |
FileInfo |
Single source file that is part of the version to be deployed. Each source file that is deployed must be specified separately. |
HealthCheck |
Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances. Only applicable for instances in App Engine flexible environment. |
Instance |
An Instance resource is the computing unit that App Engine uses to automatically scale an application. |
Library |
Third-party Python runtime library that is required by the application. |
ListInstancesResponse |
Response message for |
ListLocationsResponse |
The response message for LocationService.ListLocations. |
ListOperationsResponse |
The response message for Operations.ListOperations. |
ListServicesResponse |
Response message for |
ListVersionsResponse |
Response message for |
Location |
A resource that represents Google Cloud Platform location. |
ManualScaling |
A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time. |
MethodInfo |
Contains information about an API request. |
MultiPartReader |
Provides a |
Network |
Extra network settings. Only applicable for VM runtimes. |
NetworkUtilization |
Target scaling by network usage. Only applicable for VM runtimes. |
Operation |
This resource represents a long-running operation that is the result of a network API call. |
RepairApplicationRequest |
Request message for 'Applications.RepairApplication'. |
RequestUtilization |
Target scaling by request utilization. Only applicable for VM runtimes. |
Resources |
Machine resources for a version. |
ScriptHandler |
Executes a script to handle the request that matches the URL pattern. |
Service |
A Service resource is a logical component of an application that can share state and communicate in a secure fashion with other services. For example, an application that handles customer requests might include separate services to handle tasks such as backend data analysis or API requests from mobile devices. Each service has a collection of versions that define a specific set of code used to implement the functionality of that service. |
StaticFilesHandler |
Files served directly to the user for a given URL, such as images, CSS stylesheets, or JavaScript source files. Static file handlers describe which files in the application directory are static files, and which URLs serve them. |
Status |
The |
TrafficSplit |
Traffic routing configuration for versions within a single service. Traffic splits define how traffic directed to the service is assigned to versions. |
UrlDispatchRule |
Rules to match an HTTP request and dispatch that request to a service. |
UrlMap |
URL pattern and description of how the URL should be handled. App Engine can handle URLs by executing application code or by serving static files uploaded with the version, such as images, CSS, or JavaScript. |
Version |
A Version resource is a specific set of source code and configuration files that are deployed into a service. |
ZipInfo |
There is no detailed description. |
Enums
Error | |
Scope |
Identifies the an OAuth2 authorization scope. A scope is needed when requesting an authorization token. |
Traits
CallBuilder |
Identifies types which represent builders for a particular resource method |
Delegate |
A trait specifying functionality to help controlling any request performed by the API. The trait has a conservative default implementation. |
Hub |
Identifies the Hub. There is only one per library, this trait is supposed to make intended use more explicit. The hub allows to access all resource methods more easily. |
MethodsBuilder |
Identifies types for building methods of a particular resource type |
NestedType |
Identifies types which are only used by other types internally. They have no special meaning, this trait just marks them for completeness. |
Part |
Identifies types which are only used as part of other types, which
usually are carrying the |
ReadSeek |
A utility to specify reader types which provide seeking capabilities too |
RequestValue |
Identifies types which are used in API requests. |
Resource |
Identifies types which can be inserted and deleted. Types with this trait are most commonly used by clients of this API. |
ResponseResult |
Identifies types which are used in API responses. |
ToParts |
A trait for all types that can convert themselves into a parts string |
Functions
remove_json_null_values |
Type Definitions
Result |
A universal result type used as return for all calls. |