[][src]Crate google_driveactivity2

This documentation was generated from Drive Activity crate version 1.0.12+20190702, where 20190702 is the exact revision of the driveactivity:v2 schema built by the mako code generator v1.0.12.

Everything else about the Drive Activity 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 ...

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.activity().query(...).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-driveactivity2 = "*"
# 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_driveactivity2 as driveactivity2;
use driveactivity2::QueryDriveActivityRequest;
use driveactivity2::{Result, Error};
use std::default::Default;
use oauth2::{Authenticator, DefaultAuthenticatorDelegate, ApplicationSecret, MemoryStorage};
use driveactivity2::DriveActivityHub;
 
// 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 = DriveActivityHub::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 = QueryDriveActivityRequest::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.activity().query(req)
             .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.

Arguments will always be copied or cloned into the builder, to make them independent of their original life times.

Structs

Action

Information about the action.

ActionDetail

Data describing the type and additional information of an action.

ActivityMethods

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

ActivityQueryCall

Query past activity in Google Drive.

Actor

The actor of a Drive activity.

Administrator

Empty message representing an administrator.

AnonymousUser

Empty message representing an anonymous user or indicating the authenticated user should be anonymized.

Anyone

Represents any user (including a logged out user).

ApplicationReference

Activity in applications other than Drive.

Assignment

A comment with an assignment.

Chunk
Comment

A change about comments on an object.

ConsolidationStrategy

How the individual activities are consolidated. A set of activities may be consolidated into one combined activity if they are related in some way, such as one actor performing the same action on multiple targets, or multiple actors performing the same action on a single target. The strategy defines the rules for which activities are related.

ContentRange

Implements the Content-Range header, for serialization only

Copy

An object was created by copying an existing object.

Create

An object was created.

DataLeakPreventionChange

A change in the object's data leak prevention status.

DefaultDelegate

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

Delete

An object was deleted.

DeletedUser

A user whose account has since been deleted.

Domain

Information about a domain.

Drive

Information about a shared drive.

DriveActivity

A single Drive activity comprising one or more Actions by one or more Actors on one or more Targets. Some Action groupings occur spontaneously, such as moving an item into a shared folder triggering a permission change. Other groupings of related Actions, such as multiple Actors editing one item or moving multiple files into a new folder, are controlled by the selection of a ConsolidationStrategy in the QueryDriveActivityRequest.

DriveActivityHub

Central instance to access all DriveActivityHub related resource activities

DriveFile

A Drive item which is a file.

DriveFolder

A Drive item which is a folder.

DriveItem

A Drive item, such as a file or folder.

DriveItemReference

A lightweight reference to a Drive item, such as a file or folder.

DriveReference

A lightweight reference to a shared drive.

DummyNetworkStream
Edit

An empty message indicating an object was edited.

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

File

This item is deprecated; please see DriveFile instead.

FileComment

A comment on a file.

Folder

This item is deprecated; please see DriveFolder instead.

Group

Information about a group.

Impersonation

Information about an impersonation, where an admin acts on behalf of an end user. Information about the acting admin is not currently available.

JsonServerError

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

KnownUser

A known user.

Legacy

A strategy which consolidates activities using the grouping rules from the legacy V1 Activity API. Similar actions occurring within a window of time can be grouped across multiple targets (such as moving a set of files at once) or multiple actors (such as several users editing the same item). Grouping rules for this strategy are specific to each type of action.

MethodInfo

Contains information about an API request.

Move

An object was moved.

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.

New

An object was created from scratch.

NoConsolidation

A strategy which does no consolidation of individual activities.

Owner

Information about the owner of a Drive item.

Permission

The permission setting of an object.

PermissionChange

A change of the permission setting on an item.

Post

A regular posted comment.

QueryDriveActivityRequest

The request message for querying Drive activity.

QueryDriveActivityResponse

Response message for querying Drive activity.

RangeResponseHeader
Rename

An object was renamed.

Restore

A deleted object was restored.

RestrictionChange

Information about restriction policy changes to a feature.

ResumableUploadHelper

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

ServerError
ServerMessage
SettingsChange

Information about settings changes.

Suggestion

A suggestion.

SystemEvent

Event triggered by system operations instead of end users.

Target

Information about the target of activity.

TargetReference

A lightweight reference to the target of activity.

TeamDrive

This item is deprecated; please see Drive instead.

TeamDriveReference

This item is deprecated; please see DriveReference instead.

TimeRange

Information about time ranges.

UnknownUser

A user about whom nothing is currently known.

Upload

An object was uploaded into Drive.

User

Information about an end user.

XUploadContentType

The X-Upload-Content-Type header.

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

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.