Crate google_cloudbilling1[−][src]

This documentation was generated from Cloudbilling crate version 1.0.8+20180919, where 20180919 is the exact revision of the cloudbilling:v1 schema built by the mako code generator v1.0.8.

Everything else about the Cloudbilling v1 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 ...

billing accounts
create, get, get iam policy, list, patch, projects list, set iam policy and test iam permissions
projects
get billing info and update billing info
services
list and skus 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.billing_accounts().create(...).doit()
let r = hub.billing_accounts().list(...).doit()
let r = hub.billing_accounts().get(...).doit()
let r = hub.billing_accounts().set_iam_policy(...).doit()
let r = hub.billing_accounts().patch(...).doit()
let r = hub.billing_accounts().get_iam_policy(...).doit()
let r = hub.billing_accounts().test_iam_permissions(...).doit()
let r = hub.billing_accounts().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.

Usage

Setting up your Project

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

[dependencies]
google-cloudbilling1 = "*"
# 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_cloudbilling1 as cloudbilling1;
use cloudbilling1::{Result, Error};
use std::default::Default;
use oauth2::{Authenticator, DefaultAuthenticatorDelegate, ApplicationSecret, MemoryStorage};
use cloudbilling1::Cloudbilling;
 
// 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 = Cloudbilling::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.billing_accounts().list()
             .page_token("sed")
             .page_size(-85)
             .filter("dolores")
             .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

AggregationInfo	Represents the aggregation level and interval for pricing of a single SKU.
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:
BillingAccount	A billing account in GCP Console. You can assign a billing account to one or more projects.
BillingAccountCreateCall	Creates a billing account. This method can only be used to create billing subaccounts by GCP resellers. When creating a subaccount, the current authenticated user must have the `billing.accounts.update` IAM permission on the master account, which is typically given to billing account administrators. This method will return an error if the master account has not been provisioned as a reseller account.
BillingAccountGetCall	Gets information about a billing account. The current authenticated user must be a viewer of the billing account.
BillingAccountGetIamPolicyCall	Gets the access control policy for a billing account. The caller must have the `billing.accounts.getIamPolicy` permission on the account, which is often given to billing account viewers.
BillingAccountListCall	Lists the billing accounts that the current authenticated user has permission to view.
BillingAccountMethods	A builder providing access to all methods supported on billingAccount resources. It is not used directly, but through the `Cloudbilling` hub.
BillingAccountPatchCall	Updates a billing account's fields. Currently the only field that can be edited is `display_name`. The current authenticated user must have the `billing.accounts.update` IAM permission, which is typically given to the administrator of the billing account.
BillingAccountProjectListCall	Lists the projects associated with a billing account. The current authenticated user must have the `billing.resourceAssociations.list` IAM permission, which is often given to billing account viewers.
BillingAccountSetIamPolicyCall	Sets the access control policy for a billing account. Replaces any existing policy. The caller must have the `billing.accounts.setIamPolicy` permission on the account, which is often given to billing account administrators.
BillingAccountTestIamPermissionCall	Tests the access control policy for a billing account. This method takes the resource and a set of permissions as input and returns the subset of the input permissions that the caller is allowed for that resource.
Binding	Associates `members` with a `role`.
Category	Represents the category hierarchy of a SKU.
Cloudbilling	Central instance to access all Cloudbilling related resource activities
DefaultDelegate	A delegate with a conservative default implementation, which is used if no other delegate is set.
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:
ListBillingAccountsResponse	Response message for `ListBillingAccounts`.
ListProjectBillingInfoResponse	Request message for `ListProjectBillingInfoResponse`.
ListServicesResponse	Response message for `ListServices`.
ListSkusResponse	Response message for `ListSkus`.
MethodInfo	Contains information about an API request.
Money	Represents an amount of money with its currency type.
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.
Policy	Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources.
PricingExpression	Expresses a mathematical pricing formula. For Example:-
PricingInfo	Represents the pricing information for a SKU at a single point of time.
ProjectBillingInfo	Encapsulation of billing information for a GCP Console project. A project has at most one associated billing account at a time (but a billing account can be assigned to multiple projects).
ProjectGetBillingInfoCall	Gets the billing information for a project. The current authenticated user must have permission to view the project.
ProjectMethods	A builder providing access to all methods supported on project resources. It is not used directly, but through the `Cloudbilling` hub.
ProjectUpdateBillingInfoCall	Sets or updates the billing account associated with a project. You specify the new billing account by setting the `billing_account_name` in the `ProjectBillingInfo` resource to the resource name of a billing account. Associating a project with an open billing account enables billing on the project and allows charges for resource usage. If the project already had a billing account, this method changes the billing account used for resource usage charges.
Service	Encapsulates a single service in Google Cloud Platform.
ServiceListCall	Lists all public cloud services.
ServiceMethods	A builder providing access to all methods supported on service resources. It is not used directly, but through the `Cloudbilling` hub.
ServiceSkuListCall	Lists all publicly available SKUs for a given cloud service.
SetIamPolicyRequest	Request message for `SetIamPolicy` method.
Sku	Encapsulates a single SKU in Google Cloud Platform
TestIamPermissionsRequest	Request message for `TestIamPermissions` method.
TestIamPermissionsResponse	Response message for `TestIamPermissions` method.
TierRate	The price rate indicating starting usage and its corresponding price.

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

Functions

remove_json_null_values

Type Definitions

Result

A universal result type used as return for all calls.