[][src]Crate google_bigqueryreservation1

This documentation was generated from BigQuery Reservation crate version 1.0.14+20200702, where 20200702 is the exact revision of the bigqueryreservation:v1 schema built by the mako code generator v1.0.14.

Everything else about the BigQuery Reservation 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 ...

This example is not tested
let r = hub.projects().locations_capacity_commitments_merge(...).doit()
let r = hub.projects().locations_capacity_commitments_create(...).doit()
let r = hub.projects().locations_capacity_commitments_patch(...).doit()
let r = hub.projects().locations_capacity_commitments_get(...).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-bigqueryreservation1 = "*"
# 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_bigqueryreservation1 as bigqueryreservation1;
use bigqueryreservation1::CapacityCommitment;
use bigqueryreservation1::{Result, Error};
use std::default::Default;
use oauth2::{Authenticator, DefaultAuthenticatorDelegate, ApplicationSecret, MemoryStorage};
use bigqueryreservation1::BigQueryReservation;
// 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 = BigQueryReservation::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 = CapacityCommitment::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().locations_capacity_commitments_create(req, "parent")
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 encodable 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.



A Assignment allows a project to submit jobs of a certain type using slots from the specified reservation.


Represents a BI Reservation.


Central instance to access all BigQueryReservation related resource activities


Capacity commitment is a way to purchase compute capacity for BigQuery jobs (in the form of slots) with some committed period of usage. Annual commitments renew by default. Commitments can be removed after their commitment end time passes.


Implements the Content-Range header, for serialization only


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


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


The response for ReservationService.ListAssignments.


The response for ReservationService.ListCapacityCommitments.


The response message for Operations.ListOperations.


The response for ReservationService.ListReservations.


The request for ReservationService.MergeCapacityCommitments.


Contains information about an API request.


The request for ReservationService.MoveAssignment.


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.


This resource represents a long-running operation that is the result of a network API call.


Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.


Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.


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


Creates a new capacity commitment resource.


Deletes a capacity commitment. Attempting to delete capacity commitment before its commitment_end_time will fail with the error code google.rpc.Code.FAILED_PRECONDITION.


Returns information about the capacity commitment.


Lists all the capacity commitments for the admin project.


Merges capacity commitments of the same plan into a single commitment.


Updates an existing capacity commitment.


Splits capacity commitment to two commitments of the same plan and commitment_end_time.


Retrieves a BI reservation.


Creates an assignment object which allows the given project to submit jobs of a certain type using slots from the specified reservation.


Deletes a assignment. No expansion will happen.


Lists assignments.


Moves an assignment under a new reservation.


Creates a new reservation resource.


Deletes a reservation. Returns google.rpc.Code.FAILED_PRECONDITION when reservation has assignments.


Returns information about the reservation.


Lists all the reservations for the project in the specified location.


Updates an existing reservation resource.


Looks up assignments for a specified resource for a particular region. If the request is about a project:


Looks up assignments for a specified resource for a particular region. If the request is about a project:


Updates a BI reservation.


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


A reservation is a mechanism used to guarantee slots to users.


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


The response for ReservationService.SearchAllAssignments.


The response for ReservationService.SearchAssignments.


The request for ReservationService.SplitCapacityCommitment.


The response for ReservationService.SplitCapacityCommitment.


The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details.


The X-Upload-Content-Type header.



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


Identifies types which are not actually used by the API This might be a bug within the google API schema.



Type Definitions


A universal result type used as return for all calls.