Crate google_container1 [] [src]

This documentation was generated from container crate version 1.0.6+20170430, where 20170430 is the exact revision of the container:v1 schema built by the mako code generator v1.0.6.

Everything else about the container v1 API can be found at the official documentation site. The original source code is on github.


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

Be careful when using this code, it's not being tested!
let r = hub.projects().zones_clusters_node_pools_rollback(...).doit()
let r = hub.projects().zones_clusters_delete(...).doit()
let r = hub.projects().zones_clusters_node_pools_create(...).doit()
let r = hub.projects().zones_clusters_set_master_auth(...).doit()
let r = hub.projects().zones_clusters_complete_ip_rotation(...).doit()
let r = hub.projects().zones_clusters_node_pools_set_management(...).doit()
let r = hub.projects().zones_clusters_legacy_abac(...).doit()
let r = hub.projects().zones_operations_get(...).doit()
let r = hub.projects().zones_clusters_resource_labels(...).doit()
let r = hub.projects().zones_clusters_create(...).doit()
let r = hub.projects().zones_clusters_update(...).doit()
let r = hub.projects().zones_clusters_start_ip_rotation(...).doit()
let r = hub.projects().zones_clusters_node_pools_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.


Setting up your Project

To use this library, you would put the following lines into your Cargo.toml file:

google-container1 = "*"

A complete example

extern crate hyper;
extern crate hyper_rustls;
extern crate yup_oauth2 as oauth2;
extern crate google_container1 as container1;
use container1::RollbackNodePoolUpgradeRequest;
use container1::{Result, Error};
use std::default::Default;
use oauth2::{Authenticator, DefaultAuthenticatorDelegate, ApplicationSecret, MemoryStorage};
use container1::Container;
// 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,
                              <MemoryStorage as Default>::default(), None);
let mut hub = Container::new(hyper::Client::with_connector(hyper::net::HttpsConnector::new(hyper_rustls::TlsClient::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 = RollbackNodePoolUpgradeRequest::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.projects().zones_clusters_node_pools_rollback(req, "projectId", "zone", "clusterId", "nodePoolId")
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::UploadSizeLimitExceeded(_, _)
        |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.



Configuration for the addons that can be automatically spun up in the cluster, enabling additional functionality.


AutoUpgradeOptions defines the set of options for the user to control how the Auto Upgrades will proceed.


CancelOperationRequest cancels a single operation.


A Google Container Engine cluster.


ClusterUpdate describes an update to the cluster. Exactly one update can be applied to a cluster with each request, so at most one field can be provided.


CompleteIPRotationRequest moves the cluster master back into single-IP mode.


Central instance to access all Container related resource activities


CreateClusterRequest creates a cluster.


CreateNodePoolRequest creates a node pool for a cluster.


A delegate with a conservative default implementation, which is used if no other delegate is set.


A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance:


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


Configuration options for the horizontal pod autoscaling feature, which increases or decreases the number of replica pods a replication controller has based on the resource usage of the existing pods.


Configuration options for the HTTP (L7) load balancing controller addon, which makes it easy to set up HTTP load balancers for services in a cluster.


Configuration for the legacy Attribute Based Access Control authorization mode.


ListClustersResponse is the result of ListClustersRequest.


ListNodePoolsResponse is the result of ListNodePoolsRequest.


ListOperationsResponse is the result of ListOperationsRequest.


The authentication information for accessing the master endpoint. Authentication can be done using HTTP basic auth or using client certificates.


Contains information about an API request.


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.


Parameters that describe the nodes in a cluster.


NodeManagement defines the set of node management services turned on for the node pool.


NodePool contains the name and configuration for a cluster's node pool. Node pools are a set of nodes (i.e. VM's), with a common configuration and specification, under the control of the cluster master. They may have a set of Kubernetes labels applied to them, which may be used to reference them during pod scheduling. They may also be resized up or down, to accommodate the workload.


NodePoolAutoscaling contains information required by cluster autoscaler to adjust the size of the node pool to the current cluster usage.


This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.


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


Completes master IP rotation.


Creates a cluster, consisting of the specified number and type of Google Compute Engine instances.


Deletes the cluster, including the Kubernetes endpoint and all worker nodes.


Gets the details of a specific cluster.


Enables or disables the ABAC authorization mechanism on a cluster.


Lists all clusters owned by a project in either the specified zone or all zones.


Creates a node pool for a cluster.


Deletes a node pool from a cluster.


Retrieves the node pool requested.


Lists the node pools for a cluster.


Roll back the previously Aborted or Failed NodePool upgrade. This will be an no-op if the last upgrade successfully completed.


Sets the NodeManagement options for a node pool.


Sets labels on a cluster.


Used to set master auth materials. Currently supports :- Changing the admin password of a specific cluster. This can be either via password generation or explicitly set the password.


Start master IP rotation.


Updates the settings of a specific cluster.


Returns configuration info about the Container Engine service.


Cancels the specified operation.


Gets the specified operation.


Lists all operations in a project in a specific zone or all zones.


RollbackNodePoolUpgradeRequest rollbacks the previously Aborted or Failed NodePool upgrade. This will be an no-op if the last upgrade successfully completed.


Container Engine service configuration.


SetLabelsRequest sets the Google Cloud Platform labels on a Google Container Engine cluster, which will in turn set them for Google Compute Engine resources used by that cluster


SetLegacyAbacRequest enables or disables the ABAC authorization mechanism for a cluster.


SetMasterAuthRequest updates the admin password of a cluster.


SetNodePoolManagementRequest sets the node management properties of a node pool.


StartIPRotationRequest creates a new IP for the cluster and then performs a node upgrade on each node pool to point to the new IP.


UpdateClusterRequest updates the settings of a cluster.



Identifies the an OAuth2 authorization scope. A scope is needed when requesting an authorization token.



Identifies types which represent builders for a particular resource method


A trait specifying functionality to help controlling any request performed by the API. The trait has a conservative default implementation.


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.


Identifies types for building methods of a particular resource type


Identifies types which are only used by other types internally. They have no special meaning, this trait just marks them for completeness.


Identifies types which are only used as part of other types, which usually are carrying the Resource trait.


A utility to specify reader types which provide seeking capabilities too


Identifies types which are used in API requests.


Identifies types which can be inserted and deleted. Types with this trait are most commonly used by clients of this API.


Identifies types which are used in API responses.


A trait for all types that can convert themselves into a parts string



Type Definitions


A universal result type used as return for all calls.