Crate google_vault1[][src]

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

Everything else about the Vault 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.matters().holds_delete(...).doit()
let r = hub.matters().holds_list(...).doit()
let r = hub.matters().exports_create(...).doit()
let r = hub.matters().update(...).doit()
let r = hub.matters().holds_get(...).doit()
let r = hub.matters().holds_accounts_list(...).doit()
let r = hub.matters().exports_get(...).doit()
let r = hub.matters().holds_add_held_accounts(...).doit()
let r = hub.matters().undelete(...).doit()
let r = hub.matters().remove_permissions(...).doit()
let r = hub.matters().holds_accounts_delete(...).doit()
let r = hub.matters().add_permissions(...).doit()
let r = hub.matters().holds_update(...).doit()
let r = hub.matters().close(...).doit()
let r = hub.matters().get(...).doit()
let r = hub.matters().holds_create(...).doit()
let r = hub.matters().holds_remove_held_accounts(...).doit()
let r = hub.matters().create(...).doit()
let r = hub.matters().list(...).doit()
let r = hub.matters().reopen(...).doit()
let r = hub.matters().exports_list(...).doit()
let r = hub.matters().exports_delete(...).doit()
let r = hub.matters().holds_accounts_create(...).doit()
let r = hub.matters().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-vault1 = "*"
# This project intentionally uses an old version of Hyper. See
# 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_vault1 as vault1;
use vault1::{Result, Error};
use std::default::Default;
use oauth2::{Authenticator, DefaultAuthenticatorDelegate, ApplicationSecret, MemoryStorage};
use vault1::Vault;
// 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 = Vault::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.matters().holds_list("matterId")
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.



Accounts to search


A status detailing the status of each account creation, and the HeldAccount, if successful.


Add a list of accounts to a hold.


Response for batch create held accounts.


Add an account with the permission specified. The role cannot be owner. If an account already has a role in the matter, it will be overwritten.


Close a matter by ID.


Response to a CloseMatterRequest.


An export file on cloud storage


Export sink for cloud storage files.


Corpus specific queries.


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


The options for Drive export.


Drive search advanced options


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


An export


Export advanced options


Stats of an export.


The options for groups export.


The options for hangouts chat export.


Accounts to search


Hangouts chat search advanced options


An account being held in a particular hold. This structure is immutable. This can be either a single user or a google group, depending on the corpus.


Query options for Drive holds.


Query options for group holds.


Query options for hangouts chat holds.


Query options for mail holds.


A organizational unit being held in a particular hold. This structure is immutable.


Represents a hold within Vault. A hold restricts purging of artifacts based on the combination of the query and accounts restrictions. A hold can be configured to either apply to an explicitly configured set of accounts, or can be applied to all members of an organizational unit.


The holds for a matter.


Returns a list of held accounts for a hold.


The holds for a matter.


Provides the list of matters.


The options for mail export.


Mail search advanced options


Represents a matter.


Adds an account as a matter collaborator.


Closes the specified matter. Returns matter with updated state.


Creates a new matter with the given name and description. The initial state is open, and the owner is the method caller. Returns the created matter with default view.


Deletes the specified matter. Returns matter with updated state.


Creates an Export.


Deletes an Export.


Gets an Export.


Lists Exports.


Gets the specified matter.


Adds a HeldAccount to a hold. Accounts can only be added to a hold that has no held_org_unit set. Attempting to add an account to an OU-based hold will result in an error.


Removes a HeldAccount from a hold. If this request leaves the hold with no held accounts, the hold will not apply to any accounts.


Lists HeldAccounts for a hold. This will only list individually specified held accounts. If the hold is on an OU, then use Admin SDK to enumerate its members.


Adds HeldAccounts to a hold. Returns a list of accounts that have been successfully added. Accounts can only be added to an existing account-based hold.


Creates a hold in the given matter.


Removes a hold by ID. This will release any HeldAccounts on this Hold.


Gets a hold by ID.


Lists holds within a matter. An empty page token in ListHoldsResponse denotes no more holds to list.


Removes HeldAccounts from a hold. Returns a list of statuses in the same order as the request. If this request leaves the hold with no held accounts, the hold will not apply to any accounts.


Updates the OU and/or query parameters of a hold. You cannot add accounts to a hold that covers an OU, nor can you add OUs to a hold that covers individual accounts. Accounts listed in the hold will be ignored.


Lists matters the user has access to.


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


Currently each matter only has one owner, and all others are collaborators. When an account is purged, its corresponding MatterPermission resources cease to exist.


Removes an account as a matter collaborator.


Reopens the specified matter. Returns matter with updated state.


Undeletes the specified matter. Returns matter with updated state.


Updates the specified matter. This updates only the name and description of the matter, identified by matter id. Changes to any other fields are ignored. Returns the default view of the matter.


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.


Org Unit to search


A query definition relevant for search & export.


Remove a list of accounts from a hold.


Response for batch delete held accounts.


Remove an account as a matter collaborator.


Reopen a matter by ID.


Response to a ReopenMatterRequest.


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. The error model is designed to be:


Team Drives to search


Undelete a matter by ID.


User's information.


Central instance to access all Vault related resource activities



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.