Crate google_cloudresourcemanager1_beta1 [] [src]

This documentation was generated from Cloud Resource Manager crate version 1.0.6+20170517, where 20170517 is the exact revision of the cloudresourcemanager:v1beta1 schema built by the mako code generator v1.0.6.

Everything else about the Cloud Resource Manager v1_beta1 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().test_iam_permissions(...).doit()
let r = hub.projects().undelete(...).doit()
let r = hub.projects().set_iam_policy(...).doit()
let r = hub.projects().get(...).doit()
let r = hub.projects().get_ancestry(...).doit()
let r = hub.projects().update(...).doit()
let r = hub.projects().get_iam_policy(...).doit()
let r = hub.projects().delete(...).doit()
let r = hub.projects().create(...).doit()
let r = hub.projects().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.


Setting up your Project

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

google-cloudresourcemanager1_beta1 = "*"

A complete example

extern crate hyper;
extern crate hyper_rustls;
extern crate yup_oauth2 as oauth2;
extern crate google_cloudresourcemanager1_beta1 as cloudresourcemanager1_beta1;
use cloudresourcemanager1_beta1::{Result, Error};
use std::default::Default;
use oauth2::{Authenticator, DefaultAuthenticatorDelegate, ApplicationSecret, MemoryStorage};
use cloudresourcemanager1_beta1::CloudResourceManager;
// 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 = CloudResourceManager::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.projects().list()
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.



Identifying information for a single ancestor of a project.


Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs.


Provides the configuration for logging a type of permissions. Example:


Associates members with a role.


Central instance to access all CloudResourceManager related resource activities


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


The request sent to the GetAncestry method.


Response from the GetAncestry method.


Request message for GetIamPolicy method.


The response returned from the ListOrganizations method.


A page of the response received from the ListProjects method.


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.


The root node in the resource hierarchy to which a particular entity's (e.g., company) resources belong.


Fetches an Organization resource identified by the specified resource name.


Gets the access control policy for an Organization resource. May be empty if no such policy or resource exists. The resource field should be the organization's resource name, e.g. "organizations/123".


Lists Organization resources that are visible to the user and satisfy the specified filter. This method returns Organizations in an unspecified order. New Organizations do not necessarily appear at the end of the list.


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


The entity that owns an Organization. The lifetime of the Organization and all of its descendants are bound to the OrganizationOwner. If the OrganizationOwner is deleted, the Organization and all its descendants will be deleted.


Sets the access control policy on an Organization resource. Replaces any existing policy. The resource field should be the organization's resource name, e.g. "organizations/123".


Returns permissions that a caller has on the specified Organization. The resource field should be the organization's resource name, e.g. "organizations/123".


Updates an Organization resource identified by the specified resource name.


Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources.


A Project is a high-level Google Cloud Platform entity. It is a container for ACLs, APIs, App Engine Apps, VMs, and other Google Cloud Platform resources.


Creates a Project resource.


Marks the Project identified by the specified project_id (for example, my-project-123) for deletion. This method will only affect the Project if the following criteria are met:


Gets a list of ancestors in the resource hierarchy for the Project identified by the specified project_id (for example, my-project-123).


Retrieves the Project identified by the specified project_id (for example, my-project-123).


Returns the IAM access control policy for the specified Project. Permission is denied if the policy or the resource does not exist.


Lists Projects that are visible to the user and satisfy the specified filter. This method returns Projects in an unspecified order. New Projects do not necessarily appear at the end of the list.


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


Sets the IAM access control policy for the specified Project. Replaces any existing policy.


Returns permissions that a caller has on the specified Project.


Restores the Project identified by the specified project_id (for example, my-project-123). You can only use this method for a Project that has a lifecycle state of DELETE_REQUESTED. After deletion starts, the Project cannot be restored.


Updates the attributes of the Project identified by the specified project_id (for example, my-project-123).


A container to reference an id for any resource type. A resource in Google Cloud Platform is a generic term for something you (a developer) may want to interact with through one of our API's. Some examples are an App Engine app, a Compute Engine instance, a Cloud SQL database, and so on.


Request message for SetIamPolicy method.


Request message for TestIamPermissions method.


Response message for TestIamPermissions method.


The request sent to the UndeleteProject method.



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.