X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/d85ee643d632097bfa0afff7b15f3ae534955503..9719c9f35751300cc187f94056f12f66dc3a316a:/README.md diff --git a/README.md b/README.md index fa356923d5..33211c8987 100644 --- a/README.md +++ b/README.md @@ -15,6 +15,10 @@ The Google API Ruby Client makes it trivial to discover and access supported APIs. +## Alpha + +This library is in Alpha. We will make an effort to support the library, but we reserve the right to make incompatible changes when necessary. + ## Install Be sure `https://rubygems.org/` is in your gem sources. @@ -110,6 +114,12 @@ client.execute(...) Service accounts are also used for delegation in Google Apps domains. The target user for impersonation is specified by setting the `:person` parameter to the user's email address in the credentials. Detailed instructions on how to enable delegation for your domain can be found at [developers.google.com](https://developers.google.com/drive/delegation). +### Automatic Retries & Backoff + +The API client can automatically retry requests for recoverable errors. To enable retries, set the `client.retries` property to +the number of additional attempts. To avoid flooding servers, retries invovle a 1 second delay that increases on each subsequent retry. + +The default value for retries is 0, but will be enabled by default in future releases. ### Batching Requests @@ -176,29 +186,9 @@ if upload.resumable? end ``` -## Command Line - -Included with the gem is a command line interface for working with Google APIs. - -```bash -# Log in -google-api oauth-2-login --client-id='...' --client-secret='...' --scope="https://www.googleapis.com/auth/plus.me" - -# List the signed-in user's activities -google-api execute plus.activities.list --api=plus -- userId="me" collection="public" - -# Start an interactive API session -google-api irb ->> plus = $client.discovered_api('plus') ->> $client.execute(plus.activities.list, {'userId' => 'me', 'collection' => 'public'}) -=> # returns a response from the API -``` - -For more information, use `google-api --help` - ## Samples -See the full list of [samples on Google Code](http://code.google.com/p/google-api-ruby-client/source/browse?repo=samples). +See the full list of [samples on Github](https://github.com/google/google-api-ruby-client-samples). ## Support