[][src]Crate google_manager1_beta2

This documentation was generated from manager crate version 1.0.9+20140915, where 20140915 is the exact revision of the manager:v1beta2 schema built by the mako code generator v1.0.9.

Everything else about the manager v1_beta2 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 ...

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 ...

This example is not tested
let r = hub.deployments().delete(...).doit()
let r = hub.deployments().get(...).doit()
let r = hub.deployments().insert(...).doit()
let r = hub.deployments().list(...).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-manager1_beta2 = "*"
# 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_manager1_beta2 as manager1_beta2;
use manager1_beta2::{Result, Error};
use std::default::Default;
use oauth2::{Authenticator, DefaultAuthenticatorDelegate, ApplicationSecret, MemoryStorage};
use manager1_beta2::Manager;
 
// 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 = Manager::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.deployments().list("projectId", "region")
             .page_token("kasd")
             .max_results(-22)
             .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.

Arguments will always be copied or cloned into the builder, to make them independent of their original life times.

Structs

AccessConfig

A Compute Engine network accessConfig. Identical to the accessConfig on corresponding Compute Engine resource.

Action

An Action encapsulates a set of commands as a single runnable module with additional information needed during run-time.

AllowedRule

An allowed port resource.

AutoscalingModule

There is no detailed description.

AutoscalingModuleStatus

There is no detailed description.

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.

DeployState

[Output Only] The current state of a replica or module.

Deployment

A deployment represents a physical instantiation of a Template.

DeploymentDeleteCall

A builder for the delete method supported by a deployment resource. It is not used directly, but through a DeploymentMethods instance.

DeploymentGetCall

A builder for the get method supported by a deployment resource. It is not used directly, but through a DeploymentMethods instance.

DeploymentInsertCall

A builder for the insert method supported by a deployment resource. It is not used directly, but through a DeploymentMethods instance.

DeploymentListCall

A builder for the list method supported by a deployment resource. It is not used directly, but through a DeploymentMethods instance.

DeploymentMethods

A builder providing access to all methods supported on deployment resources. It is not used directly, but through the Manager hub.

DeploymentsListResponse

There is no detailed description.

DiskAttachment

How to attach a disk to a Replica.

DummyNetworkStream
EnvVariable

An environment variable.

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

ExistingDisk

A pre-existing persistent disk that will be attached to every Replica in the Pool.

FirewallModule

A Firewall resource

FirewallModuleStatus

There is no detailed description.

HealthCheckModule

There is no detailed description.

HealthCheckModuleStatus

There is no detailed description.

JsonServerError

A utility type which can decode a server response that indicates error

LbModule

There is no detailed description.

LbModuleStatus

There is no detailed description.

Manager

Central instance to access all Manager related resource activities

Metadata

A Compute Engine metadata entry. Identical to the metadata on the corresponding Compute Engine resource.

MetadataItem

A Compute Engine metadata item, defined as a key:value pair. Identical to the metadata on the corresponding Compute Engine resource.

MethodInfo

Contains information about an API request.

Module

A module in a configuration. A module represents a single homogeneous, possibly replicated task.

ModuleStatus

[Output Only] Aggregate status for a module.

MultiPartReader

Provides a Read interface that converts multiple parts into the protocol identified by RFC2387. Note: This implementation is just as rich as it needs to be to perform uploads to google APIs, and might not be a fully-featured implementation.

NetworkInterface

A Compute Engine NetworkInterface resource. Identical to the NetworkInterface on the corresponding Compute Engine resource.

NetworkModule

There is no detailed description.

NetworkModuleStatus

There is no detailed description.

NewDisk

A Persistent Disk resource that will be created and attached to each Replica in the Pool. Each Replica will have a unique persistent disk that is created and attached to that Replica.

NewDiskInitializeParams

Initialization parameters for creating a new disk.

ParamOverride

A specification for overriding parameters in a Template that corresponds to the Deployment.

RangeResponseHeader
ReplicaPoolModule

There is no detailed description.

ReplicaPoolModuleStatus

There is no detailed description.

ReplicaPoolParams

Configuration information for a ReplicaPools resource. Specifying an item within will determine the ReplicaPools API version used for a ReplicaPoolModule. Only one may be specified.

ReplicaPoolParamsV1Beta1

Configuration information for a ReplicaPools v1beta1 API resource. Directly maps to ReplicaPool InitTemplate.

ResumableUploadHelper

A utility type to perform a resumable upload from start to end.

ServerError
ServerMessage
ServiceAccount

A Compute Engine service account, identical to the Compute Engine resource.

Tag

A Compute Engine Instance tag, identical to the tags on the corresponding Compute Engine Instance resource.

Template

A Template represents a complete configuration for a Deployment.

TemplateDeleteCall

A builder for the delete method supported by a template resource. It is not used directly, but through a TemplateMethods instance.

TemplateGetCall

A builder for the get method supported by a template resource. It is not used directly, but through a TemplateMethods instance.

TemplateInsertCall

A builder for the insert method supported by a template resource. It is not used directly, but through a TemplateMethods instance.

TemplateListCall

A builder for the list method supported by a template resource. It is not used directly, but through a TemplateMethods instance.

TemplateMethods

A builder providing access to all methods supported on template resources. It is not used directly, but through the Manager hub.

TemplatesListResponse

There is no detailed description.

XUploadContentType

The X-Upload-Content-Type header.

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 Resource trait.

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.