[−][src]Crate google_replicapoolupdater1_beta1
This documentation was generated from replicapoolupdater crate version 1.0.14+20161003, where 20161003 is the exact revision of the replicapoolupdater:v1beta1 schema built by the mako code generator v1.0.14.
Everything else about the replicapoolupdater v1_beta1 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 ...
- rolling updates
- cancel, get, insert, list, list instance updates, pause, resume and rollback
- zone operations
- get and list
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.rolling_updates().pause(...).doit() let r = hub.rolling_updates().rollback(...).doit() let r = hub.rolling_updates().get(...).doit() let r = hub.rolling_updates().resume(...).doit() let r = hub.rolling_updates().list(...).doit() let r = hub.rolling_updates().insert(...).doit() let r = hub.rolling_updates().list_instance_updates(...).doit() let r = hub.rolling_updates().cancel(...).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-replicapoolupdater1_beta1 = "*"
# This project intentionally uses an old version of Hyper. See
# https://github.com/Byron/google-apis-rs/issues/173 for more
# information.
hyper = "^0.10"
hyper-rustls = "^0.6"
serde = "^1.0"
serde_json = "^1.0"
yup-oauth2 = "^1.0"
A complete example
extern crate hyper; extern crate hyper_rustls; extern crate yup_oauth2 as oauth2; extern crate google_replicapoolupdater1_beta1 as replicapoolupdater1_beta1; use replicapoolupdater1_beta1::{Result, Error}; use std::default::Default; use oauth2::{Authenticator, DefaultAuthenticatorDelegate, ApplicationSecret, MemoryStorage}; use replicapoolupdater1_beta1::Replicapoolupdater; // 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::with_connector(hyper::net::HttpsConnector::new(hyper_rustls::TlsClient::new())), <MemoryStorage as Default>::default(), None); let mut hub = Replicapoolupdater::new(hyper::Client::with_connector(hyper::net::HttpsConnector::new(hyper_rustls::TlsClient::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.rolling_updates().list_instance_updates("project", "zone", "rollingUpdate") .page_token("justo") .max_results(100) .filter("erat") .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 encodable 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
| Chunk | |
| ContentRange | Implements the Content-Range header, for serialization only |
| DefaultDelegate | A delegate with a conservative default implementation, which is used if no other delegate is set. |
| DummyNetworkStream | |
| 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 |
| InstanceUpdate | Update of a single instance. |
| InstanceUpdateError | Errors that occurred during the instance update. |
| InstanceUpdateErrorErrors | [Output Only] The array of errors encountered while processing this operation. |
| InstanceUpdateList | Response returned by ListInstanceUpdates method. |
| JsonServerError | A utility type which can decode a server response that indicates error |
| MethodInfo | Contains information about an API request. |
| MultiPartReader | Provides a |
| Operation | An operation resource, used to manage asynchronous API requests. |
| OperationError | [Output Only] If errors occurred during processing of this operation, this field will be populated. |
| OperationErrorErrors | [Output Only] The array of errors encountered while processing this operation. |
| OperationList | Contains a list of Operation resources. |
| OperationWarnings | There is no detailed description. |
| OperationWarningsData | [Output only] Metadata for this warning in key:value format. |
| RangeResponseHeader | |
| Replicapoolupdater | Central instance to access all Replicapoolupdater related resource activities |
| ResumableUploadHelper | A utility type to perform a resumable upload from start to end. |
| RollingUpdate | The following represents a resource describing a single update (rollout) of a group of instances to the given template. |
| RollingUpdateCancelCall | Cancels an update. The update must be PAUSED before it can be cancelled. This has no effect if the update is already CANCELLED. |
| RollingUpdateError | [Output Only] Errors that occurred during the rolling update. |
| RollingUpdateErrorErrors | [Output Only] The array of errors encountered while processing this operation. |
| RollingUpdateGetCall | Returns information about an update. |
| RollingUpdateInsertCall | Inserts and starts a new update. |
| RollingUpdateList | Response returned by List method. |
| RollingUpdateListCall | Lists recent updates for a given managed instance group, in reverse chronological order and paginated format. |
| RollingUpdateListInstanceUpdateCall | Lists the current status for each instance within a given update. |
| RollingUpdateMethods | A builder providing access to all methods supported on rollingUpdate resources.
It is not used directly, but through the |
| RollingUpdatePauseCall | Pauses the update in state from ROLLING_FORWARD or ROLLING_BACK. Has no effect if invoked when the state of the update is PAUSED. |
| RollingUpdatePolicy | Parameters of the update process. |
| RollingUpdateResumeCall | Continues an update in PAUSED state. Has no effect if invoked when the state of the update is ROLLED_OUT. |
| RollingUpdateRollbackCall | Rolls back the update in state from ROLLING_FORWARD or PAUSED. Has no effect if invoked when the state of the update is ROLLED_BACK. |
| ServerError | |
| ServerMessage | |
| XUploadContentType | The |
| ZoneOperationGetCall | Retrieves the specified zone-specific operation resource. |
| ZoneOperationListCall | Retrieves the list of Operation resources contained within the specified zone. |
| ZoneOperationMethods | A builder providing access to all methods supported on zoneOperation resources.
It is not used directly, but through the |
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 |
| UnusedType | Identifies types which are not actually used by the API This might be a bug within the google API schema. |
Functions
| remove_json_null_values |
Type Definitions
| Result | A universal result type used as return for all calls. |