[−][src]Crate google_cloudresourcemanager2
This documentation was generated from Cloud Resource Manager crate version 1.0.10+20190701, where 20190701 is the exact revision of the cloudresourcemanager:v2 schema built by the mako code generator v1.0.10.
Everything else about the Cloud Resource Manager v2 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 ...
- folders
- create, delete, get, get iam policy, list, move, patch, search, set iam policy, test iam permissions and undelete
- operations
- get
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.folders().patch(...).doit() let r = hub.folders().list(...).doit() let r = hub.folders().get_iam_policy(...).doit() let r = hub.folders().get(...).doit() let r = hub.folders().search(...).doit() let r = hub.folders().test_iam_permissions(...).doit() let r = hub.folders().undelete(...).doit() let r = hub.folders().create(...).doit() let r = hub.folders().set_iam_policy(...).doit() let r = hub.folders().move_(...).doit() let r = hub.folders().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-cloudresourcemanager2 = "*"
# 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_cloudresourcemanager2 as cloudresourcemanager2; use cloudresourcemanager2::{Result, Error}; use std::default::Default; use oauth2::{Authenticator, DefaultAuthenticatorDelegate, ApplicationSecret, MemoryStorage}; use cloudresourcemanager2::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, hyper::Client::with_connector(hyper::net::HttpsConnector::new(hyper_rustls::TlsClient::new())), <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.folders().list() .show_deleted(false) .parent("dolores") .page_token("kasd") .page_size(-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.
- 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
| AuditConfig | 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. |
| AuditLogConfig | Provides the configuration for logging a type of permissions. Example: |
| Binding | Associates |
| Chunk | |
| CloudResourceManager | Central instance to access all CloudResourceManager related resource activities |
| 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 |
| Expr | Represents an expression text. Example: |
| Folder | A Folder in an Organization's resource hierarchy, used to organize that Organization's resources. |
| FolderCreateCall | Creates a Folder in the resource hierarchy. Returns an Operation which can be used to track the progress of the folder creation workflow. Upon success the Operation.response field will be populated with the created Folder. |
| FolderDeleteCall | Requests deletion of a Folder. The Folder is moved into the
DELETE_REQUESTED state
immediately, and is deleted approximately 30 days later. This method may
only be called on an empty Folder in the
ACTIVE state, where a Folder is empty if
it doesn't contain any Folders or Projects in the
ACTIVE state.
The caller must have |
| FolderGetCall | Retrieves a Folder identified by the supplied resource name.
Valid Folder resource names have the format |
| FolderGetIamPolicyCall | Gets the access control policy for a Folder. The returned policy may be
empty if no such policy or resource exists. The |
| FolderListCall | Lists the Folders that are direct descendants of supplied parent resource.
List provides a strongly consistent view of the Folders underneath
the specified parent resource.
List returns Folders sorted based upon the (ascending) lexical ordering
of their display_name.
The caller must have |
| FolderMethods | A builder providing access to all methods supported on folder resources.
It is not used directly, but through the |
| FolderMoveCall | Moves a Folder under a new resource parent.
Returns an Operation which can be used to track the progress of the
folder move workflow.
Upon success the Operation.response field will be populated with the
moved Folder.
Upon failure, a FolderOperationError categorizing the failure cause will
be returned - if the failure occurs synchronously then the
FolderOperationError will be returned via the Status.details field
and if it occurs asynchronously then the FolderOperation will be returned
via the Operation.error field.
In addition, the Operation.metadata field will be populated with a
FolderOperation message as an aid to stateless clients.
Folder moves will be rejected if they violate either the naming, height
or fanout constraints described in the
CreateFolder documentation.
The caller must have |
| FolderPatchCall | Updates a Folder, changing its display_name. Changes to the folder display_name will be rejected if they violate either the display_name formatting rules or naming constraints described in the CreateFolder documentation. |
| FolderSearchCall | Search for folders that match specific filter criteria. Search provides an eventually consistent view of the folders a user has access to which meet the specified filter criteria. |
| FolderSetIamPolicyCall | Sets the access control policy on a Folder, replacing any existing policy.
The |
| FolderTestIamPermissionCall | Returns permissions that a caller has on the specified Folder.
The |
| FolderUndeleteCall | Cancels the deletion request for a Folder. This method may only be
called on a Folder in the
DELETE_REQUESTED state.
In order to succeed, the Folder's parent must be in the
ACTIVE state.
In addition, reintroducing the folder into the tree must not violate
folder naming, height and fanout constraints described in the
CreateFolder documentation.
The caller must have |
| GetIamPolicyRequest | Request message for |
| GetPolicyOptions | Encapsulates settings provided to GetIamPolicy. |
| JsonServerError | A utility type which can decode a server response that indicates error |
| ListFoldersResponse | The ListFolders response message. |
| MethodInfo | Contains information about an API request. |
| MoveFolderRequest | The MoveFolder request message. |
| MultiPartReader | Provides a |
| Operation | This resource represents a long-running operation that is the result of a network API call. |
| OperationGetCall | 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. |
| OperationMethods | A builder providing access to all methods supported on operation resources.
It is not used directly, but through the |
| Policy | Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. |
| RangeResponseHeader | |
| ResumableUploadHelper | A utility type to perform a resumable upload from start to end. |
| SearchFoldersRequest | The request message for searching folders. |
| SearchFoldersResponse | The response message for searching folders. |
| ServerError | |
| ServerMessage | |
| SetIamPolicyRequest | Request message for |
| Status | The |
| TestIamPermissionsRequest | Request message for |
| TestIamPermissionsResponse | Response message for |
| UndeleteFolderRequest | The UndeleteFolder request message. |
| XUploadContentType | 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. |