From 34d0a7aad3b139c71b4d0dd7ca4e10c1336ebb8f Mon Sep 17 00:00:00 2001 From: Sebastian Thiel Date: Wed, 8 Apr 2015 17:19:04 +0200 Subject: [PATCH] fix(README): corrected absolute links This only affected links in readme files, not the relative ones in the actual documentation --- gen/adexchangebuyer1d3/README.md | 66 ++--- gen/adexchangeseller2/README.md | 44 ++-- gen/admin1_directory/README.md | 90 +++---- gen/admin1_reports/README.md | 54 ++-- gen/admin2_email_migration/README.md | 42 ++-- gen/adsense1d4/README.md | 70 +++--- gen/adsensehost4d1/README.md | 54 ++-- gen/analytics3/README.md | 48 ++-- gen/androidenterprise1/README.md | 76 +++--- gen/androidpublisher2/README.md | 50 ++-- gen/appsactivity1/README.md | 42 ++-- gen/appstate1/README.md | 40 +-- gen/audit1/README.md | 42 ++-- gen/autoscaler1_beta2/README.md | 48 ++-- gen/bigquery2/README.md | 56 ++--- gen/blogger3/README.md | 68 ++--- gen/books1/README.md | 58 ++--- gen/calendar3/README.md | 84 +++---- gen/civicinfo2/README.md | 46 ++-- gen/cloudlatencytest2/README.md | 40 +-- gen/cloudmonitoring2_beta2/README.md | 48 ++-- gen/cloudsearch1/README.md | 40 +-- gen/compute1/README.md | 142 +++++------ gen/container1_beta1/README.md | 40 +-- gen/content2/README.md | 64 ++--- gen/coordinate1/README.md | 62 ++--- gen/customsearch1/README.md | 40 +-- gen/dataflow1_b4/README.md | 36 +-- gen/datastore1_beta2/README.md | 40 +-- gen/deploymentmanager2_beta1/README.md | 58 ++--- gen/dfareporting2/README.md | 236 +++++++++--------- gen/discovery1/README.md | 40 +-- gen/dns1_beta1/README.md | 54 ++-- gen/doubleclickbidmanager1/README.md | 48 ++-- gen/doubleclicksearch2/README.md | 52 ++-- gen/drive2/README.md | 104 ++++---- gen/fitness1/README.md | 40 +-- gen/freebase1/README.md | 44 ++-- gen/freebase1_sandbox/README.md | 44 ++-- gen/fusiontables2/README.md | 68 ++--- gen/games1/README.md | 84 +++---- .../README.md | 52 ++-- gen/gamesmanagement1_management/README.md | 56 ++--- gen/gan1_beta1/README.md | 62 ++--- gen/genomics1_beta2/README.md | 78 +++--- gen/gmail1/README.md | 52 ++-- gen/groupsmigration1/README.md | 42 ++-- gen/groupssettings1/README.md | 40 +-- gen/identitytoolkit3/README.md | 42 ++-- gen/licensing1/README.md | 42 ++-- gen/logging1_beta3/README.md | 40 +-- gen/manager1_beta2/README.md | 46 ++-- gen/mapsengine1/README.md | 74 +++--- gen/mirror1/README.md | 68 ++--- gen/oauth2_v2/README.md | 44 ++-- gen/pagespeedonline2/README.md | 40 +-- gen/plus1/README.md | 52 ++-- gen/plusdomains1/README.md | 62 ++--- gen/prediction1d6/README.md | 42 ++-- gen/pubsub1_beta2/README.md | 40 +-- gen/qpxexpress1/README.md | 40 +-- gen/replicapool1_beta2/README.md | 44 ++-- gen/replicapoolupdater1_beta1/README.md | 44 ++-- gen/reseller1_sandbox/README.md | 46 ++-- gen/resourceviews1_beta2/README.md | 42 ++-- gen/siteverification1/README.md | 40 +-- gen/spectrum1_explorer/README.md | 40 +-- gen/sqladmin1_beta4/README.md | 68 ++--- gen/storage1/README.md | 76 +++--- gen/tagmanager1/README.md | 42 ++-- gen/taskqueue1_beta2/README.md | 44 ++-- gen/tasks1/README.md | 44 ++-- gen/translate2/README.md | 44 ++-- gen/urlshortener1/README.md | 42 ++-- gen/webfonts1/README.md | 42 ++-- gen/webmasters3/README.md | 46 ++-- gen/youtube3/README.md | 120 ++++----- gen/youtubeanalytics1/README.md | 56 ++--- src/mako/api/lib/lib.mako | 5 +- 79 files changed, 2201 insertions(+), 2200 deletions(-) diff --git a/gen/adexchangebuyer1d3/README.md b/gen/adexchangebuyer1d3/README.md index 7a186b1100..5b1be770e8 100644 --- a/gen/adexchangebuyer1d3/README.md +++ b/gen/adexchangebuyer1d3/README.md @@ -11,22 +11,22 @@ Everything else about the *Ad Exchange Buyer* *v1d3* API can be found at the [official documentation site](https://developers.google.com/ad-exchange/buyer-rest). # Features -Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google-adexchangebuyer1d3/struct.AdExchangeBuyer.html) ... +Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google_adexchangebuyer1d3/struct.AdExchangeBuyer.html) ... -* [accounts](http://byron.github.io/google-apis-rs/google-adexchangebuyer1d3/struct.Account.html) - * [*get*](http://byron.github.io/google-apis-rs/google-adexchangebuyer1d3/struct.AccountGetCall.html), [*list*](http://byron.github.io/google-apis-rs/google-adexchangebuyer1d3/struct.AccountListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google-adexchangebuyer1d3/struct.AccountPatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google-adexchangebuyer1d3/struct.AccountUpdateCall.html) -* [billing info](http://byron.github.io/google-apis-rs/google-adexchangebuyer1d3/struct.BillingInfo.html) - * [*get*](http://byron.github.io/google-apis-rs/google-adexchangebuyer1d3/struct.BillingInfoGetCall.html) and [*list*](http://byron.github.io/google-apis-rs/google-adexchangebuyer1d3/struct.BillingInfoListCall.html) -* [budget](http://byron.github.io/google-apis-rs/google-adexchangebuyer1d3/struct.Budget.html) - * [*get*](http://byron.github.io/google-apis-rs/google-adexchangebuyer1d3/struct.BudgetGetCall.html), [*patch*](http://byron.github.io/google-apis-rs/google-adexchangebuyer1d3/struct.BudgetPatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google-adexchangebuyer1d3/struct.BudgetUpdateCall.html) -* [creatives](http://byron.github.io/google-apis-rs/google-adexchangebuyer1d3/struct.Creative.html) - * [*get*](http://byron.github.io/google-apis-rs/google-adexchangebuyer1d3/struct.CreativeGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google-adexchangebuyer1d3/struct.CreativeInsertCall.html) and [*list*](http://byron.github.io/google-apis-rs/google-adexchangebuyer1d3/struct.CreativeListCall.html) -* [direct deals](http://byron.github.io/google-apis-rs/google-adexchangebuyer1d3/struct.DirectDeal.html) - * [*get*](http://byron.github.io/google-apis-rs/google-adexchangebuyer1d3/struct.DirectDealGetCall.html) and [*list*](http://byron.github.io/google-apis-rs/google-adexchangebuyer1d3/struct.DirectDealListCall.html) -* [performance report](http://byron.github.io/google-apis-rs/google-adexchangebuyer1d3/struct.PerformanceReport.html) - * [*list*](http://byron.github.io/google-apis-rs/google-adexchangebuyer1d3/struct.PerformanceReportListCall.html) -* [pretargeting config](http://byron.github.io/google-apis-rs/google-adexchangebuyer1d3/struct.PretargetingConfig.html) - * [*delete*](http://byron.github.io/google-apis-rs/google-adexchangebuyer1d3/struct.PretargetingConfigDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google-adexchangebuyer1d3/struct.PretargetingConfigGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google-adexchangebuyer1d3/struct.PretargetingConfigInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google-adexchangebuyer1d3/struct.PretargetingConfigListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google-adexchangebuyer1d3/struct.PretargetingConfigPatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google-adexchangebuyer1d3/struct.PretargetingConfigUpdateCall.html) +* [accounts](http://byron.github.io/google-apis-rs/google_adexchangebuyer1d3/struct.Account.html) + * [*get*](http://byron.github.io/google-apis-rs/google_adexchangebuyer1d3/struct.AccountGetCall.html), [*list*](http://byron.github.io/google-apis-rs/google_adexchangebuyer1d3/struct.AccountListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google_adexchangebuyer1d3/struct.AccountPatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google_adexchangebuyer1d3/struct.AccountUpdateCall.html) +* [billing info](http://byron.github.io/google-apis-rs/google_adexchangebuyer1d3/struct.BillingInfo.html) + * [*get*](http://byron.github.io/google-apis-rs/google_adexchangebuyer1d3/struct.BillingInfoGetCall.html) and [*list*](http://byron.github.io/google-apis-rs/google_adexchangebuyer1d3/struct.BillingInfoListCall.html) +* [budget](http://byron.github.io/google-apis-rs/google_adexchangebuyer1d3/struct.Budget.html) + * [*get*](http://byron.github.io/google-apis-rs/google_adexchangebuyer1d3/struct.BudgetGetCall.html), [*patch*](http://byron.github.io/google-apis-rs/google_adexchangebuyer1d3/struct.BudgetPatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google_adexchangebuyer1d3/struct.BudgetUpdateCall.html) +* [creatives](http://byron.github.io/google-apis-rs/google_adexchangebuyer1d3/struct.Creative.html) + * [*get*](http://byron.github.io/google-apis-rs/google_adexchangebuyer1d3/struct.CreativeGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google_adexchangebuyer1d3/struct.CreativeInsertCall.html) and [*list*](http://byron.github.io/google-apis-rs/google_adexchangebuyer1d3/struct.CreativeListCall.html) +* [direct deals](http://byron.github.io/google-apis-rs/google_adexchangebuyer1d3/struct.DirectDeal.html) + * [*get*](http://byron.github.io/google-apis-rs/google_adexchangebuyer1d3/struct.DirectDealGetCall.html) and [*list*](http://byron.github.io/google-apis-rs/google_adexchangebuyer1d3/struct.DirectDealListCall.html) +* [performance report](http://byron.github.io/google-apis-rs/google_adexchangebuyer1d3/struct.PerformanceReport.html) + * [*list*](http://byron.github.io/google-apis-rs/google_adexchangebuyer1d3/struct.PerformanceReportListCall.html) +* [pretargeting config](http://byron.github.io/google-apis-rs/google_adexchangebuyer1d3/struct.PretargetingConfig.html) + * [*delete*](http://byron.github.io/google-apis-rs/google_adexchangebuyer1d3/struct.PretargetingConfigDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google_adexchangebuyer1d3/struct.PretargetingConfigGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google_adexchangebuyer1d3/struct.PretargetingConfigInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google_adexchangebuyer1d3/struct.PretargetingConfigListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google_adexchangebuyer1d3/struct.PretargetingConfigPatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google_adexchangebuyer1d3/struct.PretargetingConfigUpdateCall.html) @@ -35,17 +35,17 @@ Handle the following *Resources* with ease from the central [hub](http://byron.g The API is structured into the following primary items: -* **[Hub](http://byron.github.io/google-apis-rs/google-adexchangebuyer1d3/struct.AdExchangeBuyer.html)** +* **[Hub](http://byron.github.io/google-apis-rs/google_adexchangebuyer1d3/struct.AdExchangeBuyer.html)** * a central object to maintain state and allow accessing all *Activities* - * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google-adexchangebuyer1d3/trait.MethodsBuilder.html) which in turn - allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google-adexchangebuyer1d3/trait.CallBuilder.html) -* **[Resources](http://byron.github.io/google-apis-rs/google-adexchangebuyer1d3/trait.Resource.html)** + * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google_adexchangebuyer1d3/trait.MethodsBuilder.html) which in turn + allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google_adexchangebuyer1d3/trait.CallBuilder.html) +* **[Resources](http://byron.github.io/google-apis-rs/google_adexchangebuyer1d3/trait.Resource.html)** * primary types that you can apply *Activities* to * a collection of properties and *Parts* - * **[Parts](http://byron.github.io/google-apis-rs/google-adexchangebuyer1d3/trait.Part.html)** + * **[Parts](http://byron.github.io/google-apis-rs/google_adexchangebuyer1d3/trait.Part.html)** * a collection of properties * never directly used in *Activities* -* **[Activities](http://byron.github.io/google-apis-rs/google-adexchangebuyer1d3/trait.CallBuilder.html)** +* **[Activities](http://byron.github.io/google-apis-rs/google_adexchangebuyer1d3/trait.CallBuilder.html)** * operations to apply to *Resources* All *structures* are marked with applicable traits to further categorize them and ease browsing. @@ -133,17 +133,17 @@ match result { ``` ## Handling Errors -All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google-adexchangebuyer1d3/enum.Result.html) enumeration as return value of +All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google_adexchangebuyer1d3/enum.Result.html) enumeration as return value of the doit() methods, or handed as possibly intermediate results to either the -[Hub Delegate](http://byron.github.io/google-apis-rs/google-adexchangebuyer1d3/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google-adexchangebuyer1d3/../yup-oauth2/trait.AuthenticatorDelegate.html). +[Hub Delegate](http://byron.github.io/google-apis-rs/google_adexchangebuyer1d3/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google_adexchangebuyer1d3/../yup-oauth2/trait.AuthenticatorDelegate.html). 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](http://byron.github.io/google-apis-rs/google-adexchangebuyer1d3/enum.Result.html), should be +If a method supports downloads, the response body, which is part of the [Result](http://byron.github.io/google-apis-rs/google_adexchangebuyer1d3/enum.Result.html), should be read by you to obtain the media. -If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google-adexchangebuyer1d3/trait.ResponseResult.html), it will return that by default. +If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google_adexchangebuyer1d3/trait.ResponseResult.html), 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")`. @@ -153,29 +153,29 @@ Methods supporting uploads can do so using up to 2 different protocols: ## Customization and Callbacks -You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google-adexchangebuyer1d3/trait.Delegate.html) to the -[Method Builder](http://byron.github.io/google-apis-rs/google-adexchangebuyer1d3/trait.CallBuilder.html) before making the final `doit()` call. +You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google_adexchangebuyer1d3/trait.Delegate.html) to the +[Method Builder](http://byron.github.io/google-apis-rs/google_adexchangebuyer1d3/trait.CallBuilder.html) 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](http://byron.github.io/google-apis-rs/google-adexchangebuyer1d3/trait.Delegate.html) is default-implemented, allowing you to customize it with minimal effort. +The [delegate trait](http://byron.github.io/google-apis-rs/google_adexchangebuyer1d3/trait.Delegate.html) 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](http://byron.github.io/google-apis-rs/google-adexchangebuyer1d3/trait.RequestValue.html) and -[decodable](http://byron.github.io/google-apis-rs/google-adexchangebuyer1d3/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses +All structures provided by this library are made to be [enocodable](http://byron.github.io/google-apis-rs/google_adexchangebuyer1d3/trait.RequestValue.html) and +[decodable](http://byron.github.io/google-apis-rs/google_adexchangebuyer1d3/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses are valid. -Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google-adexchangebuyer1d3/trait.Part.html) which are identifiable by name, which will be sent to +Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google_adexchangebuyer1d3/trait.Part.html) 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](http://byron.github.io/google-apis-rs/google-adexchangebuyer1d3/trait.CallBuilder.html), you are able to prepare an action call by repeatedly calling it's methods. +Using [method builders](http://byron.github.io/google-apis-rs/google_adexchangebuyer1d3/trait.CallBuilder.html), 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][wiki-pod] are handed by copy * strings are passed as `&str` -* [request values](http://byron.github.io/google-apis-rs/google-adexchangebuyer1d3/trait.RequestValue.html) are borrowed +* [request values](http://byron.github.io/google-apis-rs/google_adexchangebuyer1d3/trait.RequestValue.html) are borrowed Arguments will always be copied or cloned into the builder, to make them independent of their original life times. diff --git a/gen/adexchangeseller2/README.md b/gen/adexchangeseller2/README.md index 56eb6960e8..b5d814df80 100644 --- a/gen/adexchangeseller2/README.md +++ b/gen/adexchangeseller2/README.md @@ -11,15 +11,15 @@ Everything else about the *Ad Exchange Seller* *v2* API can be found at the [official documentation site](https://developers.google.com/ad-exchange/seller-rest/). # Features -Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google-adexchangeseller2/struct.AdExchangeSeller.html) ... +Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google_adexchangeseller2/struct.AdExchangeSeller.html) ... -* [accounts](http://byron.github.io/google-apis-rs/google-adexchangeseller2/struct.Account.html) - * [*adclients list*](http://byron.github.io/google-apis-rs/google-adexchangeseller2/struct.AccountAdclientListCall.html), [*alerts list*](http://byron.github.io/google-apis-rs/google-adexchangeseller2/struct.AccountAlertListCall.html), [*customchannels get*](http://byron.github.io/google-apis-rs/google-adexchangeseller2/struct.AccountCustomchannelGetCall.html), [*customchannels list*](http://byron.github.io/google-apis-rs/google-adexchangeseller2/struct.AccountCustomchannelListCall.html), [*get*](http://byron.github.io/google-apis-rs/google-adexchangeseller2/struct.AccountGetCall.html), [*list*](http://byron.github.io/google-apis-rs/google-adexchangeseller2/struct.AccountListCall.html), [*metadata dimensions list*](http://byron.github.io/google-apis-rs/google-adexchangeseller2/struct.AccountMetadataDimensionListCall.html), [*metadata metrics list*](http://byron.github.io/google-apis-rs/google-adexchangeseller2/struct.AccountMetadataMetricListCall.html), [*preferreddeals get*](http://byron.github.io/google-apis-rs/google-adexchangeseller2/struct.AccountPreferreddealGetCall.html), [*preferreddeals list*](http://byron.github.io/google-apis-rs/google-adexchangeseller2/struct.AccountPreferreddealListCall.html), [*reports generate*](http://byron.github.io/google-apis-rs/google-adexchangeseller2/struct.AccountReportGenerateCall.html), [*reports saved generate*](http://byron.github.io/google-apis-rs/google-adexchangeseller2/struct.AccountReportSavedGenerateCall.html), [*reports saved list*](http://byron.github.io/google-apis-rs/google-adexchangeseller2/struct.AccountReportSavedListCall.html) and [*urlchannels list*](http://byron.github.io/google-apis-rs/google-adexchangeseller2/struct.AccountUrlchannelListCall.html) +* [accounts](http://byron.github.io/google-apis-rs/google_adexchangeseller2/struct.Account.html) + * [*adclients list*](http://byron.github.io/google-apis-rs/google_adexchangeseller2/struct.AccountAdclientListCall.html), [*alerts list*](http://byron.github.io/google-apis-rs/google_adexchangeseller2/struct.AccountAlertListCall.html), [*customchannels get*](http://byron.github.io/google-apis-rs/google_adexchangeseller2/struct.AccountCustomchannelGetCall.html), [*customchannels list*](http://byron.github.io/google-apis-rs/google_adexchangeseller2/struct.AccountCustomchannelListCall.html), [*get*](http://byron.github.io/google-apis-rs/google_adexchangeseller2/struct.AccountGetCall.html), [*list*](http://byron.github.io/google-apis-rs/google_adexchangeseller2/struct.AccountListCall.html), [*metadata dimensions list*](http://byron.github.io/google-apis-rs/google_adexchangeseller2/struct.AccountMetadataDimensionListCall.html), [*metadata metrics list*](http://byron.github.io/google-apis-rs/google_adexchangeseller2/struct.AccountMetadataMetricListCall.html), [*preferreddeals get*](http://byron.github.io/google-apis-rs/google_adexchangeseller2/struct.AccountPreferreddealGetCall.html), [*preferreddeals list*](http://byron.github.io/google-apis-rs/google_adexchangeseller2/struct.AccountPreferreddealListCall.html), [*reports generate*](http://byron.github.io/google-apis-rs/google_adexchangeseller2/struct.AccountReportGenerateCall.html), [*reports saved generate*](http://byron.github.io/google-apis-rs/google_adexchangeseller2/struct.AccountReportSavedGenerateCall.html), [*reports saved list*](http://byron.github.io/google-apis-rs/google_adexchangeseller2/struct.AccountReportSavedListCall.html) and [*urlchannels list*](http://byron.github.io/google-apis-rs/google_adexchangeseller2/struct.AccountUrlchannelListCall.html) Download supported by ... -* [*reports generate accounts*](http://byron.github.io/google-apis-rs/google-adexchangeseller2/struct.AccountReportGenerateCall.html) +* [*reports generate accounts*](http://byron.github.io/google-apis-rs/google_adexchangeseller2/struct.AccountReportGenerateCall.html) @@ -27,17 +27,17 @@ Download supported by ... The API is structured into the following primary items: -* **[Hub](http://byron.github.io/google-apis-rs/google-adexchangeseller2/struct.AdExchangeSeller.html)** +* **[Hub](http://byron.github.io/google-apis-rs/google_adexchangeseller2/struct.AdExchangeSeller.html)** * a central object to maintain state and allow accessing all *Activities* - * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google-adexchangeseller2/trait.MethodsBuilder.html) which in turn - allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google-adexchangeseller2/trait.CallBuilder.html) -* **[Resources](http://byron.github.io/google-apis-rs/google-adexchangeseller2/trait.Resource.html)** + * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google_adexchangeseller2/trait.MethodsBuilder.html) which in turn + allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google_adexchangeseller2/trait.CallBuilder.html) +* **[Resources](http://byron.github.io/google-apis-rs/google_adexchangeseller2/trait.Resource.html)** * primary types that you can apply *Activities* to * a collection of properties and *Parts* - * **[Parts](http://byron.github.io/google-apis-rs/google-adexchangeseller2/trait.Part.html)** + * **[Parts](http://byron.github.io/google-apis-rs/google_adexchangeseller2/trait.Part.html)** * a collection of properties * never directly used in *Activities* -* **[Activities](http://byron.github.io/google-apis-rs/google-adexchangeseller2/trait.CallBuilder.html)** +* **[Activities](http://byron.github.io/google-apis-rs/google_adexchangeseller2/trait.CallBuilder.html)** * operations to apply to *Resources* All *structures* are marked with applicable traits to further categorize them and ease browsing. @@ -136,17 +136,17 @@ match result { ``` ## Handling Errors -All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google-adexchangeseller2/enum.Result.html) enumeration as return value of +All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google_adexchangeseller2/enum.Result.html) enumeration as return value of the doit() methods, or handed as possibly intermediate results to either the -[Hub Delegate](http://byron.github.io/google-apis-rs/google-adexchangeseller2/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google-adexchangeseller2/../yup-oauth2/trait.AuthenticatorDelegate.html). +[Hub Delegate](http://byron.github.io/google-apis-rs/google_adexchangeseller2/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google_adexchangeseller2/../yup-oauth2/trait.AuthenticatorDelegate.html). 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](http://byron.github.io/google-apis-rs/google-adexchangeseller2/enum.Result.html), should be +If a method supports downloads, the response body, which is part of the [Result](http://byron.github.io/google-apis-rs/google_adexchangeseller2/enum.Result.html), should be read by you to obtain the media. -If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google-adexchangeseller2/trait.ResponseResult.html), it will return that by default. +If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google_adexchangeseller2/trait.ResponseResult.html), 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")`. @@ -156,29 +156,29 @@ Methods supporting uploads can do so using up to 2 different protocols: ## Customization and Callbacks -You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google-adexchangeseller2/trait.Delegate.html) to the -[Method Builder](http://byron.github.io/google-apis-rs/google-adexchangeseller2/trait.CallBuilder.html) before making the final `doit()` call. +You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google_adexchangeseller2/trait.Delegate.html) to the +[Method Builder](http://byron.github.io/google-apis-rs/google_adexchangeseller2/trait.CallBuilder.html) 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](http://byron.github.io/google-apis-rs/google-adexchangeseller2/trait.Delegate.html) is default-implemented, allowing you to customize it with minimal effort. +The [delegate trait](http://byron.github.io/google-apis-rs/google_adexchangeseller2/trait.Delegate.html) 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](http://byron.github.io/google-apis-rs/google-adexchangeseller2/trait.RequestValue.html) and -[decodable](http://byron.github.io/google-apis-rs/google-adexchangeseller2/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses +All structures provided by this library are made to be [enocodable](http://byron.github.io/google-apis-rs/google_adexchangeseller2/trait.RequestValue.html) and +[decodable](http://byron.github.io/google-apis-rs/google_adexchangeseller2/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses are valid. -Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google-adexchangeseller2/trait.Part.html) which are identifiable by name, which will be sent to +Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google_adexchangeseller2/trait.Part.html) 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](http://byron.github.io/google-apis-rs/google-adexchangeseller2/trait.CallBuilder.html), you are able to prepare an action call by repeatedly calling it's methods. +Using [method builders](http://byron.github.io/google-apis-rs/google_adexchangeseller2/trait.CallBuilder.html), 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][wiki-pod] are handed by copy * strings are passed as `&str` -* [request values](http://byron.github.io/google-apis-rs/google-adexchangeseller2/trait.RequestValue.html) are borrowed +* [request values](http://byron.github.io/google-apis-rs/google_adexchangeseller2/trait.RequestValue.html) are borrowed Arguments will always be copied or cloned into the builder, to make them independent of their original life times. diff --git a/gen/admin1_directory/README.md b/gen/admin1_directory/README.md index 7956c60d68..a5335cd682 100644 --- a/gen/admin1_directory/README.md +++ b/gen/admin1_directory/README.md @@ -11,41 +11,41 @@ Everything else about the *directory* *v1_directory* API can be found at the [official documentation site](https://developers.google.com/admin-sdk/directory/). # Features -Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google-admin1_directory/struct.Directory.html) ... +Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google_admin1_directory/struct.Directory.html) ... -* [asps](http://byron.github.io/google-apis-rs/google-admin1_directory/struct.Asp.html) - * [*delete*](http://byron.github.io/google-apis-rs/google-admin1_directory/struct.AspDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google-admin1_directory/struct.AspGetCall.html) and [*list*](http://byron.github.io/google-apis-rs/google-admin1_directory/struct.AspListCall.html) -* [channels](http://byron.github.io/google-apis-rs/google-admin1_directory/struct.Channel.html) - * [*stop*](http://byron.github.io/google-apis-rs/google-admin1_directory/struct.ChannelStopCall.html) +* [asps](http://byron.github.io/google-apis-rs/google_admin1_directory/struct.Asp.html) + * [*delete*](http://byron.github.io/google-apis-rs/google_admin1_directory/struct.AspDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google_admin1_directory/struct.AspGetCall.html) and [*list*](http://byron.github.io/google-apis-rs/google_admin1_directory/struct.AspListCall.html) +* [channels](http://byron.github.io/google-apis-rs/google_admin1_directory/struct.Channel.html) + * [*stop*](http://byron.github.io/google-apis-rs/google_admin1_directory/struct.ChannelStopCall.html) * chromeosdevices - * [*get*](http://byron.github.io/google-apis-rs/google-admin1_directory/struct.ChromeosdeviceGetCall.html), [*list*](http://byron.github.io/google-apis-rs/google-admin1_directory/struct.ChromeosdeviceListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google-admin1_directory/struct.ChromeosdevicePatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google-admin1_directory/struct.ChromeosdeviceUpdateCall.html) -* [groups](http://byron.github.io/google-apis-rs/google-admin1_directory/struct.Group.html) - * [*aliases delete*](http://byron.github.io/google-apis-rs/google-admin1_directory/struct.GroupAliaseDeleteCall.html), [*aliases insert*](http://byron.github.io/google-apis-rs/google-admin1_directory/struct.GroupAliaseInsertCall.html), [*aliases list*](http://byron.github.io/google-apis-rs/google-admin1_directory/struct.GroupAliaseListCall.html), [*delete*](http://byron.github.io/google-apis-rs/google-admin1_directory/struct.GroupDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google-admin1_directory/struct.GroupGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google-admin1_directory/struct.GroupInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google-admin1_directory/struct.GroupListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google-admin1_directory/struct.GroupPatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google-admin1_directory/struct.GroupUpdateCall.html) -* [members](http://byron.github.io/google-apis-rs/google-admin1_directory/struct.Member.html) - * [*delete*](http://byron.github.io/google-apis-rs/google-admin1_directory/struct.MemberDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google-admin1_directory/struct.MemberGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google-admin1_directory/struct.MemberInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google-admin1_directory/struct.MemberListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google-admin1_directory/struct.MemberPatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google-admin1_directory/struct.MemberUpdateCall.html) + * [*get*](http://byron.github.io/google-apis-rs/google_admin1_directory/struct.ChromeosdeviceGetCall.html), [*list*](http://byron.github.io/google-apis-rs/google_admin1_directory/struct.ChromeosdeviceListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google_admin1_directory/struct.ChromeosdevicePatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google_admin1_directory/struct.ChromeosdeviceUpdateCall.html) +* [groups](http://byron.github.io/google-apis-rs/google_admin1_directory/struct.Group.html) + * [*aliases delete*](http://byron.github.io/google-apis-rs/google_admin1_directory/struct.GroupAliaseDeleteCall.html), [*aliases insert*](http://byron.github.io/google-apis-rs/google_admin1_directory/struct.GroupAliaseInsertCall.html), [*aliases list*](http://byron.github.io/google-apis-rs/google_admin1_directory/struct.GroupAliaseListCall.html), [*delete*](http://byron.github.io/google-apis-rs/google_admin1_directory/struct.GroupDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google_admin1_directory/struct.GroupGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google_admin1_directory/struct.GroupInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google_admin1_directory/struct.GroupListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google_admin1_directory/struct.GroupPatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google_admin1_directory/struct.GroupUpdateCall.html) +* [members](http://byron.github.io/google-apis-rs/google_admin1_directory/struct.Member.html) + * [*delete*](http://byron.github.io/google-apis-rs/google_admin1_directory/struct.MemberDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google_admin1_directory/struct.MemberGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google_admin1_directory/struct.MemberInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google_admin1_directory/struct.MemberListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google_admin1_directory/struct.MemberPatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google_admin1_directory/struct.MemberUpdateCall.html) * mobiledevices - * [*action*](http://byron.github.io/google-apis-rs/google-admin1_directory/struct.MobiledeviceActionCall.html), [*delete*](http://byron.github.io/google-apis-rs/google-admin1_directory/struct.MobiledeviceDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google-admin1_directory/struct.MobiledeviceGetCall.html) and [*list*](http://byron.github.io/google-apis-rs/google-admin1_directory/struct.MobiledeviceListCall.html) -* [notifications](http://byron.github.io/google-apis-rs/google-admin1_directory/struct.Notification.html) - * [*delete*](http://byron.github.io/google-apis-rs/google-admin1_directory/struct.NotificationDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google-admin1_directory/struct.NotificationGetCall.html), [*list*](http://byron.github.io/google-apis-rs/google-admin1_directory/struct.NotificationListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google-admin1_directory/struct.NotificationPatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google-admin1_directory/struct.NotificationUpdateCall.html) + * [*action*](http://byron.github.io/google-apis-rs/google_admin1_directory/struct.MobiledeviceActionCall.html), [*delete*](http://byron.github.io/google-apis-rs/google_admin1_directory/struct.MobiledeviceDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google_admin1_directory/struct.MobiledeviceGetCall.html) and [*list*](http://byron.github.io/google-apis-rs/google_admin1_directory/struct.MobiledeviceListCall.html) +* [notifications](http://byron.github.io/google-apis-rs/google_admin1_directory/struct.Notification.html) + * [*delete*](http://byron.github.io/google-apis-rs/google_admin1_directory/struct.NotificationDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google_admin1_directory/struct.NotificationGetCall.html), [*list*](http://byron.github.io/google-apis-rs/google_admin1_directory/struct.NotificationListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google_admin1_directory/struct.NotificationPatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google_admin1_directory/struct.NotificationUpdateCall.html) * orgunits - * [*delete*](http://byron.github.io/google-apis-rs/google-admin1_directory/struct.OrgunitDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google-admin1_directory/struct.OrgunitGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google-admin1_directory/struct.OrgunitInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google-admin1_directory/struct.OrgunitListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google-admin1_directory/struct.OrgunitPatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google-admin1_directory/struct.OrgunitUpdateCall.html) -* [schemas](http://byron.github.io/google-apis-rs/google-admin1_directory/struct.Schema.html) - * [*delete*](http://byron.github.io/google-apis-rs/google-admin1_directory/struct.SchemaDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google-admin1_directory/struct.SchemaGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google-admin1_directory/struct.SchemaInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google-admin1_directory/struct.SchemaListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google-admin1_directory/struct.SchemaPatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google-admin1_directory/struct.SchemaUpdateCall.html) -* [tokens](http://byron.github.io/google-apis-rs/google-admin1_directory/struct.Token.html) - * [*delete*](http://byron.github.io/google-apis-rs/google-admin1_directory/struct.TokenDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google-admin1_directory/struct.TokenGetCall.html) and [*list*](http://byron.github.io/google-apis-rs/google-admin1_directory/struct.TokenListCall.html) -* [users](http://byron.github.io/google-apis-rs/google-admin1_directory/struct.User.html) - * [*aliases delete*](http://byron.github.io/google-apis-rs/google-admin1_directory/struct.UserAliaseDeleteCall.html), [*aliases insert*](http://byron.github.io/google-apis-rs/google-admin1_directory/struct.UserAliaseInsertCall.html), [*aliases list*](http://byron.github.io/google-apis-rs/google-admin1_directory/struct.UserAliaseListCall.html), [*aliases watch*](http://byron.github.io/google-apis-rs/google-admin1_directory/struct.UserAliaseWatchCall.html), [*delete*](http://byron.github.io/google-apis-rs/google-admin1_directory/struct.UserDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google-admin1_directory/struct.UserGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google-admin1_directory/struct.UserInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google-admin1_directory/struct.UserListCall.html), [*make admin*](http://byron.github.io/google-apis-rs/google-admin1_directory/struct.UserMakeAdminCall.html), [*patch*](http://byron.github.io/google-apis-rs/google-admin1_directory/struct.UserPatchCall.html), [*photos delete*](http://byron.github.io/google-apis-rs/google-admin1_directory/struct.UserPhotoDeleteCall.html), [*photos get*](http://byron.github.io/google-apis-rs/google-admin1_directory/struct.UserPhotoGetCall.html), [*photos patch*](http://byron.github.io/google-apis-rs/google-admin1_directory/struct.UserPhotoPatchCall.html), [*photos update*](http://byron.github.io/google-apis-rs/google-admin1_directory/struct.UserPhotoUpdateCall.html), [*undelete*](http://byron.github.io/google-apis-rs/google-admin1_directory/struct.UserUndeleteCall.html), [*update*](http://byron.github.io/google-apis-rs/google-admin1_directory/struct.UserUpdateCall.html) and [*watch*](http://byron.github.io/google-apis-rs/google-admin1_directory/struct.UserWatchCall.html) -* [verification codes](http://byron.github.io/google-apis-rs/google-admin1_directory/struct.VerificationCode.html) - * [*generate*](http://byron.github.io/google-apis-rs/google-admin1_directory/struct.VerificationCodeGenerateCall.html), [*invalidate*](http://byron.github.io/google-apis-rs/google-admin1_directory/struct.VerificationCodeInvalidateCall.html) and [*list*](http://byron.github.io/google-apis-rs/google-admin1_directory/struct.VerificationCodeListCall.html) + * [*delete*](http://byron.github.io/google-apis-rs/google_admin1_directory/struct.OrgunitDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google_admin1_directory/struct.OrgunitGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google_admin1_directory/struct.OrgunitInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google_admin1_directory/struct.OrgunitListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google_admin1_directory/struct.OrgunitPatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google_admin1_directory/struct.OrgunitUpdateCall.html) +* [schemas](http://byron.github.io/google-apis-rs/google_admin1_directory/struct.Schema.html) + * [*delete*](http://byron.github.io/google-apis-rs/google_admin1_directory/struct.SchemaDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google_admin1_directory/struct.SchemaGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google_admin1_directory/struct.SchemaInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google_admin1_directory/struct.SchemaListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google_admin1_directory/struct.SchemaPatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google_admin1_directory/struct.SchemaUpdateCall.html) +* [tokens](http://byron.github.io/google-apis-rs/google_admin1_directory/struct.Token.html) + * [*delete*](http://byron.github.io/google-apis-rs/google_admin1_directory/struct.TokenDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google_admin1_directory/struct.TokenGetCall.html) and [*list*](http://byron.github.io/google-apis-rs/google_admin1_directory/struct.TokenListCall.html) +* [users](http://byron.github.io/google-apis-rs/google_admin1_directory/struct.User.html) + * [*aliases delete*](http://byron.github.io/google-apis-rs/google_admin1_directory/struct.UserAliaseDeleteCall.html), [*aliases insert*](http://byron.github.io/google-apis-rs/google_admin1_directory/struct.UserAliaseInsertCall.html), [*aliases list*](http://byron.github.io/google-apis-rs/google_admin1_directory/struct.UserAliaseListCall.html), [*aliases watch*](http://byron.github.io/google-apis-rs/google_admin1_directory/struct.UserAliaseWatchCall.html), [*delete*](http://byron.github.io/google-apis-rs/google_admin1_directory/struct.UserDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google_admin1_directory/struct.UserGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google_admin1_directory/struct.UserInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google_admin1_directory/struct.UserListCall.html), [*make admin*](http://byron.github.io/google-apis-rs/google_admin1_directory/struct.UserMakeAdminCall.html), [*patch*](http://byron.github.io/google-apis-rs/google_admin1_directory/struct.UserPatchCall.html), [*photos delete*](http://byron.github.io/google-apis-rs/google_admin1_directory/struct.UserPhotoDeleteCall.html), [*photos get*](http://byron.github.io/google-apis-rs/google_admin1_directory/struct.UserPhotoGetCall.html), [*photos patch*](http://byron.github.io/google-apis-rs/google_admin1_directory/struct.UserPhotoPatchCall.html), [*photos update*](http://byron.github.io/google-apis-rs/google_admin1_directory/struct.UserPhotoUpdateCall.html), [*undelete*](http://byron.github.io/google-apis-rs/google_admin1_directory/struct.UserUndeleteCall.html), [*update*](http://byron.github.io/google-apis-rs/google_admin1_directory/struct.UserUpdateCall.html) and [*watch*](http://byron.github.io/google-apis-rs/google_admin1_directory/struct.UserWatchCall.html) +* [verification codes](http://byron.github.io/google-apis-rs/google_admin1_directory/struct.VerificationCode.html) + * [*generate*](http://byron.github.io/google-apis-rs/google_admin1_directory/struct.VerificationCodeGenerateCall.html), [*invalidate*](http://byron.github.io/google-apis-rs/google_admin1_directory/struct.VerificationCodeInvalidateCall.html) and [*list*](http://byron.github.io/google-apis-rs/google_admin1_directory/struct.VerificationCodeListCall.html) Subscription supported by ... -* [*list users*](http://byron.github.io/google-apis-rs/google-admin1_directory/struct.UserListCall.html) -* [*aliases list users*](http://byron.github.io/google-apis-rs/google-admin1_directory/struct.UserAliaseListCall.html) -* [*watch users*](http://byron.github.io/google-apis-rs/google-admin1_directory/struct.UserWatchCall.html) -* [*aliases watch users*](http://byron.github.io/google-apis-rs/google-admin1_directory/struct.UserAliaseWatchCall.html) -* [*aliases list groups*](http://byron.github.io/google-apis-rs/google-admin1_directory/struct.GroupAliaseListCall.html) +* [*list users*](http://byron.github.io/google-apis-rs/google_admin1_directory/struct.UserListCall.html) +* [*aliases list users*](http://byron.github.io/google-apis-rs/google_admin1_directory/struct.UserAliaseListCall.html) +* [*watch users*](http://byron.github.io/google-apis-rs/google_admin1_directory/struct.UserWatchCall.html) +* [*aliases watch users*](http://byron.github.io/google-apis-rs/google_admin1_directory/struct.UserAliaseWatchCall.html) +* [*aliases list groups*](http://byron.github.io/google-apis-rs/google_admin1_directory/struct.GroupAliaseListCall.html) @@ -53,17 +53,17 @@ Subscription supported by ... The API is structured into the following primary items: -* **[Hub](http://byron.github.io/google-apis-rs/google-admin1_directory/struct.Directory.html)** +* **[Hub](http://byron.github.io/google-apis-rs/google_admin1_directory/struct.Directory.html)** * a central object to maintain state and allow accessing all *Activities* - * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google-admin1_directory/trait.MethodsBuilder.html) which in turn - allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google-admin1_directory/trait.CallBuilder.html) -* **[Resources](http://byron.github.io/google-apis-rs/google-admin1_directory/trait.Resource.html)** + * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google_admin1_directory/trait.MethodsBuilder.html) which in turn + allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google_admin1_directory/trait.CallBuilder.html) +* **[Resources](http://byron.github.io/google-apis-rs/google_admin1_directory/trait.Resource.html)** * primary types that you can apply *Activities* to * a collection of properties and *Parts* - * **[Parts](http://byron.github.io/google-apis-rs/google-admin1_directory/trait.Part.html)** + * **[Parts](http://byron.github.io/google-apis-rs/google_admin1_directory/trait.Part.html)** * a collection of properties * never directly used in *Activities* -* **[Activities](http://byron.github.io/google-apis-rs/google-admin1_directory/trait.CallBuilder.html)** +* **[Activities](http://byron.github.io/google-apis-rs/google_admin1_directory/trait.CallBuilder.html)** * operations to apply to *Resources* All *structures* are marked with applicable traits to further categorize them and ease browsing. @@ -176,17 +176,17 @@ match result { ``` ## Handling Errors -All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google-admin1_directory/enum.Result.html) enumeration as return value of +All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google_admin1_directory/enum.Result.html) enumeration as return value of the doit() methods, or handed as possibly intermediate results to either the -[Hub Delegate](http://byron.github.io/google-apis-rs/google-admin1_directory/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google-admin1_directory/../yup-oauth2/trait.AuthenticatorDelegate.html). +[Hub Delegate](http://byron.github.io/google-apis-rs/google_admin1_directory/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google_admin1_directory/../yup-oauth2/trait.AuthenticatorDelegate.html). 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](http://byron.github.io/google-apis-rs/google-admin1_directory/enum.Result.html), should be +If a method supports downloads, the response body, which is part of the [Result](http://byron.github.io/google-apis-rs/google_admin1_directory/enum.Result.html), should be read by you to obtain the media. -If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google-admin1_directory/trait.ResponseResult.html), it will return that by default. +If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google_admin1_directory/trait.ResponseResult.html), 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")`. @@ -196,29 +196,29 @@ Methods supporting uploads can do so using up to 2 different protocols: ## Customization and Callbacks -You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google-admin1_directory/trait.Delegate.html) to the -[Method Builder](http://byron.github.io/google-apis-rs/google-admin1_directory/trait.CallBuilder.html) before making the final `doit()` call. +You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google_admin1_directory/trait.Delegate.html) to the +[Method Builder](http://byron.github.io/google-apis-rs/google_admin1_directory/trait.CallBuilder.html) 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](http://byron.github.io/google-apis-rs/google-admin1_directory/trait.Delegate.html) is default-implemented, allowing you to customize it with minimal effort. +The [delegate trait](http://byron.github.io/google-apis-rs/google_admin1_directory/trait.Delegate.html) 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](http://byron.github.io/google-apis-rs/google-admin1_directory/trait.RequestValue.html) and -[decodable](http://byron.github.io/google-apis-rs/google-admin1_directory/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses +All structures provided by this library are made to be [enocodable](http://byron.github.io/google-apis-rs/google_admin1_directory/trait.RequestValue.html) and +[decodable](http://byron.github.io/google-apis-rs/google_admin1_directory/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses are valid. -Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google-admin1_directory/trait.Part.html) which are identifiable by name, which will be sent to +Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google_admin1_directory/trait.Part.html) 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](http://byron.github.io/google-apis-rs/google-admin1_directory/trait.CallBuilder.html), you are able to prepare an action call by repeatedly calling it's methods. +Using [method builders](http://byron.github.io/google-apis-rs/google_admin1_directory/trait.CallBuilder.html), 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][wiki-pod] are handed by copy * strings are passed as `&str` -* [request values](http://byron.github.io/google-apis-rs/google-admin1_directory/trait.RequestValue.html) are borrowed +* [request values](http://byron.github.io/google-apis-rs/google_admin1_directory/trait.RequestValue.html) are borrowed Arguments will always be copied or cloned into the builder, to make them independent of their original life times. diff --git a/gen/admin1_reports/README.md b/gen/admin1_reports/README.md index b4f752530b..0e3c4766c3 100644 --- a/gen/admin1_reports/README.md +++ b/gen/admin1_reports/README.md @@ -11,22 +11,22 @@ Everything else about the *reports* *v1_reports* API can be found at the [official documentation site](https://developers.google.com/admin-sdk/reports/). # Features -Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google-admin1_reports/struct.Reports.html) ... +Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google_admin1_reports/struct.Reports.html) ... -* [activities](http://byron.github.io/google-apis-rs/google-admin1_reports/struct.Activity.html) - * [*list*](http://byron.github.io/google-apis-rs/google-admin1_reports/struct.ActivityListCall.html) and [*watch*](http://byron.github.io/google-apis-rs/google-admin1_reports/struct.ActivityWatchCall.html) -* [channels](http://byron.github.io/google-apis-rs/google-admin1_reports/struct.Channel.html) - * [*stop*](http://byron.github.io/google-apis-rs/google-admin1_reports/struct.ChannelStopCall.html) +* [activities](http://byron.github.io/google-apis-rs/google_admin1_reports/struct.Activity.html) + * [*list*](http://byron.github.io/google-apis-rs/google_admin1_reports/struct.ActivityListCall.html) and [*watch*](http://byron.github.io/google-apis-rs/google_admin1_reports/struct.ActivityWatchCall.html) +* [channels](http://byron.github.io/google-apis-rs/google_admin1_reports/struct.Channel.html) + * [*stop*](http://byron.github.io/google-apis-rs/google_admin1_reports/struct.ChannelStopCall.html) * customer usage reports - * [*get*](http://byron.github.io/google-apis-rs/google-admin1_reports/struct.CustomerUsageReportGetCall.html) + * [*get*](http://byron.github.io/google-apis-rs/google_admin1_reports/struct.CustomerUsageReportGetCall.html) * user usage report - * [*get*](http://byron.github.io/google-apis-rs/google-admin1_reports/struct.UserUsageReportGetCall.html) + * [*get*](http://byron.github.io/google-apis-rs/google_admin1_reports/struct.UserUsageReportGetCall.html) Subscription supported by ... -* [*watch activities*](http://byron.github.io/google-apis-rs/google-admin1_reports/struct.ActivityWatchCall.html) -* [*list activities*](http://byron.github.io/google-apis-rs/google-admin1_reports/struct.ActivityListCall.html) +* [*watch activities*](http://byron.github.io/google-apis-rs/google_admin1_reports/struct.ActivityWatchCall.html) +* [*list activities*](http://byron.github.io/google-apis-rs/google_admin1_reports/struct.ActivityListCall.html) @@ -34,17 +34,17 @@ Subscription supported by ... The API is structured into the following primary items: -* **[Hub](http://byron.github.io/google-apis-rs/google-admin1_reports/struct.Reports.html)** +* **[Hub](http://byron.github.io/google-apis-rs/google_admin1_reports/struct.Reports.html)** * a central object to maintain state and allow accessing all *Activities* - * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google-admin1_reports/trait.MethodsBuilder.html) which in turn - allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google-admin1_reports/trait.CallBuilder.html) -* **[Resources](http://byron.github.io/google-apis-rs/google-admin1_reports/trait.Resource.html)** + * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google_admin1_reports/trait.MethodsBuilder.html) which in turn + allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google_admin1_reports/trait.CallBuilder.html) +* **[Resources](http://byron.github.io/google-apis-rs/google_admin1_reports/trait.Resource.html)** * primary types that you can apply *Activities* to * a collection of properties and *Parts* - * **[Parts](http://byron.github.io/google-apis-rs/google-admin1_reports/trait.Part.html)** + * **[Parts](http://byron.github.io/google-apis-rs/google_admin1_reports/trait.Part.html)** * a collection of properties * never directly used in *Activities* -* **[Activities](http://byron.github.io/google-apis-rs/google-admin1_reports/trait.CallBuilder.html)** +* **[Activities](http://byron.github.io/google-apis-rs/google_admin1_reports/trait.CallBuilder.html)** * operations to apply to *Resources* All *structures* are marked with applicable traits to further categorize them and ease browsing. @@ -138,17 +138,17 @@ match result { ``` ## Handling Errors -All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google-admin1_reports/enum.Result.html) enumeration as return value of +All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google_admin1_reports/enum.Result.html) enumeration as return value of the doit() methods, or handed as possibly intermediate results to either the -[Hub Delegate](http://byron.github.io/google-apis-rs/google-admin1_reports/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google-admin1_reports/../yup-oauth2/trait.AuthenticatorDelegate.html). +[Hub Delegate](http://byron.github.io/google-apis-rs/google_admin1_reports/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google_admin1_reports/../yup-oauth2/trait.AuthenticatorDelegate.html). 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](http://byron.github.io/google-apis-rs/google-admin1_reports/enum.Result.html), should be +If a method supports downloads, the response body, which is part of the [Result](http://byron.github.io/google-apis-rs/google_admin1_reports/enum.Result.html), should be read by you to obtain the media. -If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google-admin1_reports/trait.ResponseResult.html), it will return that by default. +If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google_admin1_reports/trait.ResponseResult.html), 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")`. @@ -158,29 +158,29 @@ Methods supporting uploads can do so using up to 2 different protocols: ## Customization and Callbacks -You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google-admin1_reports/trait.Delegate.html) to the -[Method Builder](http://byron.github.io/google-apis-rs/google-admin1_reports/trait.CallBuilder.html) before making the final `doit()` call. +You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google_admin1_reports/trait.Delegate.html) to the +[Method Builder](http://byron.github.io/google-apis-rs/google_admin1_reports/trait.CallBuilder.html) 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](http://byron.github.io/google-apis-rs/google-admin1_reports/trait.Delegate.html) is default-implemented, allowing you to customize it with minimal effort. +The [delegate trait](http://byron.github.io/google-apis-rs/google_admin1_reports/trait.Delegate.html) 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](http://byron.github.io/google-apis-rs/google-admin1_reports/trait.RequestValue.html) and -[decodable](http://byron.github.io/google-apis-rs/google-admin1_reports/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses +All structures provided by this library are made to be [enocodable](http://byron.github.io/google-apis-rs/google_admin1_reports/trait.RequestValue.html) and +[decodable](http://byron.github.io/google-apis-rs/google_admin1_reports/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses are valid. -Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google-admin1_reports/trait.Part.html) which are identifiable by name, which will be sent to +Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google_admin1_reports/trait.Part.html) 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](http://byron.github.io/google-apis-rs/google-admin1_reports/trait.CallBuilder.html), you are able to prepare an action call by repeatedly calling it's methods. +Using [method builders](http://byron.github.io/google-apis-rs/google_admin1_reports/trait.CallBuilder.html), 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][wiki-pod] are handed by copy * strings are passed as `&str` -* [request values](http://byron.github.io/google-apis-rs/google-admin1_reports/trait.RequestValue.html) are borrowed +* [request values](http://byron.github.io/google-apis-rs/google_admin1_reports/trait.RequestValue.html) are borrowed Arguments will always be copied or cloned into the builder, to make them independent of their original life times. diff --git a/gen/admin2_email_migration/README.md b/gen/admin2_email_migration/README.md index 2438edf29c..a41ab20d43 100644 --- a/gen/admin2_email_migration/README.md +++ b/gen/admin2_email_migration/README.md @@ -11,15 +11,15 @@ Everything else about the *admin* *v2_email_migration* API can be found at the [official documentation site](https://developers.google.com/admin-sdk/email-migration/v2/). # Features -Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google-admin2_email_migration/struct.Admin.html) ... +Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google_admin2_email_migration/struct.Admin.html) ... * mail - * [*insert*](http://byron.github.io/google-apis-rs/google-admin2_email_migration/struct.MailInsertCall.html) + * [*insert*](http://byron.github.io/google-apis-rs/google_admin2_email_migration/struct.MailInsertCall.html) Upload supported by ... -* [*insert mail*](http://byron.github.io/google-apis-rs/google-admin2_email_migration/struct.MailInsertCall.html) +* [*insert mail*](http://byron.github.io/google-apis-rs/google_admin2_email_migration/struct.MailInsertCall.html) @@ -27,17 +27,17 @@ Upload supported by ... The API is structured into the following primary items: -* **[Hub](http://byron.github.io/google-apis-rs/google-admin2_email_migration/struct.Admin.html)** +* **[Hub](http://byron.github.io/google-apis-rs/google_admin2_email_migration/struct.Admin.html)** * a central object to maintain state and allow accessing all *Activities* - * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google-admin2_email_migration/trait.MethodsBuilder.html) which in turn - allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google-admin2_email_migration/trait.CallBuilder.html) -* **[Resources](http://byron.github.io/google-apis-rs/google-admin2_email_migration/trait.Resource.html)** + * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google_admin2_email_migration/trait.MethodsBuilder.html) which in turn + allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google_admin2_email_migration/trait.CallBuilder.html) +* **[Resources](http://byron.github.io/google-apis-rs/google_admin2_email_migration/trait.Resource.html)** * primary types that you can apply *Activities* to * a collection of properties and *Parts* - * **[Parts](http://byron.github.io/google-apis-rs/google-admin2_email_migration/trait.Part.html)** + * **[Parts](http://byron.github.io/google-apis-rs/google_admin2_email_migration/trait.Part.html)** * a collection of properties * never directly used in *Activities* -* **[Activities](http://byron.github.io/google-apis-rs/google-admin2_email_migration/trait.CallBuilder.html)** +* **[Activities](http://byron.github.io/google-apis-rs/google_admin2_email_migration/trait.CallBuilder.html)** * operations to apply to *Resources* All *structures* are marked with applicable traits to further categorize them and ease browsing. @@ -123,17 +123,17 @@ match result { ``` ## Handling Errors -All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google-admin2_email_migration/enum.Result.html) enumeration as return value of +All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google_admin2_email_migration/enum.Result.html) enumeration as return value of the doit() methods, or handed as possibly intermediate results to either the -[Hub Delegate](http://byron.github.io/google-apis-rs/google-admin2_email_migration/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google-admin2_email_migration/../yup-oauth2/trait.AuthenticatorDelegate.html). +[Hub Delegate](http://byron.github.io/google-apis-rs/google_admin2_email_migration/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google_admin2_email_migration/../yup-oauth2/trait.AuthenticatorDelegate.html). 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](http://byron.github.io/google-apis-rs/google-admin2_email_migration/enum.Result.html), should be +If a method supports downloads, the response body, which is part of the [Result](http://byron.github.io/google-apis-rs/google_admin2_email_migration/enum.Result.html), should be read by you to obtain the media. -If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google-admin2_email_migration/trait.ResponseResult.html), it will return that by default. +If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google_admin2_email_migration/trait.ResponseResult.html), 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")`. @@ -143,29 +143,29 @@ Methods supporting uploads can do so using up to 2 different protocols: ## Customization and Callbacks -You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google-admin2_email_migration/trait.Delegate.html) to the -[Method Builder](http://byron.github.io/google-apis-rs/google-admin2_email_migration/trait.CallBuilder.html) before making the final `doit()` call. +You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google_admin2_email_migration/trait.Delegate.html) to the +[Method Builder](http://byron.github.io/google-apis-rs/google_admin2_email_migration/trait.CallBuilder.html) 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](http://byron.github.io/google-apis-rs/google-admin2_email_migration/trait.Delegate.html) is default-implemented, allowing you to customize it with minimal effort. +The [delegate trait](http://byron.github.io/google-apis-rs/google_admin2_email_migration/trait.Delegate.html) 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](http://byron.github.io/google-apis-rs/google-admin2_email_migration/trait.RequestValue.html) and -[decodable](http://byron.github.io/google-apis-rs/google-admin2_email_migration/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses +All structures provided by this library are made to be [enocodable](http://byron.github.io/google-apis-rs/google_admin2_email_migration/trait.RequestValue.html) and +[decodable](http://byron.github.io/google-apis-rs/google_admin2_email_migration/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses are valid. -Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google-admin2_email_migration/trait.Part.html) which are identifiable by name, which will be sent to +Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google_admin2_email_migration/trait.Part.html) 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](http://byron.github.io/google-apis-rs/google-admin2_email_migration/trait.CallBuilder.html), you are able to prepare an action call by repeatedly calling it's methods. +Using [method builders](http://byron.github.io/google-apis-rs/google_admin2_email_migration/trait.CallBuilder.html), 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][wiki-pod] are handed by copy * strings are passed as `&str` -* [request values](http://byron.github.io/google-apis-rs/google-admin2_email_migration/trait.RequestValue.html) are borrowed +* [request values](http://byron.github.io/google-apis-rs/google_admin2_email_migration/trait.RequestValue.html) are borrowed Arguments will always be copied or cloned into the builder, to make them independent of their original life times. diff --git a/gen/adsense1d4/README.md b/gen/adsense1d4/README.md index da9e4c14b8..6395762092 100644 --- a/gen/adsense1d4/README.md +++ b/gen/adsense1d4/README.md @@ -11,34 +11,34 @@ Everything else about the *AdSense* *v1d4* API can be found at the [official documentation site](https://developers.google.com/adsense/management/). # Features -Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google-adsense1d4/struct.AdSense.html) ... +Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google_adsense1d4/struct.AdSense.html) ... -* [accounts](http://byron.github.io/google-apis-rs/google-adsense1d4/struct.Account.html) - * [*adclients list*](http://byron.github.io/google-apis-rs/google-adsense1d4/struct.AccountAdclientListCall.html), [*adunits customchannels list*](http://byron.github.io/google-apis-rs/google-adsense1d4/struct.AccountAdunitCustomchannelListCall.html), [*adunits get*](http://byron.github.io/google-apis-rs/google-adsense1d4/struct.AccountAdunitGetCall.html), [*adunits get ad code*](http://byron.github.io/google-apis-rs/google-adsense1d4/struct.AccountAdunitGetAdCodeCall.html), [*adunits list*](http://byron.github.io/google-apis-rs/google-adsense1d4/struct.AccountAdunitListCall.html), [*alerts delete*](http://byron.github.io/google-apis-rs/google-adsense1d4/struct.AccountAlertDeleteCall.html), [*alerts list*](http://byron.github.io/google-apis-rs/google-adsense1d4/struct.AccountAlertListCall.html), [*customchannels adunits list*](http://byron.github.io/google-apis-rs/google-adsense1d4/struct.AccountCustomchannelAdunitListCall.html), [*customchannels get*](http://byron.github.io/google-apis-rs/google-adsense1d4/struct.AccountCustomchannelGetCall.html), [*customchannels list*](http://byron.github.io/google-apis-rs/google-adsense1d4/struct.AccountCustomchannelListCall.html), [*get*](http://byron.github.io/google-apis-rs/google-adsense1d4/struct.AccountGetCall.html), [*list*](http://byron.github.io/google-apis-rs/google-adsense1d4/struct.AccountListCall.html), [*payments list*](http://byron.github.io/google-apis-rs/google-adsense1d4/struct.AccountPaymentListCall.html), [*reports generate*](http://byron.github.io/google-apis-rs/google-adsense1d4/struct.AccountReportGenerateCall.html), [*reports saved generate*](http://byron.github.io/google-apis-rs/google-adsense1d4/struct.AccountReportSavedGenerateCall.html), [*reports saved list*](http://byron.github.io/google-apis-rs/google-adsense1d4/struct.AccountReportSavedListCall.html), [*savedadstyles get*](http://byron.github.io/google-apis-rs/google-adsense1d4/struct.AccountSavedadstyleGetCall.html), [*savedadstyles list*](http://byron.github.io/google-apis-rs/google-adsense1d4/struct.AccountSavedadstyleListCall.html) and [*urlchannels list*](http://byron.github.io/google-apis-rs/google-adsense1d4/struct.AccountUrlchannelListCall.html) +* [accounts](http://byron.github.io/google-apis-rs/google_adsense1d4/struct.Account.html) + * [*adclients list*](http://byron.github.io/google-apis-rs/google_adsense1d4/struct.AccountAdclientListCall.html), [*adunits customchannels list*](http://byron.github.io/google-apis-rs/google_adsense1d4/struct.AccountAdunitCustomchannelListCall.html), [*adunits get*](http://byron.github.io/google-apis-rs/google_adsense1d4/struct.AccountAdunitGetCall.html), [*adunits get ad code*](http://byron.github.io/google-apis-rs/google_adsense1d4/struct.AccountAdunitGetAdCodeCall.html), [*adunits list*](http://byron.github.io/google-apis-rs/google_adsense1d4/struct.AccountAdunitListCall.html), [*alerts delete*](http://byron.github.io/google-apis-rs/google_adsense1d4/struct.AccountAlertDeleteCall.html), [*alerts list*](http://byron.github.io/google-apis-rs/google_adsense1d4/struct.AccountAlertListCall.html), [*customchannels adunits list*](http://byron.github.io/google-apis-rs/google_adsense1d4/struct.AccountCustomchannelAdunitListCall.html), [*customchannels get*](http://byron.github.io/google-apis-rs/google_adsense1d4/struct.AccountCustomchannelGetCall.html), [*customchannels list*](http://byron.github.io/google-apis-rs/google_adsense1d4/struct.AccountCustomchannelListCall.html), [*get*](http://byron.github.io/google-apis-rs/google_adsense1d4/struct.AccountGetCall.html), [*list*](http://byron.github.io/google-apis-rs/google_adsense1d4/struct.AccountListCall.html), [*payments list*](http://byron.github.io/google-apis-rs/google_adsense1d4/struct.AccountPaymentListCall.html), [*reports generate*](http://byron.github.io/google-apis-rs/google_adsense1d4/struct.AccountReportGenerateCall.html), [*reports saved generate*](http://byron.github.io/google-apis-rs/google_adsense1d4/struct.AccountReportSavedGenerateCall.html), [*reports saved list*](http://byron.github.io/google-apis-rs/google_adsense1d4/struct.AccountReportSavedListCall.html), [*savedadstyles get*](http://byron.github.io/google-apis-rs/google_adsense1d4/struct.AccountSavedadstyleGetCall.html), [*savedadstyles list*](http://byron.github.io/google-apis-rs/google_adsense1d4/struct.AccountSavedadstyleListCall.html) and [*urlchannels list*](http://byron.github.io/google-apis-rs/google_adsense1d4/struct.AccountUrlchannelListCall.html) * adclients - * [*list*](http://byron.github.io/google-apis-rs/google-adsense1d4/struct.AdclientListCall.html) + * [*list*](http://byron.github.io/google-apis-rs/google_adsense1d4/struct.AdclientListCall.html) * adunits - * [*customchannels list*](http://byron.github.io/google-apis-rs/google-adsense1d4/struct.AdunitCustomchannelListCall.html), [*get*](http://byron.github.io/google-apis-rs/google-adsense1d4/struct.AdunitGetCall.html), [*get ad code*](http://byron.github.io/google-apis-rs/google-adsense1d4/struct.AdunitGetAdCodeCall.html) and [*list*](http://byron.github.io/google-apis-rs/google-adsense1d4/struct.AdunitListCall.html) -* [alerts](http://byron.github.io/google-apis-rs/google-adsense1d4/struct.Alert.html) - * [*delete*](http://byron.github.io/google-apis-rs/google-adsense1d4/struct.AlertDeleteCall.html) and [*list*](http://byron.github.io/google-apis-rs/google-adsense1d4/struct.AlertListCall.html) + * [*customchannels list*](http://byron.github.io/google-apis-rs/google_adsense1d4/struct.AdunitCustomchannelListCall.html), [*get*](http://byron.github.io/google-apis-rs/google_adsense1d4/struct.AdunitGetCall.html), [*get ad code*](http://byron.github.io/google-apis-rs/google_adsense1d4/struct.AdunitGetAdCodeCall.html) and [*list*](http://byron.github.io/google-apis-rs/google_adsense1d4/struct.AdunitListCall.html) +* [alerts](http://byron.github.io/google-apis-rs/google_adsense1d4/struct.Alert.html) + * [*delete*](http://byron.github.io/google-apis-rs/google_adsense1d4/struct.AlertDeleteCall.html) and [*list*](http://byron.github.io/google-apis-rs/google_adsense1d4/struct.AlertListCall.html) * customchannels - * [*adunits list*](http://byron.github.io/google-apis-rs/google-adsense1d4/struct.CustomchannelAdunitListCall.html), [*get*](http://byron.github.io/google-apis-rs/google-adsense1d4/struct.CustomchannelGetCall.html) and [*list*](http://byron.github.io/google-apis-rs/google-adsense1d4/struct.CustomchannelListCall.html) -* [metadata](http://byron.github.io/google-apis-rs/google-adsense1d4/struct.Metadata.html) - * [*dimensions list*](http://byron.github.io/google-apis-rs/google-adsense1d4/struct.MetadataDimensionListCall.html) and [*metrics list*](http://byron.github.io/google-apis-rs/google-adsense1d4/struct.MetadataMetricListCall.html) -* [payments](http://byron.github.io/google-apis-rs/google-adsense1d4/struct.Payment.html) - * [*list*](http://byron.github.io/google-apis-rs/google-adsense1d4/struct.PaymentListCall.html) + * [*adunits list*](http://byron.github.io/google-apis-rs/google_adsense1d4/struct.CustomchannelAdunitListCall.html), [*get*](http://byron.github.io/google-apis-rs/google_adsense1d4/struct.CustomchannelGetCall.html) and [*list*](http://byron.github.io/google-apis-rs/google_adsense1d4/struct.CustomchannelListCall.html) +* [metadata](http://byron.github.io/google-apis-rs/google_adsense1d4/struct.Metadata.html) + * [*dimensions list*](http://byron.github.io/google-apis-rs/google_adsense1d4/struct.MetadataDimensionListCall.html) and [*metrics list*](http://byron.github.io/google-apis-rs/google_adsense1d4/struct.MetadataMetricListCall.html) +* [payments](http://byron.github.io/google-apis-rs/google_adsense1d4/struct.Payment.html) + * [*list*](http://byron.github.io/google-apis-rs/google_adsense1d4/struct.PaymentListCall.html) * reports - * [*generate*](http://byron.github.io/google-apis-rs/google-adsense1d4/struct.ReportGenerateCall.html), [*saved generate*](http://byron.github.io/google-apis-rs/google-adsense1d4/struct.ReportSavedGenerateCall.html) and [*saved list*](http://byron.github.io/google-apis-rs/google-adsense1d4/struct.ReportSavedListCall.html) + * [*generate*](http://byron.github.io/google-apis-rs/google_adsense1d4/struct.ReportGenerateCall.html), [*saved generate*](http://byron.github.io/google-apis-rs/google_adsense1d4/struct.ReportSavedGenerateCall.html) and [*saved list*](http://byron.github.io/google-apis-rs/google_adsense1d4/struct.ReportSavedListCall.html) * savedadstyles - * [*get*](http://byron.github.io/google-apis-rs/google-adsense1d4/struct.SavedadstyleGetCall.html) and [*list*](http://byron.github.io/google-apis-rs/google-adsense1d4/struct.SavedadstyleListCall.html) + * [*get*](http://byron.github.io/google-apis-rs/google_adsense1d4/struct.SavedadstyleGetCall.html) and [*list*](http://byron.github.io/google-apis-rs/google_adsense1d4/struct.SavedadstyleListCall.html) * urlchannels - * [*list*](http://byron.github.io/google-apis-rs/google-adsense1d4/struct.UrlchannelListCall.html) + * [*list*](http://byron.github.io/google-apis-rs/google_adsense1d4/struct.UrlchannelListCall.html) Download supported by ... -* [*generate reports*](http://byron.github.io/google-apis-rs/google-adsense1d4/struct.ReportGenerateCall.html) -* [*reports generate accounts*](http://byron.github.io/google-apis-rs/google-adsense1d4/struct.AccountReportGenerateCall.html) +* [*generate reports*](http://byron.github.io/google-apis-rs/google_adsense1d4/struct.ReportGenerateCall.html) +* [*reports generate accounts*](http://byron.github.io/google-apis-rs/google_adsense1d4/struct.AccountReportGenerateCall.html) @@ -46,17 +46,17 @@ Download supported by ... The API is structured into the following primary items: -* **[Hub](http://byron.github.io/google-apis-rs/google-adsense1d4/struct.AdSense.html)** +* **[Hub](http://byron.github.io/google-apis-rs/google_adsense1d4/struct.AdSense.html)** * a central object to maintain state and allow accessing all *Activities* - * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google-adsense1d4/trait.MethodsBuilder.html) which in turn - allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google-adsense1d4/trait.CallBuilder.html) -* **[Resources](http://byron.github.io/google-apis-rs/google-adsense1d4/trait.Resource.html)** + * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google_adsense1d4/trait.MethodsBuilder.html) which in turn + allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google_adsense1d4/trait.CallBuilder.html) +* **[Resources](http://byron.github.io/google-apis-rs/google_adsense1d4/trait.Resource.html)** * primary types that you can apply *Activities* to * a collection of properties and *Parts* - * **[Parts](http://byron.github.io/google-apis-rs/google-adsense1d4/trait.Part.html)** + * **[Parts](http://byron.github.io/google-apis-rs/google_adsense1d4/trait.Part.html)** * a collection of properties * never directly used in *Activities* -* **[Activities](http://byron.github.io/google-apis-rs/google-adsense1d4/trait.CallBuilder.html)** +* **[Activities](http://byron.github.io/google-apis-rs/google_adsense1d4/trait.CallBuilder.html)** * operations to apply to *Resources* All *structures* are marked with applicable traits to further categorize them and ease browsing. @@ -162,17 +162,17 @@ match result { ``` ## Handling Errors -All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google-adsense1d4/enum.Result.html) enumeration as return value of +All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google_adsense1d4/enum.Result.html) enumeration as return value of the doit() methods, or handed as possibly intermediate results to either the -[Hub Delegate](http://byron.github.io/google-apis-rs/google-adsense1d4/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google-adsense1d4/../yup-oauth2/trait.AuthenticatorDelegate.html). +[Hub Delegate](http://byron.github.io/google-apis-rs/google_adsense1d4/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google_adsense1d4/../yup-oauth2/trait.AuthenticatorDelegate.html). 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](http://byron.github.io/google-apis-rs/google-adsense1d4/enum.Result.html), should be +If a method supports downloads, the response body, which is part of the [Result](http://byron.github.io/google-apis-rs/google_adsense1d4/enum.Result.html), should be read by you to obtain the media. -If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google-adsense1d4/trait.ResponseResult.html), it will return that by default. +If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google_adsense1d4/trait.ResponseResult.html), 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")`. @@ -182,29 +182,29 @@ Methods supporting uploads can do so using up to 2 different protocols: ## Customization and Callbacks -You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google-adsense1d4/trait.Delegate.html) to the -[Method Builder](http://byron.github.io/google-apis-rs/google-adsense1d4/trait.CallBuilder.html) before making the final `doit()` call. +You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google_adsense1d4/trait.Delegate.html) to the +[Method Builder](http://byron.github.io/google-apis-rs/google_adsense1d4/trait.CallBuilder.html) 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](http://byron.github.io/google-apis-rs/google-adsense1d4/trait.Delegate.html) is default-implemented, allowing you to customize it with minimal effort. +The [delegate trait](http://byron.github.io/google-apis-rs/google_adsense1d4/trait.Delegate.html) 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](http://byron.github.io/google-apis-rs/google-adsense1d4/trait.RequestValue.html) and -[decodable](http://byron.github.io/google-apis-rs/google-adsense1d4/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses +All structures provided by this library are made to be [enocodable](http://byron.github.io/google-apis-rs/google_adsense1d4/trait.RequestValue.html) and +[decodable](http://byron.github.io/google-apis-rs/google_adsense1d4/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses are valid. -Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google-adsense1d4/trait.Part.html) which are identifiable by name, which will be sent to +Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google_adsense1d4/trait.Part.html) 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](http://byron.github.io/google-apis-rs/google-adsense1d4/trait.CallBuilder.html), you are able to prepare an action call by repeatedly calling it's methods. +Using [method builders](http://byron.github.io/google-apis-rs/google_adsense1d4/trait.CallBuilder.html), 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][wiki-pod] are handed by copy * strings are passed as `&str` -* [request values](http://byron.github.io/google-apis-rs/google-adsense1d4/trait.RequestValue.html) are borrowed +* [request values](http://byron.github.io/google-apis-rs/google_adsense1d4/trait.RequestValue.html) are borrowed Arguments will always be copied or cloned into the builder, to make them independent of their original life times. diff --git a/gen/adsensehost4d1/README.md b/gen/adsensehost4d1/README.md index 5c0d3ec1fe..f5068a5e72 100644 --- a/gen/adsensehost4d1/README.md +++ b/gen/adsensehost4d1/README.md @@ -11,20 +11,20 @@ Everything else about the *AdSense Host* *v4d1* API can be found at the [official documentation site](https://developers.google.com/adsense/host/). # Features -Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google-adsensehost4d1/struct.AdSenseHost.html) ... +Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google_adsensehost4d1/struct.AdSenseHost.html) ... -* [accounts](http://byron.github.io/google-apis-rs/google-adsensehost4d1/struct.Account.html) - * [*adclients get*](http://byron.github.io/google-apis-rs/google-adsensehost4d1/struct.AccountAdclientGetCall.html), [*adclients list*](http://byron.github.io/google-apis-rs/google-adsensehost4d1/struct.AccountAdclientListCall.html), [*adunits delete*](http://byron.github.io/google-apis-rs/google-adsensehost4d1/struct.AccountAdunitDeleteCall.html), [*adunits get*](http://byron.github.io/google-apis-rs/google-adsensehost4d1/struct.AccountAdunitGetCall.html), [*adunits get ad code*](http://byron.github.io/google-apis-rs/google-adsensehost4d1/struct.AccountAdunitGetAdCodeCall.html), [*adunits insert*](http://byron.github.io/google-apis-rs/google-adsensehost4d1/struct.AccountAdunitInsertCall.html), [*adunits list*](http://byron.github.io/google-apis-rs/google-adsensehost4d1/struct.AccountAdunitListCall.html), [*adunits patch*](http://byron.github.io/google-apis-rs/google-adsensehost4d1/struct.AccountAdunitPatchCall.html), [*adunits update*](http://byron.github.io/google-apis-rs/google-adsensehost4d1/struct.AccountAdunitUpdateCall.html), [*get*](http://byron.github.io/google-apis-rs/google-adsensehost4d1/struct.AccountGetCall.html), [*list*](http://byron.github.io/google-apis-rs/google-adsensehost4d1/struct.AccountListCall.html) and [*reports generate*](http://byron.github.io/google-apis-rs/google-adsensehost4d1/struct.AccountReportGenerateCall.html) +* [accounts](http://byron.github.io/google-apis-rs/google_adsensehost4d1/struct.Account.html) + * [*adclients get*](http://byron.github.io/google-apis-rs/google_adsensehost4d1/struct.AccountAdclientGetCall.html), [*adclients list*](http://byron.github.io/google-apis-rs/google_adsensehost4d1/struct.AccountAdclientListCall.html), [*adunits delete*](http://byron.github.io/google-apis-rs/google_adsensehost4d1/struct.AccountAdunitDeleteCall.html), [*adunits get*](http://byron.github.io/google-apis-rs/google_adsensehost4d1/struct.AccountAdunitGetCall.html), [*adunits get ad code*](http://byron.github.io/google-apis-rs/google_adsensehost4d1/struct.AccountAdunitGetAdCodeCall.html), [*adunits insert*](http://byron.github.io/google-apis-rs/google_adsensehost4d1/struct.AccountAdunitInsertCall.html), [*adunits list*](http://byron.github.io/google-apis-rs/google_adsensehost4d1/struct.AccountAdunitListCall.html), [*adunits patch*](http://byron.github.io/google-apis-rs/google_adsensehost4d1/struct.AccountAdunitPatchCall.html), [*adunits update*](http://byron.github.io/google-apis-rs/google_adsensehost4d1/struct.AccountAdunitUpdateCall.html), [*get*](http://byron.github.io/google-apis-rs/google_adsensehost4d1/struct.AccountGetCall.html), [*list*](http://byron.github.io/google-apis-rs/google_adsensehost4d1/struct.AccountListCall.html) and [*reports generate*](http://byron.github.io/google-apis-rs/google_adsensehost4d1/struct.AccountReportGenerateCall.html) * adclients - * [*get*](http://byron.github.io/google-apis-rs/google-adsensehost4d1/struct.AdclientGetCall.html) and [*list*](http://byron.github.io/google-apis-rs/google-adsensehost4d1/struct.AdclientListCall.html) + * [*get*](http://byron.github.io/google-apis-rs/google_adsensehost4d1/struct.AdclientGetCall.html) and [*list*](http://byron.github.io/google-apis-rs/google_adsensehost4d1/struct.AdclientListCall.html) * associationsessions - * [*start*](http://byron.github.io/google-apis-rs/google-adsensehost4d1/struct.AssociationsessionStartCall.html) and [*verify*](http://byron.github.io/google-apis-rs/google-adsensehost4d1/struct.AssociationsessionVerifyCall.html) + * [*start*](http://byron.github.io/google-apis-rs/google_adsensehost4d1/struct.AssociationsessionStartCall.html) and [*verify*](http://byron.github.io/google-apis-rs/google_adsensehost4d1/struct.AssociationsessionVerifyCall.html) * customchannels - * [*delete*](http://byron.github.io/google-apis-rs/google-adsensehost4d1/struct.CustomchannelDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google-adsensehost4d1/struct.CustomchannelGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google-adsensehost4d1/struct.CustomchannelInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google-adsensehost4d1/struct.CustomchannelListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google-adsensehost4d1/struct.CustomchannelPatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google-adsensehost4d1/struct.CustomchannelUpdateCall.html) -* [reports](http://byron.github.io/google-apis-rs/google-adsensehost4d1/struct.Report.html) - * [*generate*](http://byron.github.io/google-apis-rs/google-adsensehost4d1/struct.ReportGenerateCall.html) + * [*delete*](http://byron.github.io/google-apis-rs/google_adsensehost4d1/struct.CustomchannelDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google_adsensehost4d1/struct.CustomchannelGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google_adsensehost4d1/struct.CustomchannelInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google_adsensehost4d1/struct.CustomchannelListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google_adsensehost4d1/struct.CustomchannelPatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google_adsensehost4d1/struct.CustomchannelUpdateCall.html) +* [reports](http://byron.github.io/google-apis-rs/google_adsensehost4d1/struct.Report.html) + * [*generate*](http://byron.github.io/google-apis-rs/google_adsensehost4d1/struct.ReportGenerateCall.html) * urlchannels - * [*delete*](http://byron.github.io/google-apis-rs/google-adsensehost4d1/struct.UrlchannelDeleteCall.html), [*insert*](http://byron.github.io/google-apis-rs/google-adsensehost4d1/struct.UrlchannelInsertCall.html) and [*list*](http://byron.github.io/google-apis-rs/google-adsensehost4d1/struct.UrlchannelListCall.html) + * [*delete*](http://byron.github.io/google-apis-rs/google_adsensehost4d1/struct.UrlchannelDeleteCall.html), [*insert*](http://byron.github.io/google-apis-rs/google_adsensehost4d1/struct.UrlchannelInsertCall.html) and [*list*](http://byron.github.io/google-apis-rs/google_adsensehost4d1/struct.UrlchannelListCall.html) @@ -33,17 +33,17 @@ Handle the following *Resources* with ease from the central [hub](http://byron.g The API is structured into the following primary items: -* **[Hub](http://byron.github.io/google-apis-rs/google-adsensehost4d1/struct.AdSenseHost.html)** +* **[Hub](http://byron.github.io/google-apis-rs/google_adsensehost4d1/struct.AdSenseHost.html)** * a central object to maintain state and allow accessing all *Activities* - * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google-adsensehost4d1/trait.MethodsBuilder.html) which in turn - allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google-adsensehost4d1/trait.CallBuilder.html) -* **[Resources](http://byron.github.io/google-apis-rs/google-adsensehost4d1/trait.Resource.html)** + * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google_adsensehost4d1/trait.MethodsBuilder.html) which in turn + allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google_adsensehost4d1/trait.CallBuilder.html) +* **[Resources](http://byron.github.io/google-apis-rs/google_adsensehost4d1/trait.Resource.html)** * primary types that you can apply *Activities* to * a collection of properties and *Parts* - * **[Parts](http://byron.github.io/google-apis-rs/google-adsensehost4d1/trait.Part.html)** + * **[Parts](http://byron.github.io/google-apis-rs/google_adsensehost4d1/trait.Part.html)** * a collection of properties * never directly used in *Activities* -* **[Activities](http://byron.github.io/google-apis-rs/google-adsensehost4d1/trait.CallBuilder.html)** +* **[Activities](http://byron.github.io/google-apis-rs/google_adsensehost4d1/trait.CallBuilder.html)** * operations to apply to *Resources* All *structures* are marked with applicable traits to further categorize them and ease browsing. @@ -140,17 +140,17 @@ match result { ``` ## Handling Errors -All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google-adsensehost4d1/enum.Result.html) enumeration as return value of +All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google_adsensehost4d1/enum.Result.html) enumeration as return value of the doit() methods, or handed as possibly intermediate results to either the -[Hub Delegate](http://byron.github.io/google-apis-rs/google-adsensehost4d1/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google-adsensehost4d1/../yup-oauth2/trait.AuthenticatorDelegate.html). +[Hub Delegate](http://byron.github.io/google-apis-rs/google_adsensehost4d1/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google_adsensehost4d1/../yup-oauth2/trait.AuthenticatorDelegate.html). 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](http://byron.github.io/google-apis-rs/google-adsensehost4d1/enum.Result.html), should be +If a method supports downloads, the response body, which is part of the [Result](http://byron.github.io/google-apis-rs/google_adsensehost4d1/enum.Result.html), should be read by you to obtain the media. -If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google-adsensehost4d1/trait.ResponseResult.html), it will return that by default. +If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google_adsensehost4d1/trait.ResponseResult.html), 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")`. @@ -160,29 +160,29 @@ Methods supporting uploads can do so using up to 2 different protocols: ## Customization and Callbacks -You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google-adsensehost4d1/trait.Delegate.html) to the -[Method Builder](http://byron.github.io/google-apis-rs/google-adsensehost4d1/trait.CallBuilder.html) before making the final `doit()` call. +You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google_adsensehost4d1/trait.Delegate.html) to the +[Method Builder](http://byron.github.io/google-apis-rs/google_adsensehost4d1/trait.CallBuilder.html) 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](http://byron.github.io/google-apis-rs/google-adsensehost4d1/trait.Delegate.html) is default-implemented, allowing you to customize it with minimal effort. +The [delegate trait](http://byron.github.io/google-apis-rs/google_adsensehost4d1/trait.Delegate.html) 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](http://byron.github.io/google-apis-rs/google-adsensehost4d1/trait.RequestValue.html) and -[decodable](http://byron.github.io/google-apis-rs/google-adsensehost4d1/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses +All structures provided by this library are made to be [enocodable](http://byron.github.io/google-apis-rs/google_adsensehost4d1/trait.RequestValue.html) and +[decodable](http://byron.github.io/google-apis-rs/google_adsensehost4d1/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses are valid. -Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google-adsensehost4d1/trait.Part.html) which are identifiable by name, which will be sent to +Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google_adsensehost4d1/trait.Part.html) 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](http://byron.github.io/google-apis-rs/google-adsensehost4d1/trait.CallBuilder.html), you are able to prepare an action call by repeatedly calling it's methods. +Using [method builders](http://byron.github.io/google-apis-rs/google_adsensehost4d1/trait.CallBuilder.html), 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][wiki-pod] are handed by copy * strings are passed as `&str` -* [request values](http://byron.github.io/google-apis-rs/google-adsensehost4d1/trait.RequestValue.html) are borrowed +* [request values](http://byron.github.io/google-apis-rs/google_adsensehost4d1/trait.RequestValue.html) are borrowed Arguments will always be copied or cloned into the builder, to make them independent of their original life times. diff --git a/gen/analytics3/README.md b/gen/analytics3/README.md index 03111a8055..55bba578d0 100644 --- a/gen/analytics3/README.md +++ b/gen/analytics3/README.md @@ -11,21 +11,21 @@ Everything else about the *analytics* *v3* API can be found at the [official documentation site](https://developers.google.com/analytics/). # Features -Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google-analytics3/struct.Analytics.html) ... +Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google_analytics3/struct.Analytics.html) ... * data - * [*ga get*](http://byron.github.io/google-apis-rs/google-analytics3/struct.DataGaGetCall.html), [*mcf get*](http://byron.github.io/google-apis-rs/google-analytics3/struct.DataMcfGetCall.html) and [*realtime get*](http://byron.github.io/google-apis-rs/google-analytics3/struct.DataRealtimeGetCall.html) + * [*ga get*](http://byron.github.io/google-apis-rs/google_analytics3/struct.DataGaGetCall.html), [*mcf get*](http://byron.github.io/google-apis-rs/google_analytics3/struct.DataMcfGetCall.html) and [*realtime get*](http://byron.github.io/google-apis-rs/google_analytics3/struct.DataRealtimeGetCall.html) * management - * [*account summaries list*](http://byron.github.io/google-apis-rs/google-analytics3/struct.ManagementAccountSummaryListCall.html), [*account user links delete*](http://byron.github.io/google-apis-rs/google-analytics3/struct.ManagementAccountUserLinkDeleteCall.html), [*account user links insert*](http://byron.github.io/google-apis-rs/google-analytics3/struct.ManagementAccountUserLinkInsertCall.html), [*account user links list*](http://byron.github.io/google-apis-rs/google-analytics3/struct.ManagementAccountUserLinkListCall.html), [*account user links update*](http://byron.github.io/google-apis-rs/google-analytics3/struct.ManagementAccountUserLinkUpdateCall.html), [*accounts list*](http://byron.github.io/google-apis-rs/google-analytics3/struct.ManagementAccountListCall.html), [*custom data sources list*](http://byron.github.io/google-apis-rs/google-analytics3/struct.ManagementCustomDataSourceListCall.html), [*custom dimensions get*](http://byron.github.io/google-apis-rs/google-analytics3/struct.ManagementCustomDimensionGetCall.html), [*custom dimensions insert*](http://byron.github.io/google-apis-rs/google-analytics3/struct.ManagementCustomDimensionInsertCall.html), [*custom dimensions list*](http://byron.github.io/google-apis-rs/google-analytics3/struct.ManagementCustomDimensionListCall.html), [*custom dimensions patch*](http://byron.github.io/google-apis-rs/google-analytics3/struct.ManagementCustomDimensionPatchCall.html), [*custom dimensions update*](http://byron.github.io/google-apis-rs/google-analytics3/struct.ManagementCustomDimensionUpdateCall.html), [*custom metrics get*](http://byron.github.io/google-apis-rs/google-analytics3/struct.ManagementCustomMetricGetCall.html), [*custom metrics insert*](http://byron.github.io/google-apis-rs/google-analytics3/struct.ManagementCustomMetricInsertCall.html), [*custom metrics list*](http://byron.github.io/google-apis-rs/google-analytics3/struct.ManagementCustomMetricListCall.html), [*custom metrics patch*](http://byron.github.io/google-apis-rs/google-analytics3/struct.ManagementCustomMetricPatchCall.html), [*custom metrics update*](http://byron.github.io/google-apis-rs/google-analytics3/struct.ManagementCustomMetricUpdateCall.html), [*experiments delete*](http://byron.github.io/google-apis-rs/google-analytics3/struct.ManagementExperimentDeleteCall.html), [*experiments get*](http://byron.github.io/google-apis-rs/google-analytics3/struct.ManagementExperimentGetCall.html), [*experiments insert*](http://byron.github.io/google-apis-rs/google-analytics3/struct.ManagementExperimentInsertCall.html), [*experiments list*](http://byron.github.io/google-apis-rs/google-analytics3/struct.ManagementExperimentListCall.html), [*experiments patch*](http://byron.github.io/google-apis-rs/google-analytics3/struct.ManagementExperimentPatchCall.html), [*experiments update*](http://byron.github.io/google-apis-rs/google-analytics3/struct.ManagementExperimentUpdateCall.html), [*filters delete*](http://byron.github.io/google-apis-rs/google-analytics3/struct.ManagementFilterDeleteCall.html), [*filters get*](http://byron.github.io/google-apis-rs/google-analytics3/struct.ManagementFilterGetCall.html), [*filters insert*](http://byron.github.io/google-apis-rs/google-analytics3/struct.ManagementFilterInsertCall.html), [*filters list*](http://byron.github.io/google-apis-rs/google-analytics3/struct.ManagementFilterListCall.html), [*filters patch*](http://byron.github.io/google-apis-rs/google-analytics3/struct.ManagementFilterPatchCall.html), [*filters update*](http://byron.github.io/google-apis-rs/google-analytics3/struct.ManagementFilterUpdateCall.html), [*goals get*](http://byron.github.io/google-apis-rs/google-analytics3/struct.ManagementGoalGetCall.html), [*goals insert*](http://byron.github.io/google-apis-rs/google-analytics3/struct.ManagementGoalInsertCall.html), [*goals list*](http://byron.github.io/google-apis-rs/google-analytics3/struct.ManagementGoalListCall.html), [*goals patch*](http://byron.github.io/google-apis-rs/google-analytics3/struct.ManagementGoalPatchCall.html), [*goals update*](http://byron.github.io/google-apis-rs/google-analytics3/struct.ManagementGoalUpdateCall.html), [*profile filter links delete*](http://byron.github.io/google-apis-rs/google-analytics3/struct.ManagementProfileFilterLinkDeleteCall.html), [*profile filter links get*](http://byron.github.io/google-apis-rs/google-analytics3/struct.ManagementProfileFilterLinkGetCall.html), [*profile filter links insert*](http://byron.github.io/google-apis-rs/google-analytics3/struct.ManagementProfileFilterLinkInsertCall.html), [*profile filter links list*](http://byron.github.io/google-apis-rs/google-analytics3/struct.ManagementProfileFilterLinkListCall.html), [*profile filter links patch*](http://byron.github.io/google-apis-rs/google-analytics3/struct.ManagementProfileFilterLinkPatchCall.html), [*profile filter links update*](http://byron.github.io/google-apis-rs/google-analytics3/struct.ManagementProfileFilterLinkUpdateCall.html), [*profile user links delete*](http://byron.github.io/google-apis-rs/google-analytics3/struct.ManagementProfileUserLinkDeleteCall.html), [*profile user links insert*](http://byron.github.io/google-apis-rs/google-analytics3/struct.ManagementProfileUserLinkInsertCall.html), [*profile user links list*](http://byron.github.io/google-apis-rs/google-analytics3/struct.ManagementProfileUserLinkListCall.html), [*profile user links update*](http://byron.github.io/google-apis-rs/google-analytics3/struct.ManagementProfileUserLinkUpdateCall.html), [*profiles delete*](http://byron.github.io/google-apis-rs/google-analytics3/struct.ManagementProfileDeleteCall.html), [*profiles get*](http://byron.github.io/google-apis-rs/google-analytics3/struct.ManagementProfileGetCall.html), [*profiles insert*](http://byron.github.io/google-apis-rs/google-analytics3/struct.ManagementProfileInsertCall.html), [*profiles list*](http://byron.github.io/google-apis-rs/google-analytics3/struct.ManagementProfileListCall.html), [*profiles patch*](http://byron.github.io/google-apis-rs/google-analytics3/struct.ManagementProfilePatchCall.html), [*profiles update*](http://byron.github.io/google-apis-rs/google-analytics3/struct.ManagementProfileUpdateCall.html), [*segments list*](http://byron.github.io/google-apis-rs/google-analytics3/struct.ManagementSegmentListCall.html), [*unsampled reports get*](http://byron.github.io/google-apis-rs/google-analytics3/struct.ManagementUnsampledReportGetCall.html), [*unsampled reports insert*](http://byron.github.io/google-apis-rs/google-analytics3/struct.ManagementUnsampledReportInsertCall.html), [*unsampled reports list*](http://byron.github.io/google-apis-rs/google-analytics3/struct.ManagementUnsampledReportListCall.html), [*uploads delete upload data*](http://byron.github.io/google-apis-rs/google-analytics3/struct.ManagementUploadDeleteUploadDataCall.html), [*uploads get*](http://byron.github.io/google-apis-rs/google-analytics3/struct.ManagementUploadGetCall.html), [*uploads list*](http://byron.github.io/google-apis-rs/google-analytics3/struct.ManagementUploadListCall.html), [*uploads upload data*](http://byron.github.io/google-apis-rs/google-analytics3/struct.ManagementUploadUploadDataCall.html), [*web property ad words links delete*](http://byron.github.io/google-apis-rs/google-analytics3/struct.ManagementWebPropertyAdWordsLinkDeleteCall.html), [*web property ad words links get*](http://byron.github.io/google-apis-rs/google-analytics3/struct.ManagementWebPropertyAdWordsLinkGetCall.html), [*web property ad words links insert*](http://byron.github.io/google-apis-rs/google-analytics3/struct.ManagementWebPropertyAdWordsLinkInsertCall.html), [*web property ad words links list*](http://byron.github.io/google-apis-rs/google-analytics3/struct.ManagementWebPropertyAdWordsLinkListCall.html), [*web property ad words links patch*](http://byron.github.io/google-apis-rs/google-analytics3/struct.ManagementWebPropertyAdWordsLinkPatchCall.html), [*web property ad words links update*](http://byron.github.io/google-apis-rs/google-analytics3/struct.ManagementWebPropertyAdWordsLinkUpdateCall.html), [*webproperties get*](http://byron.github.io/google-apis-rs/google-analytics3/struct.ManagementWebpropertyGetCall.html), [*webproperties insert*](http://byron.github.io/google-apis-rs/google-analytics3/struct.ManagementWebpropertyInsertCall.html), [*webproperties list*](http://byron.github.io/google-apis-rs/google-analytics3/struct.ManagementWebpropertyListCall.html), [*webproperties patch*](http://byron.github.io/google-apis-rs/google-analytics3/struct.ManagementWebpropertyPatchCall.html), [*webproperties update*](http://byron.github.io/google-apis-rs/google-analytics3/struct.ManagementWebpropertyUpdateCall.html), [*webproperty user links delete*](http://byron.github.io/google-apis-rs/google-analytics3/struct.ManagementWebpropertyUserLinkDeleteCall.html), [*webproperty user links insert*](http://byron.github.io/google-apis-rs/google-analytics3/struct.ManagementWebpropertyUserLinkInsertCall.html), [*webproperty user links list*](http://byron.github.io/google-apis-rs/google-analytics3/struct.ManagementWebpropertyUserLinkListCall.html) and [*webproperty user links update*](http://byron.github.io/google-apis-rs/google-analytics3/struct.ManagementWebpropertyUserLinkUpdateCall.html) + * [*account summaries list*](http://byron.github.io/google-apis-rs/google_analytics3/struct.ManagementAccountSummaryListCall.html), [*account user links delete*](http://byron.github.io/google-apis-rs/google_analytics3/struct.ManagementAccountUserLinkDeleteCall.html), [*account user links insert*](http://byron.github.io/google-apis-rs/google_analytics3/struct.ManagementAccountUserLinkInsertCall.html), [*account user links list*](http://byron.github.io/google-apis-rs/google_analytics3/struct.ManagementAccountUserLinkListCall.html), [*account user links update*](http://byron.github.io/google-apis-rs/google_analytics3/struct.ManagementAccountUserLinkUpdateCall.html), [*accounts list*](http://byron.github.io/google-apis-rs/google_analytics3/struct.ManagementAccountListCall.html), [*custom data sources list*](http://byron.github.io/google-apis-rs/google_analytics3/struct.ManagementCustomDataSourceListCall.html), [*custom dimensions get*](http://byron.github.io/google-apis-rs/google_analytics3/struct.ManagementCustomDimensionGetCall.html), [*custom dimensions insert*](http://byron.github.io/google-apis-rs/google_analytics3/struct.ManagementCustomDimensionInsertCall.html), [*custom dimensions list*](http://byron.github.io/google-apis-rs/google_analytics3/struct.ManagementCustomDimensionListCall.html), [*custom dimensions patch*](http://byron.github.io/google-apis-rs/google_analytics3/struct.ManagementCustomDimensionPatchCall.html), [*custom dimensions update*](http://byron.github.io/google-apis-rs/google_analytics3/struct.ManagementCustomDimensionUpdateCall.html), [*custom metrics get*](http://byron.github.io/google-apis-rs/google_analytics3/struct.ManagementCustomMetricGetCall.html), [*custom metrics insert*](http://byron.github.io/google-apis-rs/google_analytics3/struct.ManagementCustomMetricInsertCall.html), [*custom metrics list*](http://byron.github.io/google-apis-rs/google_analytics3/struct.ManagementCustomMetricListCall.html), [*custom metrics patch*](http://byron.github.io/google-apis-rs/google_analytics3/struct.ManagementCustomMetricPatchCall.html), [*custom metrics update*](http://byron.github.io/google-apis-rs/google_analytics3/struct.ManagementCustomMetricUpdateCall.html), [*experiments delete*](http://byron.github.io/google-apis-rs/google_analytics3/struct.ManagementExperimentDeleteCall.html), [*experiments get*](http://byron.github.io/google-apis-rs/google_analytics3/struct.ManagementExperimentGetCall.html), [*experiments insert*](http://byron.github.io/google-apis-rs/google_analytics3/struct.ManagementExperimentInsertCall.html), [*experiments list*](http://byron.github.io/google-apis-rs/google_analytics3/struct.ManagementExperimentListCall.html), [*experiments patch*](http://byron.github.io/google-apis-rs/google_analytics3/struct.ManagementExperimentPatchCall.html), [*experiments update*](http://byron.github.io/google-apis-rs/google_analytics3/struct.ManagementExperimentUpdateCall.html), [*filters delete*](http://byron.github.io/google-apis-rs/google_analytics3/struct.ManagementFilterDeleteCall.html), [*filters get*](http://byron.github.io/google-apis-rs/google_analytics3/struct.ManagementFilterGetCall.html), [*filters insert*](http://byron.github.io/google-apis-rs/google_analytics3/struct.ManagementFilterInsertCall.html), [*filters list*](http://byron.github.io/google-apis-rs/google_analytics3/struct.ManagementFilterListCall.html), [*filters patch*](http://byron.github.io/google-apis-rs/google_analytics3/struct.ManagementFilterPatchCall.html), [*filters update*](http://byron.github.io/google-apis-rs/google_analytics3/struct.ManagementFilterUpdateCall.html), [*goals get*](http://byron.github.io/google-apis-rs/google_analytics3/struct.ManagementGoalGetCall.html), [*goals insert*](http://byron.github.io/google-apis-rs/google_analytics3/struct.ManagementGoalInsertCall.html), [*goals list*](http://byron.github.io/google-apis-rs/google_analytics3/struct.ManagementGoalListCall.html), [*goals patch*](http://byron.github.io/google-apis-rs/google_analytics3/struct.ManagementGoalPatchCall.html), [*goals update*](http://byron.github.io/google-apis-rs/google_analytics3/struct.ManagementGoalUpdateCall.html), [*profile filter links delete*](http://byron.github.io/google-apis-rs/google_analytics3/struct.ManagementProfileFilterLinkDeleteCall.html), [*profile filter links get*](http://byron.github.io/google-apis-rs/google_analytics3/struct.ManagementProfileFilterLinkGetCall.html), [*profile filter links insert*](http://byron.github.io/google-apis-rs/google_analytics3/struct.ManagementProfileFilterLinkInsertCall.html), [*profile filter links list*](http://byron.github.io/google-apis-rs/google_analytics3/struct.ManagementProfileFilterLinkListCall.html), [*profile filter links patch*](http://byron.github.io/google-apis-rs/google_analytics3/struct.ManagementProfileFilterLinkPatchCall.html), [*profile filter links update*](http://byron.github.io/google-apis-rs/google_analytics3/struct.ManagementProfileFilterLinkUpdateCall.html), [*profile user links delete*](http://byron.github.io/google-apis-rs/google_analytics3/struct.ManagementProfileUserLinkDeleteCall.html), [*profile user links insert*](http://byron.github.io/google-apis-rs/google_analytics3/struct.ManagementProfileUserLinkInsertCall.html), [*profile user links list*](http://byron.github.io/google-apis-rs/google_analytics3/struct.ManagementProfileUserLinkListCall.html), [*profile user links update*](http://byron.github.io/google-apis-rs/google_analytics3/struct.ManagementProfileUserLinkUpdateCall.html), [*profiles delete*](http://byron.github.io/google-apis-rs/google_analytics3/struct.ManagementProfileDeleteCall.html), [*profiles get*](http://byron.github.io/google-apis-rs/google_analytics3/struct.ManagementProfileGetCall.html), [*profiles insert*](http://byron.github.io/google-apis-rs/google_analytics3/struct.ManagementProfileInsertCall.html), [*profiles list*](http://byron.github.io/google-apis-rs/google_analytics3/struct.ManagementProfileListCall.html), [*profiles patch*](http://byron.github.io/google-apis-rs/google_analytics3/struct.ManagementProfilePatchCall.html), [*profiles update*](http://byron.github.io/google-apis-rs/google_analytics3/struct.ManagementProfileUpdateCall.html), [*segments list*](http://byron.github.io/google-apis-rs/google_analytics3/struct.ManagementSegmentListCall.html), [*unsampled reports get*](http://byron.github.io/google-apis-rs/google_analytics3/struct.ManagementUnsampledReportGetCall.html), [*unsampled reports insert*](http://byron.github.io/google-apis-rs/google_analytics3/struct.ManagementUnsampledReportInsertCall.html), [*unsampled reports list*](http://byron.github.io/google-apis-rs/google_analytics3/struct.ManagementUnsampledReportListCall.html), [*uploads delete upload data*](http://byron.github.io/google-apis-rs/google_analytics3/struct.ManagementUploadDeleteUploadDataCall.html), [*uploads get*](http://byron.github.io/google-apis-rs/google_analytics3/struct.ManagementUploadGetCall.html), [*uploads list*](http://byron.github.io/google-apis-rs/google_analytics3/struct.ManagementUploadListCall.html), [*uploads upload data*](http://byron.github.io/google-apis-rs/google_analytics3/struct.ManagementUploadUploadDataCall.html), [*web property ad words links delete*](http://byron.github.io/google-apis-rs/google_analytics3/struct.ManagementWebPropertyAdWordsLinkDeleteCall.html), [*web property ad words links get*](http://byron.github.io/google-apis-rs/google_analytics3/struct.ManagementWebPropertyAdWordsLinkGetCall.html), [*web property ad words links insert*](http://byron.github.io/google-apis-rs/google_analytics3/struct.ManagementWebPropertyAdWordsLinkInsertCall.html), [*web property ad words links list*](http://byron.github.io/google-apis-rs/google_analytics3/struct.ManagementWebPropertyAdWordsLinkListCall.html), [*web property ad words links patch*](http://byron.github.io/google-apis-rs/google_analytics3/struct.ManagementWebPropertyAdWordsLinkPatchCall.html), [*web property ad words links update*](http://byron.github.io/google-apis-rs/google_analytics3/struct.ManagementWebPropertyAdWordsLinkUpdateCall.html), [*webproperties get*](http://byron.github.io/google-apis-rs/google_analytics3/struct.ManagementWebpropertyGetCall.html), [*webproperties insert*](http://byron.github.io/google-apis-rs/google_analytics3/struct.ManagementWebpropertyInsertCall.html), [*webproperties list*](http://byron.github.io/google-apis-rs/google_analytics3/struct.ManagementWebpropertyListCall.html), [*webproperties patch*](http://byron.github.io/google-apis-rs/google_analytics3/struct.ManagementWebpropertyPatchCall.html), [*webproperties update*](http://byron.github.io/google-apis-rs/google_analytics3/struct.ManagementWebpropertyUpdateCall.html), [*webproperty user links delete*](http://byron.github.io/google-apis-rs/google_analytics3/struct.ManagementWebpropertyUserLinkDeleteCall.html), [*webproperty user links insert*](http://byron.github.io/google-apis-rs/google_analytics3/struct.ManagementWebpropertyUserLinkInsertCall.html), [*webproperty user links list*](http://byron.github.io/google-apis-rs/google_analytics3/struct.ManagementWebpropertyUserLinkListCall.html) and [*webproperty user links update*](http://byron.github.io/google-apis-rs/google_analytics3/struct.ManagementWebpropertyUserLinkUpdateCall.html) * metadata - * [*columns list*](http://byron.github.io/google-apis-rs/google-analytics3/struct.MetadataColumnListCall.html) + * [*columns list*](http://byron.github.io/google-apis-rs/google_analytics3/struct.MetadataColumnListCall.html) * provisioning - * [*create account ticket*](http://byron.github.io/google-apis-rs/google-analytics3/struct.ProvisioningCreateAccountTicketCall.html) + * [*create account ticket*](http://byron.github.io/google-apis-rs/google_analytics3/struct.ProvisioningCreateAccountTicketCall.html) Upload supported by ... -* [*uploads upload data management*](http://byron.github.io/google-apis-rs/google-analytics3/struct.ManagementUploadUploadDataCall.html) +* [*uploads upload data management*](http://byron.github.io/google-apis-rs/google_analytics3/struct.ManagementUploadUploadDataCall.html) @@ -33,17 +33,17 @@ Upload supported by ... The API is structured into the following primary items: -* **[Hub](http://byron.github.io/google-apis-rs/google-analytics3/struct.Analytics.html)** +* **[Hub](http://byron.github.io/google-apis-rs/google_analytics3/struct.Analytics.html)** * a central object to maintain state and allow accessing all *Activities* - * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google-analytics3/trait.MethodsBuilder.html) which in turn - allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google-analytics3/trait.CallBuilder.html) -* **[Resources](http://byron.github.io/google-apis-rs/google-analytics3/trait.Resource.html)** + * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google_analytics3/trait.MethodsBuilder.html) which in turn + allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google_analytics3/trait.CallBuilder.html) +* **[Resources](http://byron.github.io/google-apis-rs/google_analytics3/trait.Resource.html)** * primary types that you can apply *Activities* to * a collection of properties and *Parts* - * **[Parts](http://byron.github.io/google-apis-rs/google-analytics3/trait.Part.html)** + * **[Parts](http://byron.github.io/google-apis-rs/google_analytics3/trait.Part.html)** * a collection of properties * never directly used in *Activities* -* **[Activities](http://byron.github.io/google-apis-rs/google-analytics3/trait.CallBuilder.html)** +* **[Activities](http://byron.github.io/google-apis-rs/google_analytics3/trait.CallBuilder.html)** * operations to apply to *Resources* All *structures* are marked with applicable traits to further categorize them and ease browsing. @@ -133,17 +133,17 @@ match result { ``` ## Handling Errors -All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google-analytics3/enum.Result.html) enumeration as return value of +All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google_analytics3/enum.Result.html) enumeration as return value of the doit() methods, or handed as possibly intermediate results to either the -[Hub Delegate](http://byron.github.io/google-apis-rs/google-analytics3/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google-analytics3/../yup-oauth2/trait.AuthenticatorDelegate.html). +[Hub Delegate](http://byron.github.io/google-apis-rs/google_analytics3/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google_analytics3/../yup-oauth2/trait.AuthenticatorDelegate.html). 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](http://byron.github.io/google-apis-rs/google-analytics3/enum.Result.html), should be +If a method supports downloads, the response body, which is part of the [Result](http://byron.github.io/google-apis-rs/google_analytics3/enum.Result.html), should be read by you to obtain the media. -If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google-analytics3/trait.ResponseResult.html), it will return that by default. +If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google_analytics3/trait.ResponseResult.html), 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")`. @@ -153,29 +153,29 @@ Methods supporting uploads can do so using up to 2 different protocols: ## Customization and Callbacks -You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google-analytics3/trait.Delegate.html) to the -[Method Builder](http://byron.github.io/google-apis-rs/google-analytics3/trait.CallBuilder.html) before making the final `doit()` call. +You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google_analytics3/trait.Delegate.html) to the +[Method Builder](http://byron.github.io/google-apis-rs/google_analytics3/trait.CallBuilder.html) 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](http://byron.github.io/google-apis-rs/google-analytics3/trait.Delegate.html) is default-implemented, allowing you to customize it with minimal effort. +The [delegate trait](http://byron.github.io/google-apis-rs/google_analytics3/trait.Delegate.html) 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](http://byron.github.io/google-apis-rs/google-analytics3/trait.RequestValue.html) and -[decodable](http://byron.github.io/google-apis-rs/google-analytics3/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses +All structures provided by this library are made to be [enocodable](http://byron.github.io/google-apis-rs/google_analytics3/trait.RequestValue.html) and +[decodable](http://byron.github.io/google-apis-rs/google_analytics3/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses are valid. -Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google-analytics3/trait.Part.html) which are identifiable by name, which will be sent to +Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google_analytics3/trait.Part.html) 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](http://byron.github.io/google-apis-rs/google-analytics3/trait.CallBuilder.html), you are able to prepare an action call by repeatedly calling it's methods. +Using [method builders](http://byron.github.io/google-apis-rs/google_analytics3/trait.CallBuilder.html), 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][wiki-pod] are handed by copy * strings are passed as `&str` -* [request values](http://byron.github.io/google-apis-rs/google-analytics3/trait.RequestValue.html) are borrowed +* [request values](http://byron.github.io/google-apis-rs/google_analytics3/trait.RequestValue.html) are borrowed Arguments will always be copied or cloned into the builder, to make them independent of their original life times. diff --git a/gen/androidenterprise1/README.md b/gen/androidenterprise1/README.md index f562663f85..1527e9882a 100644 --- a/gen/androidenterprise1/README.md +++ b/gen/androidenterprise1/README.md @@ -8,30 +8,30 @@ The `google-androidenterprise1` library allows access to all features of the *Go This documentation was generated from *Android Enterprise* crate version *0.1.5+20150309*, where *20150309* is the exact revision of the *androidenterprise:v1* schema built by the [mako](http://www.makotemplates.org/) code generator *v0.1.5*. # Features -Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google-androidenterprise1/struct.AndroidEnterprise.html) ... +Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google_androidenterprise1/struct.AndroidEnterprise.html) ... -* [collections](http://byron.github.io/google-apis-rs/google-androidenterprise1/struct.Collection.html) - * [*delete*](http://byron.github.io/google-apis-rs/google-androidenterprise1/struct.CollectionDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google-androidenterprise1/struct.CollectionGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google-androidenterprise1/struct.CollectionInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google-androidenterprise1/struct.CollectionListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google-androidenterprise1/struct.CollectionPatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google-androidenterprise1/struct.CollectionUpdateCall.html) +* [collections](http://byron.github.io/google-apis-rs/google_androidenterprise1/struct.Collection.html) + * [*delete*](http://byron.github.io/google-apis-rs/google_androidenterprise1/struct.CollectionDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google_androidenterprise1/struct.CollectionGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google_androidenterprise1/struct.CollectionInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google_androidenterprise1/struct.CollectionListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google_androidenterprise1/struct.CollectionPatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google_androidenterprise1/struct.CollectionUpdateCall.html) * collectionviewers - * [*delete*](http://byron.github.io/google-apis-rs/google-androidenterprise1/struct.CollectionviewerDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google-androidenterprise1/struct.CollectionviewerGetCall.html), [*list*](http://byron.github.io/google-apis-rs/google-androidenterprise1/struct.CollectionviewerListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google-androidenterprise1/struct.CollectionviewerPatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google-androidenterprise1/struct.CollectionviewerUpdateCall.html) -* [devices](http://byron.github.io/google-apis-rs/google-androidenterprise1/struct.Device.html) - * [*get*](http://byron.github.io/google-apis-rs/google-androidenterprise1/struct.DeviceGetCall.html), [*get state*](http://byron.github.io/google-apis-rs/google-androidenterprise1/struct.DeviceGetStateCall.html), [*list*](http://byron.github.io/google-apis-rs/google-androidenterprise1/struct.DeviceListCall.html) and [*set state*](http://byron.github.io/google-apis-rs/google-androidenterprise1/struct.DeviceSetStateCall.html) -* [enterprises](http://byron.github.io/google-apis-rs/google-androidenterprise1/struct.Enterprise.html) - * [*delete*](http://byron.github.io/google-apis-rs/google-androidenterprise1/struct.EnterpriseDeleteCall.html), [*enroll*](http://byron.github.io/google-apis-rs/google-androidenterprise1/struct.EnterpriseEnrollCall.html), [*get*](http://byron.github.io/google-apis-rs/google-androidenterprise1/struct.EnterpriseGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google-androidenterprise1/struct.EnterpriseInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google-androidenterprise1/struct.EnterpriseListCall.html), [*set account*](http://byron.github.io/google-apis-rs/google-androidenterprise1/struct.EnterpriseSetAccountCall.html) and [*unenroll*](http://byron.github.io/google-apis-rs/google-androidenterprise1/struct.EnterpriseUnenrollCall.html) -* [entitlements](http://byron.github.io/google-apis-rs/google-androidenterprise1/struct.Entitlement.html) - * [*delete*](http://byron.github.io/google-apis-rs/google-androidenterprise1/struct.EntitlementDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google-androidenterprise1/struct.EntitlementGetCall.html), [*list*](http://byron.github.io/google-apis-rs/google-androidenterprise1/struct.EntitlementListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google-androidenterprise1/struct.EntitlementPatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google-androidenterprise1/struct.EntitlementUpdateCall.html) + * [*delete*](http://byron.github.io/google-apis-rs/google_androidenterprise1/struct.CollectionviewerDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google_androidenterprise1/struct.CollectionviewerGetCall.html), [*list*](http://byron.github.io/google-apis-rs/google_androidenterprise1/struct.CollectionviewerListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google_androidenterprise1/struct.CollectionviewerPatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google_androidenterprise1/struct.CollectionviewerUpdateCall.html) +* [devices](http://byron.github.io/google-apis-rs/google_androidenterprise1/struct.Device.html) + * [*get*](http://byron.github.io/google-apis-rs/google_androidenterprise1/struct.DeviceGetCall.html), [*get state*](http://byron.github.io/google-apis-rs/google_androidenterprise1/struct.DeviceGetStateCall.html), [*list*](http://byron.github.io/google-apis-rs/google_androidenterprise1/struct.DeviceListCall.html) and [*set state*](http://byron.github.io/google-apis-rs/google_androidenterprise1/struct.DeviceSetStateCall.html) +* [enterprises](http://byron.github.io/google-apis-rs/google_androidenterprise1/struct.Enterprise.html) + * [*delete*](http://byron.github.io/google-apis-rs/google_androidenterprise1/struct.EnterpriseDeleteCall.html), [*enroll*](http://byron.github.io/google-apis-rs/google_androidenterprise1/struct.EnterpriseEnrollCall.html), [*get*](http://byron.github.io/google-apis-rs/google_androidenterprise1/struct.EnterpriseGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google_androidenterprise1/struct.EnterpriseInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google_androidenterprise1/struct.EnterpriseListCall.html), [*set account*](http://byron.github.io/google-apis-rs/google_androidenterprise1/struct.EnterpriseSetAccountCall.html) and [*unenroll*](http://byron.github.io/google-apis-rs/google_androidenterprise1/struct.EnterpriseUnenrollCall.html) +* [entitlements](http://byron.github.io/google-apis-rs/google_androidenterprise1/struct.Entitlement.html) + * [*delete*](http://byron.github.io/google-apis-rs/google_androidenterprise1/struct.EntitlementDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google_androidenterprise1/struct.EntitlementGetCall.html), [*list*](http://byron.github.io/google-apis-rs/google_androidenterprise1/struct.EntitlementListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google_androidenterprise1/struct.EntitlementPatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google_androidenterprise1/struct.EntitlementUpdateCall.html) * grouplicenses - * [*get*](http://byron.github.io/google-apis-rs/google-androidenterprise1/struct.GrouplicenseGetCall.html) and [*list*](http://byron.github.io/google-apis-rs/google-androidenterprise1/struct.GrouplicenseListCall.html) + * [*get*](http://byron.github.io/google-apis-rs/google_androidenterprise1/struct.GrouplicenseGetCall.html) and [*list*](http://byron.github.io/google-apis-rs/google_androidenterprise1/struct.GrouplicenseListCall.html) * grouplicenseusers - * [*list*](http://byron.github.io/google-apis-rs/google-androidenterprise1/struct.GrouplicenseuserListCall.html) -* [installs](http://byron.github.io/google-apis-rs/google-androidenterprise1/struct.Install.html) - * [*delete*](http://byron.github.io/google-apis-rs/google-androidenterprise1/struct.InstallDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google-androidenterprise1/struct.InstallGetCall.html), [*list*](http://byron.github.io/google-apis-rs/google-androidenterprise1/struct.InstallListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google-androidenterprise1/struct.InstallPatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google-androidenterprise1/struct.InstallUpdateCall.html) -* [permissions](http://byron.github.io/google-apis-rs/google-androidenterprise1/struct.Permission.html) - * [*get*](http://byron.github.io/google-apis-rs/google-androidenterprise1/struct.PermissionGetCall.html) -* [products](http://byron.github.io/google-apis-rs/google-androidenterprise1/struct.Product.html) - * [*get*](http://byron.github.io/google-apis-rs/google-androidenterprise1/struct.ProductGetCall.html), [*get app restrictions schema*](http://byron.github.io/google-apis-rs/google-androidenterprise1/struct.ProductGetAppRestrictionsSchemaCall.html), [*get permissions*](http://byron.github.io/google-apis-rs/google-androidenterprise1/struct.ProductGetPermissionCall.html) and [*update permissions*](http://byron.github.io/google-apis-rs/google-androidenterprise1/struct.ProductUpdatePermissionCall.html) -* [users](http://byron.github.io/google-apis-rs/google-androidenterprise1/struct.User.html) - * [*generate token*](http://byron.github.io/google-apis-rs/google-androidenterprise1/struct.UserGenerateTokenCall.html), [*get*](http://byron.github.io/google-apis-rs/google-androidenterprise1/struct.UserGetCall.html), [*list*](http://byron.github.io/google-apis-rs/google-androidenterprise1/struct.UserListCall.html) and [*revoke token*](http://byron.github.io/google-apis-rs/google-androidenterprise1/struct.UserRevokeTokenCall.html) + * [*list*](http://byron.github.io/google-apis-rs/google_androidenterprise1/struct.GrouplicenseuserListCall.html) +* [installs](http://byron.github.io/google-apis-rs/google_androidenterprise1/struct.Install.html) + * [*delete*](http://byron.github.io/google-apis-rs/google_androidenterprise1/struct.InstallDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google_androidenterprise1/struct.InstallGetCall.html), [*list*](http://byron.github.io/google-apis-rs/google_androidenterprise1/struct.InstallListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google_androidenterprise1/struct.InstallPatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google_androidenterprise1/struct.InstallUpdateCall.html) +* [permissions](http://byron.github.io/google-apis-rs/google_androidenterprise1/struct.Permission.html) + * [*get*](http://byron.github.io/google-apis-rs/google_androidenterprise1/struct.PermissionGetCall.html) +* [products](http://byron.github.io/google-apis-rs/google_androidenterprise1/struct.Product.html) + * [*get*](http://byron.github.io/google-apis-rs/google_androidenterprise1/struct.ProductGetCall.html), [*get app restrictions schema*](http://byron.github.io/google-apis-rs/google_androidenterprise1/struct.ProductGetAppRestrictionsSchemaCall.html), [*get permissions*](http://byron.github.io/google-apis-rs/google_androidenterprise1/struct.ProductGetPermissionCall.html) and [*update permissions*](http://byron.github.io/google-apis-rs/google_androidenterprise1/struct.ProductUpdatePermissionCall.html) +* [users](http://byron.github.io/google-apis-rs/google_androidenterprise1/struct.User.html) + * [*generate token*](http://byron.github.io/google-apis-rs/google_androidenterprise1/struct.UserGenerateTokenCall.html), [*get*](http://byron.github.io/google-apis-rs/google_androidenterprise1/struct.UserGetCall.html), [*list*](http://byron.github.io/google-apis-rs/google_androidenterprise1/struct.UserListCall.html) and [*revoke token*](http://byron.github.io/google-apis-rs/google_androidenterprise1/struct.UserRevokeTokenCall.html) @@ -40,17 +40,17 @@ Handle the following *Resources* with ease from the central [hub](http://byron.g The API is structured into the following primary items: -* **[Hub](http://byron.github.io/google-apis-rs/google-androidenterprise1/struct.AndroidEnterprise.html)** +* **[Hub](http://byron.github.io/google-apis-rs/google_androidenterprise1/struct.AndroidEnterprise.html)** * a central object to maintain state and allow accessing all *Activities* - * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google-androidenterprise1/trait.MethodsBuilder.html) which in turn - allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google-androidenterprise1/trait.CallBuilder.html) -* **[Resources](http://byron.github.io/google-apis-rs/google-androidenterprise1/trait.Resource.html)** + * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google_androidenterprise1/trait.MethodsBuilder.html) which in turn + allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google_androidenterprise1/trait.CallBuilder.html) +* **[Resources](http://byron.github.io/google-apis-rs/google_androidenterprise1/trait.Resource.html)** * primary types that you can apply *Activities* to * a collection of properties and *Parts* - * **[Parts](http://byron.github.io/google-apis-rs/google-androidenterprise1/trait.Part.html)** + * **[Parts](http://byron.github.io/google-apis-rs/google_androidenterprise1/trait.Part.html)** * a collection of properties * never directly used in *Activities* -* **[Activities](http://byron.github.io/google-apis-rs/google-androidenterprise1/trait.CallBuilder.html)** +* **[Activities](http://byron.github.io/google-apis-rs/google_androidenterprise1/trait.CallBuilder.html)** * operations to apply to *Resources* All *structures* are marked with applicable traits to further categorize them and ease browsing. @@ -141,17 +141,17 @@ match result { ``` ## Handling Errors -All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google-androidenterprise1/enum.Result.html) enumeration as return value of +All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google_androidenterprise1/enum.Result.html) enumeration as return value of the doit() methods, or handed as possibly intermediate results to either the -[Hub Delegate](http://byron.github.io/google-apis-rs/google-androidenterprise1/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google-androidenterprise1/../yup-oauth2/trait.AuthenticatorDelegate.html). +[Hub Delegate](http://byron.github.io/google-apis-rs/google_androidenterprise1/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google_androidenterprise1/../yup-oauth2/trait.AuthenticatorDelegate.html). 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](http://byron.github.io/google-apis-rs/google-androidenterprise1/enum.Result.html), should be +If a method supports downloads, the response body, which is part of the [Result](http://byron.github.io/google-apis-rs/google_androidenterprise1/enum.Result.html), should be read by you to obtain the media. -If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google-androidenterprise1/trait.ResponseResult.html), it will return that by default. +If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google_androidenterprise1/trait.ResponseResult.html), 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")`. @@ -161,29 +161,29 @@ Methods supporting uploads can do so using up to 2 different protocols: ## Customization and Callbacks -You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google-androidenterprise1/trait.Delegate.html) to the -[Method Builder](http://byron.github.io/google-apis-rs/google-androidenterprise1/trait.CallBuilder.html) before making the final `doit()` call. +You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google_androidenterprise1/trait.Delegate.html) to the +[Method Builder](http://byron.github.io/google-apis-rs/google_androidenterprise1/trait.CallBuilder.html) 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](http://byron.github.io/google-apis-rs/google-androidenterprise1/trait.Delegate.html) is default-implemented, allowing you to customize it with minimal effort. +The [delegate trait](http://byron.github.io/google-apis-rs/google_androidenterprise1/trait.Delegate.html) 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](http://byron.github.io/google-apis-rs/google-androidenterprise1/trait.RequestValue.html) and -[decodable](http://byron.github.io/google-apis-rs/google-androidenterprise1/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses +All structures provided by this library are made to be [enocodable](http://byron.github.io/google-apis-rs/google_androidenterprise1/trait.RequestValue.html) and +[decodable](http://byron.github.io/google-apis-rs/google_androidenterprise1/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses are valid. -Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google-androidenterprise1/trait.Part.html) which are identifiable by name, which will be sent to +Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google_androidenterprise1/trait.Part.html) 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](http://byron.github.io/google-apis-rs/google-androidenterprise1/trait.CallBuilder.html), you are able to prepare an action call by repeatedly calling it's methods. +Using [method builders](http://byron.github.io/google-apis-rs/google_androidenterprise1/trait.CallBuilder.html), 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][wiki-pod] are handed by copy * strings are passed as `&str` -* [request values](http://byron.github.io/google-apis-rs/google-androidenterprise1/trait.RequestValue.html) are borrowed +* [request values](http://byron.github.io/google-apis-rs/google_androidenterprise1/trait.RequestValue.html) are borrowed Arguments will always be copied or cloned into the builder, to make them independent of their original life times. diff --git a/gen/androidpublisher2/README.md b/gen/androidpublisher2/README.md index b59d301e13..1a69400655 100644 --- a/gen/androidpublisher2/README.md +++ b/gen/androidpublisher2/README.md @@ -11,21 +11,21 @@ Everything else about the *Android Publisher* *v2* API can be found at the [official documentation site](https://developers.google.com/android-publisher). # Features -Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google-androidpublisher2/struct.AndroidPublisher.html) ... +Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google_androidpublisher2/struct.AndroidPublisher.html) ... * edits - * [*apklistings delete*](http://byron.github.io/google-apis-rs/google-androidpublisher2/struct.EditApklistingDeleteCall.html), [*apklistings deleteall*](http://byron.github.io/google-apis-rs/google-androidpublisher2/struct.EditApklistingDeleteallCall.html), [*apklistings get*](http://byron.github.io/google-apis-rs/google-androidpublisher2/struct.EditApklistingGetCall.html), [*apklistings list*](http://byron.github.io/google-apis-rs/google-androidpublisher2/struct.EditApklistingListCall.html), [*apklistings patch*](http://byron.github.io/google-apis-rs/google-androidpublisher2/struct.EditApklistingPatchCall.html), [*apklistings update*](http://byron.github.io/google-apis-rs/google-androidpublisher2/struct.EditApklistingUpdateCall.html), [*apks addexternallyhosted*](http://byron.github.io/google-apis-rs/google-androidpublisher2/struct.EditApkAddexternallyhostedCall.html), [*apks list*](http://byron.github.io/google-apis-rs/google-androidpublisher2/struct.EditApkListCall.html), [*apks upload*](http://byron.github.io/google-apis-rs/google-androidpublisher2/struct.EditApkUploadCall.html), [*commit*](http://byron.github.io/google-apis-rs/google-androidpublisher2/struct.EditCommitCall.html), [*delete*](http://byron.github.io/google-apis-rs/google-androidpublisher2/struct.EditDeleteCall.html), [*details get*](http://byron.github.io/google-apis-rs/google-androidpublisher2/struct.EditDetailGetCall.html), [*details patch*](http://byron.github.io/google-apis-rs/google-androidpublisher2/struct.EditDetailPatchCall.html), [*details update*](http://byron.github.io/google-apis-rs/google-androidpublisher2/struct.EditDetailUpdateCall.html), [*expansionfiles get*](http://byron.github.io/google-apis-rs/google-androidpublisher2/struct.EditExpansionfileGetCall.html), [*expansionfiles patch*](http://byron.github.io/google-apis-rs/google-androidpublisher2/struct.EditExpansionfilePatchCall.html), [*expansionfiles update*](http://byron.github.io/google-apis-rs/google-androidpublisher2/struct.EditExpansionfileUpdateCall.html), [*expansionfiles upload*](http://byron.github.io/google-apis-rs/google-androidpublisher2/struct.EditExpansionfileUploadCall.html), [*get*](http://byron.github.io/google-apis-rs/google-androidpublisher2/struct.EditGetCall.html), [*images delete*](http://byron.github.io/google-apis-rs/google-androidpublisher2/struct.EditImageDeleteCall.html), [*images deleteall*](http://byron.github.io/google-apis-rs/google-androidpublisher2/struct.EditImageDeleteallCall.html), [*images list*](http://byron.github.io/google-apis-rs/google-androidpublisher2/struct.EditImageListCall.html), [*images upload*](http://byron.github.io/google-apis-rs/google-androidpublisher2/struct.EditImageUploadCall.html), [*insert*](http://byron.github.io/google-apis-rs/google-androidpublisher2/struct.EditInsertCall.html), [*listings delete*](http://byron.github.io/google-apis-rs/google-androidpublisher2/struct.EditListingDeleteCall.html), [*listings deleteall*](http://byron.github.io/google-apis-rs/google-androidpublisher2/struct.EditListingDeleteallCall.html), [*listings get*](http://byron.github.io/google-apis-rs/google-androidpublisher2/struct.EditListingGetCall.html), [*listings list*](http://byron.github.io/google-apis-rs/google-androidpublisher2/struct.EditListingListCall.html), [*listings patch*](http://byron.github.io/google-apis-rs/google-androidpublisher2/struct.EditListingPatchCall.html), [*listings update*](http://byron.github.io/google-apis-rs/google-androidpublisher2/struct.EditListingUpdateCall.html), [*testers get*](http://byron.github.io/google-apis-rs/google-androidpublisher2/struct.EditTesterGetCall.html), [*testers patch*](http://byron.github.io/google-apis-rs/google-androidpublisher2/struct.EditTesterPatchCall.html), [*testers update*](http://byron.github.io/google-apis-rs/google-androidpublisher2/struct.EditTesterUpdateCall.html), [*tracks get*](http://byron.github.io/google-apis-rs/google-androidpublisher2/struct.EditTrackGetCall.html), [*tracks list*](http://byron.github.io/google-apis-rs/google-androidpublisher2/struct.EditTrackListCall.html), [*tracks patch*](http://byron.github.io/google-apis-rs/google-androidpublisher2/struct.EditTrackPatchCall.html), [*tracks update*](http://byron.github.io/google-apis-rs/google-androidpublisher2/struct.EditTrackUpdateCall.html) and [*validate*](http://byron.github.io/google-apis-rs/google-androidpublisher2/struct.EditValidateCall.html) + * [*apklistings delete*](http://byron.github.io/google-apis-rs/google_androidpublisher2/struct.EditApklistingDeleteCall.html), [*apklistings deleteall*](http://byron.github.io/google-apis-rs/google_androidpublisher2/struct.EditApklistingDeleteallCall.html), [*apklistings get*](http://byron.github.io/google-apis-rs/google_androidpublisher2/struct.EditApklistingGetCall.html), [*apklistings list*](http://byron.github.io/google-apis-rs/google_androidpublisher2/struct.EditApklistingListCall.html), [*apklistings patch*](http://byron.github.io/google-apis-rs/google_androidpublisher2/struct.EditApklistingPatchCall.html), [*apklistings update*](http://byron.github.io/google-apis-rs/google_androidpublisher2/struct.EditApklistingUpdateCall.html), [*apks addexternallyhosted*](http://byron.github.io/google-apis-rs/google_androidpublisher2/struct.EditApkAddexternallyhostedCall.html), [*apks list*](http://byron.github.io/google-apis-rs/google_androidpublisher2/struct.EditApkListCall.html), [*apks upload*](http://byron.github.io/google-apis-rs/google_androidpublisher2/struct.EditApkUploadCall.html), [*commit*](http://byron.github.io/google-apis-rs/google_androidpublisher2/struct.EditCommitCall.html), [*delete*](http://byron.github.io/google-apis-rs/google_androidpublisher2/struct.EditDeleteCall.html), [*details get*](http://byron.github.io/google-apis-rs/google_androidpublisher2/struct.EditDetailGetCall.html), [*details patch*](http://byron.github.io/google-apis-rs/google_androidpublisher2/struct.EditDetailPatchCall.html), [*details update*](http://byron.github.io/google-apis-rs/google_androidpublisher2/struct.EditDetailUpdateCall.html), [*expansionfiles get*](http://byron.github.io/google-apis-rs/google_androidpublisher2/struct.EditExpansionfileGetCall.html), [*expansionfiles patch*](http://byron.github.io/google-apis-rs/google_androidpublisher2/struct.EditExpansionfilePatchCall.html), [*expansionfiles update*](http://byron.github.io/google-apis-rs/google_androidpublisher2/struct.EditExpansionfileUpdateCall.html), [*expansionfiles upload*](http://byron.github.io/google-apis-rs/google_androidpublisher2/struct.EditExpansionfileUploadCall.html), [*get*](http://byron.github.io/google-apis-rs/google_androidpublisher2/struct.EditGetCall.html), [*images delete*](http://byron.github.io/google-apis-rs/google_androidpublisher2/struct.EditImageDeleteCall.html), [*images deleteall*](http://byron.github.io/google-apis-rs/google_androidpublisher2/struct.EditImageDeleteallCall.html), [*images list*](http://byron.github.io/google-apis-rs/google_androidpublisher2/struct.EditImageListCall.html), [*images upload*](http://byron.github.io/google-apis-rs/google_androidpublisher2/struct.EditImageUploadCall.html), [*insert*](http://byron.github.io/google-apis-rs/google_androidpublisher2/struct.EditInsertCall.html), [*listings delete*](http://byron.github.io/google-apis-rs/google_androidpublisher2/struct.EditListingDeleteCall.html), [*listings deleteall*](http://byron.github.io/google-apis-rs/google_androidpublisher2/struct.EditListingDeleteallCall.html), [*listings get*](http://byron.github.io/google-apis-rs/google_androidpublisher2/struct.EditListingGetCall.html), [*listings list*](http://byron.github.io/google-apis-rs/google_androidpublisher2/struct.EditListingListCall.html), [*listings patch*](http://byron.github.io/google-apis-rs/google_androidpublisher2/struct.EditListingPatchCall.html), [*listings update*](http://byron.github.io/google-apis-rs/google_androidpublisher2/struct.EditListingUpdateCall.html), [*testers get*](http://byron.github.io/google-apis-rs/google_androidpublisher2/struct.EditTesterGetCall.html), [*testers patch*](http://byron.github.io/google-apis-rs/google_androidpublisher2/struct.EditTesterPatchCall.html), [*testers update*](http://byron.github.io/google-apis-rs/google_androidpublisher2/struct.EditTesterUpdateCall.html), [*tracks get*](http://byron.github.io/google-apis-rs/google_androidpublisher2/struct.EditTrackGetCall.html), [*tracks list*](http://byron.github.io/google-apis-rs/google_androidpublisher2/struct.EditTrackListCall.html), [*tracks patch*](http://byron.github.io/google-apis-rs/google_androidpublisher2/struct.EditTrackPatchCall.html), [*tracks update*](http://byron.github.io/google-apis-rs/google_androidpublisher2/struct.EditTrackUpdateCall.html) and [*validate*](http://byron.github.io/google-apis-rs/google_androidpublisher2/struct.EditValidateCall.html) * inappproducts - * [*batch*](http://byron.github.io/google-apis-rs/google-androidpublisher2/struct.InappproductBatchCall.html), [*delete*](http://byron.github.io/google-apis-rs/google-androidpublisher2/struct.InappproductDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google-androidpublisher2/struct.InappproductGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google-androidpublisher2/struct.InappproductInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google-androidpublisher2/struct.InappproductListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google-androidpublisher2/struct.InappproductPatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google-androidpublisher2/struct.InappproductUpdateCall.html) + * [*batch*](http://byron.github.io/google-apis-rs/google_androidpublisher2/struct.InappproductBatchCall.html), [*delete*](http://byron.github.io/google-apis-rs/google_androidpublisher2/struct.InappproductDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google_androidpublisher2/struct.InappproductGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google_androidpublisher2/struct.InappproductInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google_androidpublisher2/struct.InappproductListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google_androidpublisher2/struct.InappproductPatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google_androidpublisher2/struct.InappproductUpdateCall.html) * purchases - * [*products get*](http://byron.github.io/google-apis-rs/google-androidpublisher2/struct.PurchaseProductGetCall.html), [*subscriptions cancel*](http://byron.github.io/google-apis-rs/google-androidpublisher2/struct.PurchaseSubscriptionCancelCall.html), [*subscriptions defer*](http://byron.github.io/google-apis-rs/google-androidpublisher2/struct.PurchaseSubscriptionDeferCall.html), [*subscriptions get*](http://byron.github.io/google-apis-rs/google-androidpublisher2/struct.PurchaseSubscriptionGetCall.html), [*subscriptions refund*](http://byron.github.io/google-apis-rs/google-androidpublisher2/struct.PurchaseSubscriptionRefundCall.html) and [*subscriptions revoke*](http://byron.github.io/google-apis-rs/google-androidpublisher2/struct.PurchaseSubscriptionRevokeCall.html) + * [*products get*](http://byron.github.io/google-apis-rs/google_androidpublisher2/struct.PurchaseProductGetCall.html), [*subscriptions cancel*](http://byron.github.io/google-apis-rs/google_androidpublisher2/struct.PurchaseSubscriptionCancelCall.html), [*subscriptions defer*](http://byron.github.io/google-apis-rs/google_androidpublisher2/struct.PurchaseSubscriptionDeferCall.html), [*subscriptions get*](http://byron.github.io/google-apis-rs/google_androidpublisher2/struct.PurchaseSubscriptionGetCall.html), [*subscriptions refund*](http://byron.github.io/google-apis-rs/google_androidpublisher2/struct.PurchaseSubscriptionRefundCall.html) and [*subscriptions revoke*](http://byron.github.io/google-apis-rs/google_androidpublisher2/struct.PurchaseSubscriptionRevokeCall.html) Upload supported by ... -* [*images upload edits*](http://byron.github.io/google-apis-rs/google-androidpublisher2/struct.EditImageUploadCall.html) -* [*expansionfiles upload edits*](http://byron.github.io/google-apis-rs/google-androidpublisher2/struct.EditExpansionfileUploadCall.html) -* [*apks upload edits*](http://byron.github.io/google-apis-rs/google-androidpublisher2/struct.EditApkUploadCall.html) +* [*images upload edits*](http://byron.github.io/google-apis-rs/google_androidpublisher2/struct.EditImageUploadCall.html) +* [*expansionfiles upload edits*](http://byron.github.io/google-apis-rs/google_androidpublisher2/struct.EditExpansionfileUploadCall.html) +* [*apks upload edits*](http://byron.github.io/google-apis-rs/google_androidpublisher2/struct.EditApkUploadCall.html) @@ -33,17 +33,17 @@ Upload supported by ... The API is structured into the following primary items: -* **[Hub](http://byron.github.io/google-apis-rs/google-androidpublisher2/struct.AndroidPublisher.html)** +* **[Hub](http://byron.github.io/google-apis-rs/google_androidpublisher2/struct.AndroidPublisher.html)** * a central object to maintain state and allow accessing all *Activities* - * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google-androidpublisher2/trait.MethodsBuilder.html) which in turn - allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google-androidpublisher2/trait.CallBuilder.html) -* **[Resources](http://byron.github.io/google-apis-rs/google-androidpublisher2/trait.Resource.html)** + * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google_androidpublisher2/trait.MethodsBuilder.html) which in turn + allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google_androidpublisher2/trait.CallBuilder.html) +* **[Resources](http://byron.github.io/google-apis-rs/google_androidpublisher2/trait.Resource.html)** * primary types that you can apply *Activities* to * a collection of properties and *Parts* - * **[Parts](http://byron.github.io/google-apis-rs/google-androidpublisher2/trait.Part.html)** + * **[Parts](http://byron.github.io/google-apis-rs/google_androidpublisher2/trait.Part.html)** * a collection of properties * never directly used in *Activities* -* **[Activities](http://byron.github.io/google-apis-rs/google-androidpublisher2/trait.CallBuilder.html)** +* **[Activities](http://byron.github.io/google-apis-rs/google_androidpublisher2/trait.CallBuilder.html)** * operations to apply to *Resources* All *structures* are marked with applicable traits to further categorize them and ease browsing. @@ -132,17 +132,17 @@ match result { ``` ## Handling Errors -All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google-androidpublisher2/enum.Result.html) enumeration as return value of +All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google_androidpublisher2/enum.Result.html) enumeration as return value of the doit() methods, or handed as possibly intermediate results to either the -[Hub Delegate](http://byron.github.io/google-apis-rs/google-androidpublisher2/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google-androidpublisher2/../yup-oauth2/trait.AuthenticatorDelegate.html). +[Hub Delegate](http://byron.github.io/google-apis-rs/google_androidpublisher2/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google_androidpublisher2/../yup-oauth2/trait.AuthenticatorDelegate.html). 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](http://byron.github.io/google-apis-rs/google-androidpublisher2/enum.Result.html), should be +If a method supports downloads, the response body, which is part of the [Result](http://byron.github.io/google-apis-rs/google_androidpublisher2/enum.Result.html), should be read by you to obtain the media. -If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google-androidpublisher2/trait.ResponseResult.html), it will return that by default. +If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google_androidpublisher2/trait.ResponseResult.html), 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")`. @@ -152,29 +152,29 @@ Methods supporting uploads can do so using up to 2 different protocols: ## Customization and Callbacks -You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google-androidpublisher2/trait.Delegate.html) to the -[Method Builder](http://byron.github.io/google-apis-rs/google-androidpublisher2/trait.CallBuilder.html) before making the final `doit()` call. +You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google_androidpublisher2/trait.Delegate.html) to the +[Method Builder](http://byron.github.io/google-apis-rs/google_androidpublisher2/trait.CallBuilder.html) 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](http://byron.github.io/google-apis-rs/google-androidpublisher2/trait.Delegate.html) is default-implemented, allowing you to customize it with minimal effort. +The [delegate trait](http://byron.github.io/google-apis-rs/google_androidpublisher2/trait.Delegate.html) 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](http://byron.github.io/google-apis-rs/google-androidpublisher2/trait.RequestValue.html) and -[decodable](http://byron.github.io/google-apis-rs/google-androidpublisher2/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses +All structures provided by this library are made to be [enocodable](http://byron.github.io/google-apis-rs/google_androidpublisher2/trait.RequestValue.html) and +[decodable](http://byron.github.io/google-apis-rs/google_androidpublisher2/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses are valid. -Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google-androidpublisher2/trait.Part.html) which are identifiable by name, which will be sent to +Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google_androidpublisher2/trait.Part.html) 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](http://byron.github.io/google-apis-rs/google-androidpublisher2/trait.CallBuilder.html), you are able to prepare an action call by repeatedly calling it's methods. +Using [method builders](http://byron.github.io/google-apis-rs/google_androidpublisher2/trait.CallBuilder.html), 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][wiki-pod] are handed by copy * strings are passed as `&str` -* [request values](http://byron.github.io/google-apis-rs/google-androidpublisher2/trait.RequestValue.html) are borrowed +* [request values](http://byron.github.io/google-apis-rs/google_androidpublisher2/trait.RequestValue.html) are borrowed Arguments will always be copied or cloned into the builder, to make them independent of their original life times. diff --git a/gen/appsactivity1/README.md b/gen/appsactivity1/README.md index eb769f9ab3..1528b55633 100644 --- a/gen/appsactivity1/README.md +++ b/gen/appsactivity1/README.md @@ -11,10 +11,10 @@ Everything else about the *appsactivity* *v1* API can be found at the [official documentation site](https://developers.google.com/google-apps/activity/). # Features -Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google-appsactivity1/struct.Appsactivity.html) ... +Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google_appsactivity1/struct.Appsactivity.html) ... -* [activities](http://byron.github.io/google-apis-rs/google-appsactivity1/struct.Activity.html) - * [*list*](http://byron.github.io/google-apis-rs/google-appsactivity1/struct.ActivityListCall.html) +* [activities](http://byron.github.io/google-apis-rs/google_appsactivity1/struct.Activity.html) + * [*list*](http://byron.github.io/google-apis-rs/google_appsactivity1/struct.ActivityListCall.html) @@ -23,17 +23,17 @@ Handle the following *Resources* with ease from the central [hub](http://byron.g The API is structured into the following primary items: -* **[Hub](http://byron.github.io/google-apis-rs/google-appsactivity1/struct.Appsactivity.html)** +* **[Hub](http://byron.github.io/google-apis-rs/google_appsactivity1/struct.Appsactivity.html)** * a central object to maintain state and allow accessing all *Activities* - * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google-appsactivity1/trait.MethodsBuilder.html) which in turn - allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google-appsactivity1/trait.CallBuilder.html) -* **[Resources](http://byron.github.io/google-apis-rs/google-appsactivity1/trait.Resource.html)** + * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google_appsactivity1/trait.MethodsBuilder.html) which in turn + allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google_appsactivity1/trait.CallBuilder.html) +* **[Resources](http://byron.github.io/google-apis-rs/google_appsactivity1/trait.Resource.html)** * primary types that you can apply *Activities* to * a collection of properties and *Parts* - * **[Parts](http://byron.github.io/google-apis-rs/google-appsactivity1/trait.Part.html)** + * **[Parts](http://byron.github.io/google-apis-rs/google_appsactivity1/trait.Part.html)** * a collection of properties * never directly used in *Activities* -* **[Activities](http://byron.github.io/google-apis-rs/google-appsactivity1/trait.CallBuilder.html)** +* **[Activities](http://byron.github.io/google-apis-rs/google_appsactivity1/trait.CallBuilder.html)** * operations to apply to *Resources* All *structures* are marked with applicable traits to further categorize them and ease browsing. @@ -119,17 +119,17 @@ match result { ``` ## Handling Errors -All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google-appsactivity1/enum.Result.html) enumeration as return value of +All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google_appsactivity1/enum.Result.html) enumeration as return value of the doit() methods, or handed as possibly intermediate results to either the -[Hub Delegate](http://byron.github.io/google-apis-rs/google-appsactivity1/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google-appsactivity1/../yup-oauth2/trait.AuthenticatorDelegate.html). +[Hub Delegate](http://byron.github.io/google-apis-rs/google_appsactivity1/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google_appsactivity1/../yup-oauth2/trait.AuthenticatorDelegate.html). 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](http://byron.github.io/google-apis-rs/google-appsactivity1/enum.Result.html), should be +If a method supports downloads, the response body, which is part of the [Result](http://byron.github.io/google-apis-rs/google_appsactivity1/enum.Result.html), should be read by you to obtain the media. -If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google-appsactivity1/trait.ResponseResult.html), it will return that by default. +If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google_appsactivity1/trait.ResponseResult.html), 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")`. @@ -139,29 +139,29 @@ Methods supporting uploads can do so using up to 2 different protocols: ## Customization and Callbacks -You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google-appsactivity1/trait.Delegate.html) to the -[Method Builder](http://byron.github.io/google-apis-rs/google-appsactivity1/trait.CallBuilder.html) before making the final `doit()` call. +You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google_appsactivity1/trait.Delegate.html) to the +[Method Builder](http://byron.github.io/google-apis-rs/google_appsactivity1/trait.CallBuilder.html) 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](http://byron.github.io/google-apis-rs/google-appsactivity1/trait.Delegate.html) is default-implemented, allowing you to customize it with minimal effort. +The [delegate trait](http://byron.github.io/google-apis-rs/google_appsactivity1/trait.Delegate.html) 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](http://byron.github.io/google-apis-rs/google-appsactivity1/trait.RequestValue.html) and -[decodable](http://byron.github.io/google-apis-rs/google-appsactivity1/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses +All structures provided by this library are made to be [enocodable](http://byron.github.io/google-apis-rs/google_appsactivity1/trait.RequestValue.html) and +[decodable](http://byron.github.io/google-apis-rs/google_appsactivity1/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses are valid. -Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google-appsactivity1/trait.Part.html) which are identifiable by name, which will be sent to +Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google_appsactivity1/trait.Part.html) 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](http://byron.github.io/google-apis-rs/google-appsactivity1/trait.CallBuilder.html), you are able to prepare an action call by repeatedly calling it's methods. +Using [method builders](http://byron.github.io/google-apis-rs/google_appsactivity1/trait.CallBuilder.html), 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][wiki-pod] are handed by copy * strings are passed as `&str` -* [request values](http://byron.github.io/google-apis-rs/google-appsactivity1/trait.RequestValue.html) are borrowed +* [request values](http://byron.github.io/google-apis-rs/google_appsactivity1/trait.RequestValue.html) are borrowed Arguments will always be copied or cloned into the builder, to make them independent of their original life times. diff --git a/gen/appstate1/README.md b/gen/appstate1/README.md index 0b6ae78a32..884521cc1b 100644 --- a/gen/appstate1/README.md +++ b/gen/appstate1/README.md @@ -11,10 +11,10 @@ Everything else about the *App State* *v1* API can be found at the [official documentation site](https://developers.google.com/games/services/web/api/states). # Features -Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google-appstate1/struct.AppState.html) ... +Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google_appstate1/struct.AppState.html) ... * states - * [*clear*](http://byron.github.io/google-apis-rs/google-appstate1/struct.StateClearCall.html), [*delete*](http://byron.github.io/google-apis-rs/google-appstate1/struct.StateDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google-appstate1/struct.StateGetCall.html), [*list*](http://byron.github.io/google-apis-rs/google-appstate1/struct.StateListCall.html) and [*update*](http://byron.github.io/google-apis-rs/google-appstate1/struct.StateUpdateCall.html) + * [*clear*](http://byron.github.io/google-apis-rs/google_appstate1/struct.StateClearCall.html), [*delete*](http://byron.github.io/google-apis-rs/google_appstate1/struct.StateDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google_appstate1/struct.StateGetCall.html), [*list*](http://byron.github.io/google-apis-rs/google_appstate1/struct.StateListCall.html) and [*update*](http://byron.github.io/google-apis-rs/google_appstate1/struct.StateUpdateCall.html) @@ -23,17 +23,17 @@ Handle the following *Resources* with ease from the central [hub](http://byron.g The API is structured into the following primary items: -* **[Hub](http://byron.github.io/google-apis-rs/google-appstate1/struct.AppState.html)** +* **[Hub](http://byron.github.io/google-apis-rs/google_appstate1/struct.AppState.html)** * a central object to maintain state and allow accessing all *Activities* - * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google-appstate1/trait.MethodsBuilder.html) which in turn - allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google-appstate1/trait.CallBuilder.html) -* **[Resources](http://byron.github.io/google-apis-rs/google-appstate1/trait.Resource.html)** + * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google_appstate1/trait.MethodsBuilder.html) which in turn + allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google_appstate1/trait.CallBuilder.html) +* **[Resources](http://byron.github.io/google-apis-rs/google_appstate1/trait.Resource.html)** * primary types that you can apply *Activities* to * a collection of properties and *Parts* - * **[Parts](http://byron.github.io/google-apis-rs/google-appstate1/trait.Part.html)** + * **[Parts](http://byron.github.io/google-apis-rs/google_appstate1/trait.Part.html)** * a collection of properties * never directly used in *Activities* -* **[Activities](http://byron.github.io/google-apis-rs/google-appstate1/trait.CallBuilder.html)** +* **[Activities](http://byron.github.io/google-apis-rs/google_appstate1/trait.CallBuilder.html)** * operations to apply to *Resources* All *structures* are marked with applicable traits to further categorize them and ease browsing. @@ -120,17 +120,17 @@ match result { ``` ## Handling Errors -All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google-appstate1/enum.Result.html) enumeration as return value of +All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google_appstate1/enum.Result.html) enumeration as return value of the doit() methods, or handed as possibly intermediate results to either the -[Hub Delegate](http://byron.github.io/google-apis-rs/google-appstate1/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google-appstate1/../yup-oauth2/trait.AuthenticatorDelegate.html). +[Hub Delegate](http://byron.github.io/google-apis-rs/google_appstate1/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google_appstate1/../yup-oauth2/trait.AuthenticatorDelegate.html). 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](http://byron.github.io/google-apis-rs/google-appstate1/enum.Result.html), should be +If a method supports downloads, the response body, which is part of the [Result](http://byron.github.io/google-apis-rs/google_appstate1/enum.Result.html), should be read by you to obtain the media. -If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google-appstate1/trait.ResponseResult.html), it will return that by default. +If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google_appstate1/trait.ResponseResult.html), 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")`. @@ -140,29 +140,29 @@ Methods supporting uploads can do so using up to 2 different protocols: ## Customization and Callbacks -You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google-appstate1/trait.Delegate.html) to the -[Method Builder](http://byron.github.io/google-apis-rs/google-appstate1/trait.CallBuilder.html) before making the final `doit()` call. +You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google_appstate1/trait.Delegate.html) to the +[Method Builder](http://byron.github.io/google-apis-rs/google_appstate1/trait.CallBuilder.html) 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](http://byron.github.io/google-apis-rs/google-appstate1/trait.Delegate.html) is default-implemented, allowing you to customize it with minimal effort. +The [delegate trait](http://byron.github.io/google-apis-rs/google_appstate1/trait.Delegate.html) 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](http://byron.github.io/google-apis-rs/google-appstate1/trait.RequestValue.html) and -[decodable](http://byron.github.io/google-apis-rs/google-appstate1/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses +All structures provided by this library are made to be [enocodable](http://byron.github.io/google-apis-rs/google_appstate1/trait.RequestValue.html) and +[decodable](http://byron.github.io/google-apis-rs/google_appstate1/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses are valid. -Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google-appstate1/trait.Part.html) which are identifiable by name, which will be sent to +Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google_appstate1/trait.Part.html) 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](http://byron.github.io/google-apis-rs/google-appstate1/trait.CallBuilder.html), you are able to prepare an action call by repeatedly calling it's methods. +Using [method builders](http://byron.github.io/google-apis-rs/google_appstate1/trait.CallBuilder.html), 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][wiki-pod] are handed by copy * strings are passed as `&str` -* [request values](http://byron.github.io/google-apis-rs/google-appstate1/trait.RequestValue.html) are borrowed +* [request values](http://byron.github.io/google-apis-rs/google_appstate1/trait.RequestValue.html) are borrowed Arguments will always be copied or cloned into the builder, to make them independent of their original life times. diff --git a/gen/audit1/README.md b/gen/audit1/README.md index 6ad364eea1..4348703fc3 100644 --- a/gen/audit1/README.md +++ b/gen/audit1/README.md @@ -11,10 +11,10 @@ Everything else about the *audit* *v1* API can be found at the [official documentation site](https://developers.google.com/google-apps/admin-audit/get_started). # Features -Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google-audit1/struct.Audit.html) ... +Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google_audit1/struct.Audit.html) ... -* [activities](http://byron.github.io/google-apis-rs/google-audit1/struct.Activity.html) - * [*list*](http://byron.github.io/google-apis-rs/google-audit1/struct.ActivityListCall.html) +* [activities](http://byron.github.io/google-apis-rs/google_audit1/struct.Activity.html) + * [*list*](http://byron.github.io/google-apis-rs/google_audit1/struct.ActivityListCall.html) @@ -23,17 +23,17 @@ Handle the following *Resources* with ease from the central [hub](http://byron.g The API is structured into the following primary items: -* **[Hub](http://byron.github.io/google-apis-rs/google-audit1/struct.Audit.html)** +* **[Hub](http://byron.github.io/google-apis-rs/google_audit1/struct.Audit.html)** * a central object to maintain state and allow accessing all *Activities* - * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google-audit1/trait.MethodsBuilder.html) which in turn - allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google-audit1/trait.CallBuilder.html) -* **[Resources](http://byron.github.io/google-apis-rs/google-audit1/trait.Resource.html)** + * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google_audit1/trait.MethodsBuilder.html) which in turn + allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google_audit1/trait.CallBuilder.html) +* **[Resources](http://byron.github.io/google-apis-rs/google_audit1/trait.Resource.html)** * primary types that you can apply *Activities* to * a collection of properties and *Parts* - * **[Parts](http://byron.github.io/google-apis-rs/google-audit1/trait.Part.html)** + * **[Parts](http://byron.github.io/google-apis-rs/google_audit1/trait.Part.html)** * a collection of properties * never directly used in *Activities* -* **[Activities](http://byron.github.io/google-apis-rs/google-audit1/trait.CallBuilder.html)** +* **[Activities](http://byron.github.io/google-apis-rs/google_audit1/trait.CallBuilder.html)** * operations to apply to *Resources* All *structures* are marked with applicable traits to further categorize them and ease browsing. @@ -121,17 +121,17 @@ match result { ``` ## Handling Errors -All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google-audit1/enum.Result.html) enumeration as return value of +All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google_audit1/enum.Result.html) enumeration as return value of the doit() methods, or handed as possibly intermediate results to either the -[Hub Delegate](http://byron.github.io/google-apis-rs/google-audit1/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google-audit1/../yup-oauth2/trait.AuthenticatorDelegate.html). +[Hub Delegate](http://byron.github.io/google-apis-rs/google_audit1/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google_audit1/../yup-oauth2/trait.AuthenticatorDelegate.html). 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](http://byron.github.io/google-apis-rs/google-audit1/enum.Result.html), should be +If a method supports downloads, the response body, which is part of the [Result](http://byron.github.io/google-apis-rs/google_audit1/enum.Result.html), should be read by you to obtain the media. -If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google-audit1/trait.ResponseResult.html), it will return that by default. +If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google_audit1/trait.ResponseResult.html), 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")`. @@ -141,29 +141,29 @@ Methods supporting uploads can do so using up to 2 different protocols: ## Customization and Callbacks -You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google-audit1/trait.Delegate.html) to the -[Method Builder](http://byron.github.io/google-apis-rs/google-audit1/trait.CallBuilder.html) before making the final `doit()` call. +You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google_audit1/trait.Delegate.html) to the +[Method Builder](http://byron.github.io/google-apis-rs/google_audit1/trait.CallBuilder.html) 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](http://byron.github.io/google-apis-rs/google-audit1/trait.Delegate.html) is default-implemented, allowing you to customize it with minimal effort. +The [delegate trait](http://byron.github.io/google-apis-rs/google_audit1/trait.Delegate.html) 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](http://byron.github.io/google-apis-rs/google-audit1/trait.RequestValue.html) and -[decodable](http://byron.github.io/google-apis-rs/google-audit1/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses +All structures provided by this library are made to be [enocodable](http://byron.github.io/google-apis-rs/google_audit1/trait.RequestValue.html) and +[decodable](http://byron.github.io/google-apis-rs/google_audit1/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses are valid. -Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google-audit1/trait.Part.html) which are identifiable by name, which will be sent to +Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google_audit1/trait.Part.html) 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](http://byron.github.io/google-apis-rs/google-audit1/trait.CallBuilder.html), you are able to prepare an action call by repeatedly calling it's methods. +Using [method builders](http://byron.github.io/google-apis-rs/google_audit1/trait.CallBuilder.html), 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][wiki-pod] are handed by copy * strings are passed as `&str` -* [request values](http://byron.github.io/google-apis-rs/google-audit1/trait.RequestValue.html) are borrowed +* [request values](http://byron.github.io/google-apis-rs/google_audit1/trait.RequestValue.html) are borrowed Arguments will always be copied or cloned into the builder, to make them independent of their original life times. diff --git a/gen/autoscaler1_beta2/README.md b/gen/autoscaler1_beta2/README.md index eb7d0fb711..07f8eaa59f 100644 --- a/gen/autoscaler1_beta2/README.md +++ b/gen/autoscaler1_beta2/README.md @@ -11,14 +11,14 @@ Everything else about the *autoscaler* *v1_beta2* API can be found at the [official documentation site](http://developers.google.com/compute/docs/autoscaler). # Features -Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google-autoscaler1_beta2/struct.AutoscalerHub.html) ... +Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google_autoscaler1_beta2/struct.AutoscalerHub.html) ... -* [autoscalers](http://byron.github.io/google-apis-rs/google-autoscaler1_beta2/struct.Autoscaler.html) - * [*delete*](http://byron.github.io/google-apis-rs/google-autoscaler1_beta2/struct.AutoscalerDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google-autoscaler1_beta2/struct.AutoscalerGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google-autoscaler1_beta2/struct.AutoscalerInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google-autoscaler1_beta2/struct.AutoscalerListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google-autoscaler1_beta2/struct.AutoscalerPatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google-autoscaler1_beta2/struct.AutoscalerUpdateCall.html) +* [autoscalers](http://byron.github.io/google-apis-rs/google_autoscaler1_beta2/struct.Autoscaler.html) + * [*delete*](http://byron.github.io/google-apis-rs/google_autoscaler1_beta2/struct.AutoscalerDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google_autoscaler1_beta2/struct.AutoscalerGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google_autoscaler1_beta2/struct.AutoscalerInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google_autoscaler1_beta2/struct.AutoscalerListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google_autoscaler1_beta2/struct.AutoscalerPatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google_autoscaler1_beta2/struct.AutoscalerUpdateCall.html) * zone operations - * [*delete*](http://byron.github.io/google-apis-rs/google-autoscaler1_beta2/struct.ZoneOperationDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google-autoscaler1_beta2/struct.ZoneOperationGetCall.html) and [*list*](http://byron.github.io/google-apis-rs/google-autoscaler1_beta2/struct.ZoneOperationListCall.html) -* [zones](http://byron.github.io/google-apis-rs/google-autoscaler1_beta2/struct.Zone.html) - * [*list*](http://byron.github.io/google-apis-rs/google-autoscaler1_beta2/struct.ZoneListCall.html) + * [*delete*](http://byron.github.io/google-apis-rs/google_autoscaler1_beta2/struct.ZoneOperationDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google_autoscaler1_beta2/struct.ZoneOperationGetCall.html) and [*list*](http://byron.github.io/google-apis-rs/google_autoscaler1_beta2/struct.ZoneOperationListCall.html) +* [zones](http://byron.github.io/google-apis-rs/google_autoscaler1_beta2/struct.Zone.html) + * [*list*](http://byron.github.io/google-apis-rs/google_autoscaler1_beta2/struct.ZoneListCall.html) @@ -27,17 +27,17 @@ Handle the following *Resources* with ease from the central [hub](http://byron.g The API is structured into the following primary items: -* **[Hub](http://byron.github.io/google-apis-rs/google-autoscaler1_beta2/struct.AutoscalerHub.html)** +* **[Hub](http://byron.github.io/google-apis-rs/google_autoscaler1_beta2/struct.AutoscalerHub.html)** * a central object to maintain state and allow accessing all *Activities* - * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google-autoscaler1_beta2/trait.MethodsBuilder.html) which in turn - allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google-autoscaler1_beta2/trait.CallBuilder.html) -* **[Resources](http://byron.github.io/google-apis-rs/google-autoscaler1_beta2/trait.Resource.html)** + * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google_autoscaler1_beta2/trait.MethodsBuilder.html) which in turn + allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google_autoscaler1_beta2/trait.CallBuilder.html) +* **[Resources](http://byron.github.io/google-apis-rs/google_autoscaler1_beta2/trait.Resource.html)** * primary types that you can apply *Activities* to * a collection of properties and *Parts* - * **[Parts](http://byron.github.io/google-apis-rs/google-autoscaler1_beta2/trait.Part.html)** + * **[Parts](http://byron.github.io/google-apis-rs/google_autoscaler1_beta2/trait.Part.html)** * a collection of properties * never directly used in *Activities* -* **[Activities](http://byron.github.io/google-apis-rs/google-autoscaler1_beta2/trait.CallBuilder.html)** +* **[Activities](http://byron.github.io/google-apis-rs/google_autoscaler1_beta2/trait.CallBuilder.html)** * operations to apply to *Resources* All *structures* are marked with applicable traits to further categorize them and ease browsing. @@ -124,17 +124,17 @@ match result { ``` ## Handling Errors -All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google-autoscaler1_beta2/enum.Result.html) enumeration as return value of +All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google_autoscaler1_beta2/enum.Result.html) enumeration as return value of the doit() methods, or handed as possibly intermediate results to either the -[Hub Delegate](http://byron.github.io/google-apis-rs/google-autoscaler1_beta2/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google-autoscaler1_beta2/../yup-oauth2/trait.AuthenticatorDelegate.html). +[Hub Delegate](http://byron.github.io/google-apis-rs/google_autoscaler1_beta2/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google_autoscaler1_beta2/../yup-oauth2/trait.AuthenticatorDelegate.html). 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](http://byron.github.io/google-apis-rs/google-autoscaler1_beta2/enum.Result.html), should be +If a method supports downloads, the response body, which is part of the [Result](http://byron.github.io/google-apis-rs/google_autoscaler1_beta2/enum.Result.html), should be read by you to obtain the media. -If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google-autoscaler1_beta2/trait.ResponseResult.html), it will return that by default. +If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google_autoscaler1_beta2/trait.ResponseResult.html), 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")`. @@ -144,29 +144,29 @@ Methods supporting uploads can do so using up to 2 different protocols: ## Customization and Callbacks -You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google-autoscaler1_beta2/trait.Delegate.html) to the -[Method Builder](http://byron.github.io/google-apis-rs/google-autoscaler1_beta2/trait.CallBuilder.html) before making the final `doit()` call. +You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google_autoscaler1_beta2/trait.Delegate.html) to the +[Method Builder](http://byron.github.io/google-apis-rs/google_autoscaler1_beta2/trait.CallBuilder.html) 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](http://byron.github.io/google-apis-rs/google-autoscaler1_beta2/trait.Delegate.html) is default-implemented, allowing you to customize it with minimal effort. +The [delegate trait](http://byron.github.io/google-apis-rs/google_autoscaler1_beta2/trait.Delegate.html) 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](http://byron.github.io/google-apis-rs/google-autoscaler1_beta2/trait.RequestValue.html) and -[decodable](http://byron.github.io/google-apis-rs/google-autoscaler1_beta2/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses +All structures provided by this library are made to be [enocodable](http://byron.github.io/google-apis-rs/google_autoscaler1_beta2/trait.RequestValue.html) and +[decodable](http://byron.github.io/google-apis-rs/google_autoscaler1_beta2/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses are valid. -Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google-autoscaler1_beta2/trait.Part.html) which are identifiable by name, which will be sent to +Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google_autoscaler1_beta2/trait.Part.html) 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](http://byron.github.io/google-apis-rs/google-autoscaler1_beta2/trait.CallBuilder.html), you are able to prepare an action call by repeatedly calling it's methods. +Using [method builders](http://byron.github.io/google-apis-rs/google_autoscaler1_beta2/trait.CallBuilder.html), 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][wiki-pod] are handed by copy * strings are passed as `&str` -* [request values](http://byron.github.io/google-apis-rs/google-autoscaler1_beta2/trait.RequestValue.html) are borrowed +* [request values](http://byron.github.io/google-apis-rs/google_autoscaler1_beta2/trait.RequestValue.html) are borrowed Arguments will always be copied or cloned into the builder, to make them independent of their original life times. diff --git a/gen/bigquery2/README.md b/gen/bigquery2/README.md index 2d8d493c19..02bfd1ff96 100644 --- a/gen/bigquery2/README.md +++ b/gen/bigquery2/README.md @@ -11,23 +11,23 @@ Everything else about the *bigquery* *v2* API can be found at the [official documentation site](https://developers.google.com/bigquery/docs/overview). # Features -Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google-bigquery2/struct.Bigquery.html) ... +Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google_bigquery2/struct.Bigquery.html) ... -* [datasets](http://byron.github.io/google-apis-rs/google-bigquery2/struct.Dataset.html) - * [*delete*](http://byron.github.io/google-apis-rs/google-bigquery2/struct.DatasetDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google-bigquery2/struct.DatasetGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google-bigquery2/struct.DatasetInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google-bigquery2/struct.DatasetListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google-bigquery2/struct.DatasetPatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google-bigquery2/struct.DatasetUpdateCall.html) -* [jobs](http://byron.github.io/google-apis-rs/google-bigquery2/struct.Job.html) - * [*get*](http://byron.github.io/google-apis-rs/google-bigquery2/struct.JobGetCall.html), [*get query results*](http://byron.github.io/google-apis-rs/google-bigquery2/struct.JobGetQueryResultCall.html), [*insert*](http://byron.github.io/google-apis-rs/google-bigquery2/struct.JobInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google-bigquery2/struct.JobListCall.html) and [*query*](http://byron.github.io/google-apis-rs/google-bigquery2/struct.JobQueryCall.html) +* [datasets](http://byron.github.io/google-apis-rs/google_bigquery2/struct.Dataset.html) + * [*delete*](http://byron.github.io/google-apis-rs/google_bigquery2/struct.DatasetDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google_bigquery2/struct.DatasetGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google_bigquery2/struct.DatasetInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google_bigquery2/struct.DatasetListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google_bigquery2/struct.DatasetPatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google_bigquery2/struct.DatasetUpdateCall.html) +* [jobs](http://byron.github.io/google-apis-rs/google_bigquery2/struct.Job.html) + * [*get*](http://byron.github.io/google-apis-rs/google_bigquery2/struct.JobGetCall.html), [*get query results*](http://byron.github.io/google-apis-rs/google_bigquery2/struct.JobGetQueryResultCall.html), [*insert*](http://byron.github.io/google-apis-rs/google_bigquery2/struct.JobInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google_bigquery2/struct.JobListCall.html) and [*query*](http://byron.github.io/google-apis-rs/google_bigquery2/struct.JobQueryCall.html) * projects - * [*list*](http://byron.github.io/google-apis-rs/google-bigquery2/struct.ProjectListCall.html) + * [*list*](http://byron.github.io/google-apis-rs/google_bigquery2/struct.ProjectListCall.html) * tabledata - * [*insert all*](http://byron.github.io/google-apis-rs/google-bigquery2/struct.TabledataInsertAllCall.html) and [*list*](http://byron.github.io/google-apis-rs/google-bigquery2/struct.TabledataListCall.html) -* [tables](http://byron.github.io/google-apis-rs/google-bigquery2/struct.Table.html) - * [*delete*](http://byron.github.io/google-apis-rs/google-bigquery2/struct.TableDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google-bigquery2/struct.TableGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google-bigquery2/struct.TableInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google-bigquery2/struct.TableListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google-bigquery2/struct.TablePatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google-bigquery2/struct.TableUpdateCall.html) + * [*insert all*](http://byron.github.io/google-apis-rs/google_bigquery2/struct.TabledataInsertAllCall.html) and [*list*](http://byron.github.io/google-apis-rs/google_bigquery2/struct.TabledataListCall.html) +* [tables](http://byron.github.io/google-apis-rs/google_bigquery2/struct.Table.html) + * [*delete*](http://byron.github.io/google-apis-rs/google_bigquery2/struct.TableDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google_bigquery2/struct.TableGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google_bigquery2/struct.TableInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google_bigquery2/struct.TableListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google_bigquery2/struct.TablePatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google_bigquery2/struct.TableUpdateCall.html) Upload supported by ... -* [*insert jobs*](http://byron.github.io/google-apis-rs/google-bigquery2/struct.JobInsertCall.html) +* [*insert jobs*](http://byron.github.io/google-apis-rs/google_bigquery2/struct.JobInsertCall.html) @@ -35,17 +35,17 @@ Upload supported by ... The API is structured into the following primary items: -* **[Hub](http://byron.github.io/google-apis-rs/google-bigquery2/struct.Bigquery.html)** +* **[Hub](http://byron.github.io/google-apis-rs/google_bigquery2/struct.Bigquery.html)** * a central object to maintain state and allow accessing all *Activities* - * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google-bigquery2/trait.MethodsBuilder.html) which in turn - allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google-bigquery2/trait.CallBuilder.html) -* **[Resources](http://byron.github.io/google-apis-rs/google-bigquery2/trait.Resource.html)** + * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google_bigquery2/trait.MethodsBuilder.html) which in turn + allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google_bigquery2/trait.CallBuilder.html) +* **[Resources](http://byron.github.io/google-apis-rs/google_bigquery2/trait.Resource.html)** * primary types that you can apply *Activities* to * a collection of properties and *Parts* - * **[Parts](http://byron.github.io/google-apis-rs/google-bigquery2/trait.Part.html)** + * **[Parts](http://byron.github.io/google-apis-rs/google_bigquery2/trait.Part.html)** * a collection of properties * never directly used in *Activities* -* **[Activities](http://byron.github.io/google-apis-rs/google-bigquery2/trait.CallBuilder.html)** +* **[Activities](http://byron.github.io/google-apis-rs/google_bigquery2/trait.CallBuilder.html)** * operations to apply to *Resources* All *structures* are marked with applicable traits to further categorize them and ease browsing. @@ -135,17 +135,17 @@ match result { ``` ## Handling Errors -All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google-bigquery2/enum.Result.html) enumeration as return value of +All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google_bigquery2/enum.Result.html) enumeration as return value of the doit() methods, or handed as possibly intermediate results to either the -[Hub Delegate](http://byron.github.io/google-apis-rs/google-bigquery2/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google-bigquery2/../yup-oauth2/trait.AuthenticatorDelegate.html). +[Hub Delegate](http://byron.github.io/google-apis-rs/google_bigquery2/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google_bigquery2/../yup-oauth2/trait.AuthenticatorDelegate.html). 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](http://byron.github.io/google-apis-rs/google-bigquery2/enum.Result.html), should be +If a method supports downloads, the response body, which is part of the [Result](http://byron.github.io/google-apis-rs/google_bigquery2/enum.Result.html), should be read by you to obtain the media. -If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google-bigquery2/trait.ResponseResult.html), it will return that by default. +If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google_bigquery2/trait.ResponseResult.html), 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")`. @@ -155,29 +155,29 @@ Methods supporting uploads can do so using up to 2 different protocols: ## Customization and Callbacks -You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google-bigquery2/trait.Delegate.html) to the -[Method Builder](http://byron.github.io/google-apis-rs/google-bigquery2/trait.CallBuilder.html) before making the final `doit()` call. +You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google_bigquery2/trait.Delegate.html) to the +[Method Builder](http://byron.github.io/google-apis-rs/google_bigquery2/trait.CallBuilder.html) 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](http://byron.github.io/google-apis-rs/google-bigquery2/trait.Delegate.html) is default-implemented, allowing you to customize it with minimal effort. +The [delegate trait](http://byron.github.io/google-apis-rs/google_bigquery2/trait.Delegate.html) 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](http://byron.github.io/google-apis-rs/google-bigquery2/trait.RequestValue.html) and -[decodable](http://byron.github.io/google-apis-rs/google-bigquery2/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses +All structures provided by this library are made to be [enocodable](http://byron.github.io/google-apis-rs/google_bigquery2/trait.RequestValue.html) and +[decodable](http://byron.github.io/google-apis-rs/google_bigquery2/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses are valid. -Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google-bigquery2/trait.Part.html) which are identifiable by name, which will be sent to +Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google_bigquery2/trait.Part.html) 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](http://byron.github.io/google-apis-rs/google-bigquery2/trait.CallBuilder.html), you are able to prepare an action call by repeatedly calling it's methods. +Using [method builders](http://byron.github.io/google-apis-rs/google_bigquery2/trait.CallBuilder.html), 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][wiki-pod] are handed by copy * strings are passed as `&str` -* [request values](http://byron.github.io/google-apis-rs/google-bigquery2/trait.RequestValue.html) are borrowed +* [request values](http://byron.github.io/google-apis-rs/google_bigquery2/trait.RequestValue.html) are borrowed Arguments will always be copied or cloned into the builder, to make them independent of their original life times. diff --git a/gen/blogger3/README.md b/gen/blogger3/README.md index c4375a188b..af788a2f78 100644 --- a/gen/blogger3/README.md +++ b/gen/blogger3/README.md @@ -11,24 +11,24 @@ Everything else about the *blogger* *v3* API can be found at the [official documentation site](https://developers.google.com/blogger/docs/3.0/getting_started). # Features -Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google-blogger3/struct.Blogger.html) ... +Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google_blogger3/struct.Blogger.html) ... -* [blog user infos](http://byron.github.io/google-apis-rs/google-blogger3/struct.BlogUserInfo.html) - * [*get*](http://byron.github.io/google-apis-rs/google-blogger3/struct.BlogUserInfoGetCall.html) -* [blogs](http://byron.github.io/google-apis-rs/google-blogger3/struct.Blog.html) - * [*get*](http://byron.github.io/google-apis-rs/google-blogger3/struct.BlogGetCall.html), [*get by url*](http://byron.github.io/google-apis-rs/google-blogger3/struct.BlogGetByUrlCall.html) and [*list by user*](http://byron.github.io/google-apis-rs/google-blogger3/struct.BlogListByUserCall.html) -* [comments](http://byron.github.io/google-apis-rs/google-blogger3/struct.Comment.html) - * [*approve*](http://byron.github.io/google-apis-rs/google-blogger3/struct.CommentApproveCall.html), [*delete*](http://byron.github.io/google-apis-rs/google-blogger3/struct.CommentDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google-blogger3/struct.CommentGetCall.html), [*list*](http://byron.github.io/google-apis-rs/google-blogger3/struct.CommentListCall.html), [*list by blog*](http://byron.github.io/google-apis-rs/google-blogger3/struct.CommentListByBlogCall.html), [*mark as spam*](http://byron.github.io/google-apis-rs/google-blogger3/struct.CommentMarkAsSpamCall.html) and [*remove content*](http://byron.github.io/google-apis-rs/google-blogger3/struct.CommentRemoveContentCall.html) +* [blog user infos](http://byron.github.io/google-apis-rs/google_blogger3/struct.BlogUserInfo.html) + * [*get*](http://byron.github.io/google-apis-rs/google_blogger3/struct.BlogUserInfoGetCall.html) +* [blogs](http://byron.github.io/google-apis-rs/google_blogger3/struct.Blog.html) + * [*get*](http://byron.github.io/google-apis-rs/google_blogger3/struct.BlogGetCall.html), [*get by url*](http://byron.github.io/google-apis-rs/google_blogger3/struct.BlogGetByUrlCall.html) and [*list by user*](http://byron.github.io/google-apis-rs/google_blogger3/struct.BlogListByUserCall.html) +* [comments](http://byron.github.io/google-apis-rs/google_blogger3/struct.Comment.html) + * [*approve*](http://byron.github.io/google-apis-rs/google_blogger3/struct.CommentApproveCall.html), [*delete*](http://byron.github.io/google-apis-rs/google_blogger3/struct.CommentDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google_blogger3/struct.CommentGetCall.html), [*list*](http://byron.github.io/google-apis-rs/google_blogger3/struct.CommentListCall.html), [*list by blog*](http://byron.github.io/google-apis-rs/google_blogger3/struct.CommentListByBlogCall.html), [*mark as spam*](http://byron.github.io/google-apis-rs/google_blogger3/struct.CommentMarkAsSpamCall.html) and [*remove content*](http://byron.github.io/google-apis-rs/google_blogger3/struct.CommentRemoveContentCall.html) * page views - * [*get*](http://byron.github.io/google-apis-rs/google-blogger3/struct.PageViewGetCall.html) -* [pages](http://byron.github.io/google-apis-rs/google-blogger3/struct.Page.html) - * [*delete*](http://byron.github.io/google-apis-rs/google-blogger3/struct.PageDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google-blogger3/struct.PageGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google-blogger3/struct.PageInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google-blogger3/struct.PageListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google-blogger3/struct.PagePatchCall.html), [*publish*](http://byron.github.io/google-apis-rs/google-blogger3/struct.PagePublishCall.html), [*revert*](http://byron.github.io/google-apis-rs/google-blogger3/struct.PageRevertCall.html) and [*update*](http://byron.github.io/google-apis-rs/google-blogger3/struct.PageUpdateCall.html) -* [post user infos](http://byron.github.io/google-apis-rs/google-blogger3/struct.PostUserInfo.html) - * [*get*](http://byron.github.io/google-apis-rs/google-blogger3/struct.PostUserInfoGetCall.html) and [*list*](http://byron.github.io/google-apis-rs/google-blogger3/struct.PostUserInfoListCall.html) -* [posts](http://byron.github.io/google-apis-rs/google-blogger3/struct.Post.html) - * [*delete*](http://byron.github.io/google-apis-rs/google-blogger3/struct.PostDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google-blogger3/struct.PostGetCall.html), [*get by path*](http://byron.github.io/google-apis-rs/google-blogger3/struct.PostGetByPathCall.html), [*insert*](http://byron.github.io/google-apis-rs/google-blogger3/struct.PostInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google-blogger3/struct.PostListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google-blogger3/struct.PostPatchCall.html), [*publish*](http://byron.github.io/google-apis-rs/google-blogger3/struct.PostPublishCall.html), [*revert*](http://byron.github.io/google-apis-rs/google-blogger3/struct.PostRevertCall.html), [*search*](http://byron.github.io/google-apis-rs/google-blogger3/struct.PostSearchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google-blogger3/struct.PostUpdateCall.html) -* [users](http://byron.github.io/google-apis-rs/google-blogger3/struct.User.html) - * [*get*](http://byron.github.io/google-apis-rs/google-blogger3/struct.UserGetCall.html) + * [*get*](http://byron.github.io/google-apis-rs/google_blogger3/struct.PageViewGetCall.html) +* [pages](http://byron.github.io/google-apis-rs/google_blogger3/struct.Page.html) + * [*delete*](http://byron.github.io/google-apis-rs/google_blogger3/struct.PageDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google_blogger3/struct.PageGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google_blogger3/struct.PageInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google_blogger3/struct.PageListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google_blogger3/struct.PagePatchCall.html), [*publish*](http://byron.github.io/google-apis-rs/google_blogger3/struct.PagePublishCall.html), [*revert*](http://byron.github.io/google-apis-rs/google_blogger3/struct.PageRevertCall.html) and [*update*](http://byron.github.io/google-apis-rs/google_blogger3/struct.PageUpdateCall.html) +* [post user infos](http://byron.github.io/google-apis-rs/google_blogger3/struct.PostUserInfo.html) + * [*get*](http://byron.github.io/google-apis-rs/google_blogger3/struct.PostUserInfoGetCall.html) and [*list*](http://byron.github.io/google-apis-rs/google_blogger3/struct.PostUserInfoListCall.html) +* [posts](http://byron.github.io/google-apis-rs/google_blogger3/struct.Post.html) + * [*delete*](http://byron.github.io/google-apis-rs/google_blogger3/struct.PostDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google_blogger3/struct.PostGetCall.html), [*get by path*](http://byron.github.io/google-apis-rs/google_blogger3/struct.PostGetByPathCall.html), [*insert*](http://byron.github.io/google-apis-rs/google_blogger3/struct.PostInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google_blogger3/struct.PostListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google_blogger3/struct.PostPatchCall.html), [*publish*](http://byron.github.io/google-apis-rs/google_blogger3/struct.PostPublishCall.html), [*revert*](http://byron.github.io/google-apis-rs/google_blogger3/struct.PostRevertCall.html), [*search*](http://byron.github.io/google-apis-rs/google_blogger3/struct.PostSearchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google_blogger3/struct.PostUpdateCall.html) +* [users](http://byron.github.io/google-apis-rs/google_blogger3/struct.User.html) + * [*get*](http://byron.github.io/google-apis-rs/google_blogger3/struct.UserGetCall.html) @@ -37,17 +37,17 @@ Handle the following *Resources* with ease from the central [hub](http://byron.g The API is structured into the following primary items: -* **[Hub](http://byron.github.io/google-apis-rs/google-blogger3/struct.Blogger.html)** +* **[Hub](http://byron.github.io/google-apis-rs/google_blogger3/struct.Blogger.html)** * a central object to maintain state and allow accessing all *Activities* - * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google-blogger3/trait.MethodsBuilder.html) which in turn - allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google-blogger3/trait.CallBuilder.html) -* **[Resources](http://byron.github.io/google-apis-rs/google-blogger3/trait.Resource.html)** + * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google_blogger3/trait.MethodsBuilder.html) which in turn + allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google_blogger3/trait.CallBuilder.html) +* **[Resources](http://byron.github.io/google-apis-rs/google_blogger3/trait.Resource.html)** * primary types that you can apply *Activities* to * a collection of properties and *Parts* - * **[Parts](http://byron.github.io/google-apis-rs/google-blogger3/trait.Part.html)** + * **[Parts](http://byron.github.io/google-apis-rs/google_blogger3/trait.Part.html)** * a collection of properties * never directly used in *Activities* -* **[Activities](http://byron.github.io/google-apis-rs/google-blogger3/trait.CallBuilder.html)** +* **[Activities](http://byron.github.io/google-apis-rs/google_blogger3/trait.CallBuilder.html)** * operations to apply to *Resources* All *structures* are marked with applicable traits to further categorize them and ease browsing. @@ -145,17 +145,17 @@ match result { ``` ## Handling Errors -All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google-blogger3/enum.Result.html) enumeration as return value of +All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google_blogger3/enum.Result.html) enumeration as return value of the doit() methods, or handed as possibly intermediate results to either the -[Hub Delegate](http://byron.github.io/google-apis-rs/google-blogger3/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google-blogger3/../yup-oauth2/trait.AuthenticatorDelegate.html). +[Hub Delegate](http://byron.github.io/google-apis-rs/google_blogger3/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google_blogger3/../yup-oauth2/trait.AuthenticatorDelegate.html). 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](http://byron.github.io/google-apis-rs/google-blogger3/enum.Result.html), should be +If a method supports downloads, the response body, which is part of the [Result](http://byron.github.io/google-apis-rs/google_blogger3/enum.Result.html), should be read by you to obtain the media. -If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google-blogger3/trait.ResponseResult.html), it will return that by default. +If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google_blogger3/trait.ResponseResult.html), 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")`. @@ -165,29 +165,29 @@ Methods supporting uploads can do so using up to 2 different protocols: ## Customization and Callbacks -You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google-blogger3/trait.Delegate.html) to the -[Method Builder](http://byron.github.io/google-apis-rs/google-blogger3/trait.CallBuilder.html) before making the final `doit()` call. +You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google_blogger3/trait.Delegate.html) to the +[Method Builder](http://byron.github.io/google-apis-rs/google_blogger3/trait.CallBuilder.html) 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](http://byron.github.io/google-apis-rs/google-blogger3/trait.Delegate.html) is default-implemented, allowing you to customize it with minimal effort. +The [delegate trait](http://byron.github.io/google-apis-rs/google_blogger3/trait.Delegate.html) 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](http://byron.github.io/google-apis-rs/google-blogger3/trait.RequestValue.html) and -[decodable](http://byron.github.io/google-apis-rs/google-blogger3/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses +All structures provided by this library are made to be [enocodable](http://byron.github.io/google-apis-rs/google_blogger3/trait.RequestValue.html) and +[decodable](http://byron.github.io/google-apis-rs/google_blogger3/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses are valid. -Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google-blogger3/trait.Part.html) which are identifiable by name, which will be sent to +Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google_blogger3/trait.Part.html) 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](http://byron.github.io/google-apis-rs/google-blogger3/trait.CallBuilder.html), you are able to prepare an action call by repeatedly calling it's methods. +Using [method builders](http://byron.github.io/google-apis-rs/google_blogger3/trait.CallBuilder.html), 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][wiki-pod] are handed by copy * strings are passed as `&str` -* [request values](http://byron.github.io/google-apis-rs/google-blogger3/trait.RequestValue.html) are borrowed +* [request values](http://byron.github.io/google-apis-rs/google_blogger3/trait.RequestValue.html) are borrowed Arguments will always be copied or cloned into the builder, to make them independent of their original life times. diff --git a/gen/books1/README.md b/gen/books1/README.md index bd22bc7402..d874618e10 100644 --- a/gen/books1/README.md +++ b/gen/books1/README.md @@ -11,26 +11,26 @@ Everything else about the *books* *v1* API can be found at the [official documentation site](https://developers.google.com/books/docs/v1/getting_started). # Features -Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google-books1/struct.Books.html) ... +Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google_books1/struct.Books.html) ... * bookshelves - * [*get*](http://byron.github.io/google-apis-rs/google-books1/struct.BookshelveGetCall.html), [*list*](http://byron.github.io/google-apis-rs/google-books1/struct.BookshelveListCall.html) and [*volumes list*](http://byron.github.io/google-apis-rs/google-books1/struct.BookshelveVolumeListCall.html) + * [*get*](http://byron.github.io/google-apis-rs/google_books1/struct.BookshelveGetCall.html), [*list*](http://byron.github.io/google-apis-rs/google_books1/struct.BookshelveListCall.html) and [*volumes list*](http://byron.github.io/google-apis-rs/google_books1/struct.BookshelveVolumeListCall.html) * cloudloading - * [*add book*](http://byron.github.io/google-apis-rs/google-books1/struct.CloudloadingAddBookCall.html), [*delete book*](http://byron.github.io/google-apis-rs/google-books1/struct.CloudloadingDeleteBookCall.html) and [*update book*](http://byron.github.io/google-apis-rs/google-books1/struct.CloudloadingUpdateBookCall.html) + * [*add book*](http://byron.github.io/google-apis-rs/google_books1/struct.CloudloadingAddBookCall.html), [*delete book*](http://byron.github.io/google-apis-rs/google_books1/struct.CloudloadingDeleteBookCall.html) and [*update book*](http://byron.github.io/google-apis-rs/google_books1/struct.CloudloadingUpdateBookCall.html) * dictionary - * [*list offline metadata*](http://byron.github.io/google-apis-rs/google-books1/struct.DictionaryListOfflineMetadataCall.html) + * [*list offline metadata*](http://byron.github.io/google-apis-rs/google_books1/struct.DictionaryListOfflineMetadataCall.html) * layers - * [*annotation data get*](http://byron.github.io/google-apis-rs/google-books1/struct.LayerAnnotationDataGetCall.html), [*annotation data list*](http://byron.github.io/google-apis-rs/google-books1/struct.LayerAnnotationDataListCall.html), [*get*](http://byron.github.io/google-apis-rs/google-books1/struct.LayerGetCall.html), [*list*](http://byron.github.io/google-apis-rs/google-books1/struct.LayerListCall.html), [*volume annotations get*](http://byron.github.io/google-apis-rs/google-books1/struct.LayerVolumeAnnotationGetCall.html) and [*volume annotations list*](http://byron.github.io/google-apis-rs/google-books1/struct.LayerVolumeAnnotationListCall.html) + * [*annotation data get*](http://byron.github.io/google-apis-rs/google_books1/struct.LayerAnnotationDataGetCall.html), [*annotation data list*](http://byron.github.io/google-apis-rs/google_books1/struct.LayerAnnotationDataListCall.html), [*get*](http://byron.github.io/google-apis-rs/google_books1/struct.LayerGetCall.html), [*list*](http://byron.github.io/google-apis-rs/google_books1/struct.LayerListCall.html), [*volume annotations get*](http://byron.github.io/google-apis-rs/google_books1/struct.LayerVolumeAnnotationGetCall.html) and [*volume annotations list*](http://byron.github.io/google-apis-rs/google_books1/struct.LayerVolumeAnnotationListCall.html) * myconfig - * [*get user settings*](http://byron.github.io/google-apis-rs/google-books1/struct.MyconfigGetUserSettingCall.html), [*release download access*](http://byron.github.io/google-apis-rs/google-books1/struct.MyconfigReleaseDownloadAccesCall.html), [*request access*](http://byron.github.io/google-apis-rs/google-books1/struct.MyconfigRequestAccesCall.html), [*sync volume licenses*](http://byron.github.io/google-apis-rs/google-books1/struct.MyconfigSyncVolumeLicenseCall.html) and [*update user settings*](http://byron.github.io/google-apis-rs/google-books1/struct.MyconfigUpdateUserSettingCall.html) + * [*get user settings*](http://byron.github.io/google-apis-rs/google_books1/struct.MyconfigGetUserSettingCall.html), [*release download access*](http://byron.github.io/google-apis-rs/google_books1/struct.MyconfigReleaseDownloadAccesCall.html), [*request access*](http://byron.github.io/google-apis-rs/google_books1/struct.MyconfigRequestAccesCall.html), [*sync volume licenses*](http://byron.github.io/google-apis-rs/google_books1/struct.MyconfigSyncVolumeLicenseCall.html) and [*update user settings*](http://byron.github.io/google-apis-rs/google_books1/struct.MyconfigUpdateUserSettingCall.html) * mylibrary - * [*annotations delete*](http://byron.github.io/google-apis-rs/google-books1/struct.MylibraryAnnotationDeleteCall.html), [*annotations insert*](http://byron.github.io/google-apis-rs/google-books1/struct.MylibraryAnnotationInsertCall.html), [*annotations list*](http://byron.github.io/google-apis-rs/google-books1/struct.MylibraryAnnotationListCall.html), [*annotations summary*](http://byron.github.io/google-apis-rs/google-books1/struct.MylibraryAnnotationSummaryCall.html), [*annotations update*](http://byron.github.io/google-apis-rs/google-books1/struct.MylibraryAnnotationUpdateCall.html), [*bookshelves add volume*](http://byron.github.io/google-apis-rs/google-books1/struct.MylibraryBookshelveAddVolumeCall.html), [*bookshelves clear volumes*](http://byron.github.io/google-apis-rs/google-books1/struct.MylibraryBookshelveClearVolumeCall.html), [*bookshelves get*](http://byron.github.io/google-apis-rs/google-books1/struct.MylibraryBookshelveGetCall.html), [*bookshelves list*](http://byron.github.io/google-apis-rs/google-books1/struct.MylibraryBookshelveListCall.html), [*bookshelves move volume*](http://byron.github.io/google-apis-rs/google-books1/struct.MylibraryBookshelveMoveVolumeCall.html), [*bookshelves remove volume*](http://byron.github.io/google-apis-rs/google-books1/struct.MylibraryBookshelveRemoveVolumeCall.html), [*bookshelves volumes list*](http://byron.github.io/google-apis-rs/google-books1/struct.MylibraryBookshelveVolumeListCall.html), [*readingpositions get*](http://byron.github.io/google-apis-rs/google-books1/struct.MylibraryReadingpositionGetCall.html) and [*readingpositions set position*](http://byron.github.io/google-apis-rs/google-books1/struct.MylibraryReadingpositionSetPositionCall.html) + * [*annotations delete*](http://byron.github.io/google-apis-rs/google_books1/struct.MylibraryAnnotationDeleteCall.html), [*annotations insert*](http://byron.github.io/google-apis-rs/google_books1/struct.MylibraryAnnotationInsertCall.html), [*annotations list*](http://byron.github.io/google-apis-rs/google_books1/struct.MylibraryAnnotationListCall.html), [*annotations summary*](http://byron.github.io/google-apis-rs/google_books1/struct.MylibraryAnnotationSummaryCall.html), [*annotations update*](http://byron.github.io/google-apis-rs/google_books1/struct.MylibraryAnnotationUpdateCall.html), [*bookshelves add volume*](http://byron.github.io/google-apis-rs/google_books1/struct.MylibraryBookshelveAddVolumeCall.html), [*bookshelves clear volumes*](http://byron.github.io/google-apis-rs/google_books1/struct.MylibraryBookshelveClearVolumeCall.html), [*bookshelves get*](http://byron.github.io/google-apis-rs/google_books1/struct.MylibraryBookshelveGetCall.html), [*bookshelves list*](http://byron.github.io/google-apis-rs/google_books1/struct.MylibraryBookshelveListCall.html), [*bookshelves move volume*](http://byron.github.io/google-apis-rs/google_books1/struct.MylibraryBookshelveMoveVolumeCall.html), [*bookshelves remove volume*](http://byron.github.io/google-apis-rs/google_books1/struct.MylibraryBookshelveRemoveVolumeCall.html), [*bookshelves volumes list*](http://byron.github.io/google-apis-rs/google_books1/struct.MylibraryBookshelveVolumeListCall.html), [*readingpositions get*](http://byron.github.io/google-apis-rs/google_books1/struct.MylibraryReadingpositionGetCall.html) and [*readingpositions set position*](http://byron.github.io/google-apis-rs/google_books1/struct.MylibraryReadingpositionSetPositionCall.html) * onboarding - * [*list categories*](http://byron.github.io/google-apis-rs/google-books1/struct.OnboardingListCategoryCall.html) and [*list category volumes*](http://byron.github.io/google-apis-rs/google-books1/struct.OnboardingListCategoryVolumeCall.html) + * [*list categories*](http://byron.github.io/google-apis-rs/google_books1/struct.OnboardingListCategoryCall.html) and [*list category volumes*](http://byron.github.io/google-apis-rs/google_books1/struct.OnboardingListCategoryVolumeCall.html) * promooffer - * [*accept*](http://byron.github.io/google-apis-rs/google-books1/struct.PromoofferAcceptCall.html), [*dismiss*](http://byron.github.io/google-apis-rs/google-books1/struct.PromoofferDismisCall.html) and [*get*](http://byron.github.io/google-apis-rs/google-books1/struct.PromoofferGetCall.html) -* [volumes](http://byron.github.io/google-apis-rs/google-books1/struct.Volume.html) - * [*associated list*](http://byron.github.io/google-apis-rs/google-books1/struct.VolumeAssociatedListCall.html), [*get*](http://byron.github.io/google-apis-rs/google-books1/struct.VolumeGetCall.html), [*list*](http://byron.github.io/google-apis-rs/google-books1/struct.VolumeListCall.html), [*mybooks list*](http://byron.github.io/google-apis-rs/google-books1/struct.VolumeMybookListCall.html), [*recommended list*](http://byron.github.io/google-apis-rs/google-books1/struct.VolumeRecommendedListCall.html), [*recommended rate*](http://byron.github.io/google-apis-rs/google-books1/struct.VolumeRecommendedRateCall.html) and [*useruploaded list*](http://byron.github.io/google-apis-rs/google-books1/struct.VolumeUseruploadedListCall.html) + * [*accept*](http://byron.github.io/google-apis-rs/google_books1/struct.PromoofferAcceptCall.html), [*dismiss*](http://byron.github.io/google-apis-rs/google_books1/struct.PromoofferDismisCall.html) and [*get*](http://byron.github.io/google-apis-rs/google_books1/struct.PromoofferGetCall.html) +* [volumes](http://byron.github.io/google-apis-rs/google_books1/struct.Volume.html) + * [*associated list*](http://byron.github.io/google-apis-rs/google_books1/struct.VolumeAssociatedListCall.html), [*get*](http://byron.github.io/google-apis-rs/google_books1/struct.VolumeGetCall.html), [*list*](http://byron.github.io/google-apis-rs/google_books1/struct.VolumeListCall.html), [*mybooks list*](http://byron.github.io/google-apis-rs/google_books1/struct.VolumeMybookListCall.html), [*recommended list*](http://byron.github.io/google-apis-rs/google_books1/struct.VolumeRecommendedListCall.html), [*recommended rate*](http://byron.github.io/google-apis-rs/google_books1/struct.VolumeRecommendedRateCall.html) and [*useruploaded list*](http://byron.github.io/google-apis-rs/google_books1/struct.VolumeUseruploadedListCall.html) @@ -39,17 +39,17 @@ Handle the following *Resources* with ease from the central [hub](http://byron.g The API is structured into the following primary items: -* **[Hub](http://byron.github.io/google-apis-rs/google-books1/struct.Books.html)** +* **[Hub](http://byron.github.io/google-apis-rs/google_books1/struct.Books.html)** * a central object to maintain state and allow accessing all *Activities* - * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google-books1/trait.MethodsBuilder.html) which in turn - allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google-books1/trait.CallBuilder.html) -* **[Resources](http://byron.github.io/google-apis-rs/google-books1/trait.Resource.html)** + * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google_books1/trait.MethodsBuilder.html) which in turn + allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google_books1/trait.CallBuilder.html) +* **[Resources](http://byron.github.io/google-apis-rs/google_books1/trait.Resource.html)** * primary types that you can apply *Activities* to * a collection of properties and *Parts* - * **[Parts](http://byron.github.io/google-apis-rs/google-books1/trait.Part.html)** + * **[Parts](http://byron.github.io/google-apis-rs/google_books1/trait.Part.html)** * a collection of properties * never directly used in *Activities* -* **[Activities](http://byron.github.io/google-apis-rs/google-books1/trait.CallBuilder.html)** +* **[Activities](http://byron.github.io/google-apis-rs/google_books1/trait.CallBuilder.html)** * operations to apply to *Resources* All *structures* are marked with applicable traits to further categorize them and ease browsing. @@ -147,17 +147,17 @@ match result { ``` ## Handling Errors -All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google-books1/enum.Result.html) enumeration as return value of +All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google_books1/enum.Result.html) enumeration as return value of the doit() methods, or handed as possibly intermediate results to either the -[Hub Delegate](http://byron.github.io/google-apis-rs/google-books1/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google-books1/../yup-oauth2/trait.AuthenticatorDelegate.html). +[Hub Delegate](http://byron.github.io/google-apis-rs/google_books1/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google_books1/../yup-oauth2/trait.AuthenticatorDelegate.html). 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](http://byron.github.io/google-apis-rs/google-books1/enum.Result.html), should be +If a method supports downloads, the response body, which is part of the [Result](http://byron.github.io/google-apis-rs/google_books1/enum.Result.html), should be read by you to obtain the media. -If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google-books1/trait.ResponseResult.html), it will return that by default. +If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google_books1/trait.ResponseResult.html), 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")`. @@ -167,29 +167,29 @@ Methods supporting uploads can do so using up to 2 different protocols: ## Customization and Callbacks -You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google-books1/trait.Delegate.html) to the -[Method Builder](http://byron.github.io/google-apis-rs/google-books1/trait.CallBuilder.html) before making the final `doit()` call. +You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google_books1/trait.Delegate.html) to the +[Method Builder](http://byron.github.io/google-apis-rs/google_books1/trait.CallBuilder.html) 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](http://byron.github.io/google-apis-rs/google-books1/trait.Delegate.html) is default-implemented, allowing you to customize it with minimal effort. +The [delegate trait](http://byron.github.io/google-apis-rs/google_books1/trait.Delegate.html) 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](http://byron.github.io/google-apis-rs/google-books1/trait.RequestValue.html) and -[decodable](http://byron.github.io/google-apis-rs/google-books1/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses +All structures provided by this library are made to be [enocodable](http://byron.github.io/google-apis-rs/google_books1/trait.RequestValue.html) and +[decodable](http://byron.github.io/google-apis-rs/google_books1/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses are valid. -Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google-books1/trait.Part.html) which are identifiable by name, which will be sent to +Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google_books1/trait.Part.html) 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](http://byron.github.io/google-apis-rs/google-books1/trait.CallBuilder.html), you are able to prepare an action call by repeatedly calling it's methods. +Using [method builders](http://byron.github.io/google-apis-rs/google_books1/trait.CallBuilder.html), 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][wiki-pod] are handed by copy * strings are passed as `&str` -* [request values](http://byron.github.io/google-apis-rs/google-books1/trait.RequestValue.html) are borrowed +* [request values](http://byron.github.io/google-apis-rs/google_books1/trait.RequestValue.html) are borrowed Arguments will always be copied or cloned into the builder, to make them independent of their original life times. diff --git a/gen/calendar3/README.md b/gen/calendar3/README.md index cec60509ba..e152b60234 100644 --- a/gen/calendar3/README.md +++ b/gen/calendar3/README.md @@ -11,37 +11,37 @@ Everything else about the *calendar* *v3* API can be found at the [official documentation site](https://developers.google.com/google-apps/calendar/firstapp). # Features -Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google-calendar3/struct.CalendarHub.html) ... +Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google_calendar3/struct.CalendarHub.html) ... -* [acl](http://byron.github.io/google-apis-rs/google-calendar3/struct.Acl.html) - * [*delete*](http://byron.github.io/google-apis-rs/google-calendar3/struct.AclDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google-calendar3/struct.AclGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google-calendar3/struct.AclInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google-calendar3/struct.AclListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google-calendar3/struct.AclPatchCall.html), [*update*](http://byron.github.io/google-apis-rs/google-calendar3/struct.AclUpdateCall.html) and [*watch*](http://byron.github.io/google-apis-rs/google-calendar3/struct.AclWatchCall.html) -* [calendar list](http://byron.github.io/google-apis-rs/google-calendar3/struct.CalendarList.html) - * [*delete*](http://byron.github.io/google-apis-rs/google-calendar3/struct.CalendarListDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google-calendar3/struct.CalendarListGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google-calendar3/struct.CalendarListInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google-calendar3/struct.CalendarListListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google-calendar3/struct.CalendarListPatchCall.html), [*update*](http://byron.github.io/google-apis-rs/google-calendar3/struct.CalendarListUpdateCall.html) and [*watch*](http://byron.github.io/google-apis-rs/google-calendar3/struct.CalendarListWatchCall.html) -* [calendars](http://byron.github.io/google-apis-rs/google-calendar3/struct.Calendar.html) - * [*clear*](http://byron.github.io/google-apis-rs/google-calendar3/struct.CalendarClearCall.html), [*delete*](http://byron.github.io/google-apis-rs/google-calendar3/struct.CalendarDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google-calendar3/struct.CalendarGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google-calendar3/struct.CalendarInsertCall.html), [*patch*](http://byron.github.io/google-apis-rs/google-calendar3/struct.CalendarPatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google-calendar3/struct.CalendarUpdateCall.html) -* [channels](http://byron.github.io/google-apis-rs/google-calendar3/struct.Channel.html) - * [*stop*](http://byron.github.io/google-apis-rs/google-calendar3/struct.ChannelStopCall.html) +* [acl](http://byron.github.io/google-apis-rs/google_calendar3/struct.Acl.html) + * [*delete*](http://byron.github.io/google-apis-rs/google_calendar3/struct.AclDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google_calendar3/struct.AclGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google_calendar3/struct.AclInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google_calendar3/struct.AclListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google_calendar3/struct.AclPatchCall.html), [*update*](http://byron.github.io/google-apis-rs/google_calendar3/struct.AclUpdateCall.html) and [*watch*](http://byron.github.io/google-apis-rs/google_calendar3/struct.AclWatchCall.html) +* [calendar list](http://byron.github.io/google-apis-rs/google_calendar3/struct.CalendarList.html) + * [*delete*](http://byron.github.io/google-apis-rs/google_calendar3/struct.CalendarListDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google_calendar3/struct.CalendarListGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google_calendar3/struct.CalendarListInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google_calendar3/struct.CalendarListListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google_calendar3/struct.CalendarListPatchCall.html), [*update*](http://byron.github.io/google-apis-rs/google_calendar3/struct.CalendarListUpdateCall.html) and [*watch*](http://byron.github.io/google-apis-rs/google_calendar3/struct.CalendarListWatchCall.html) +* [calendars](http://byron.github.io/google-apis-rs/google_calendar3/struct.Calendar.html) + * [*clear*](http://byron.github.io/google-apis-rs/google_calendar3/struct.CalendarClearCall.html), [*delete*](http://byron.github.io/google-apis-rs/google_calendar3/struct.CalendarDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google_calendar3/struct.CalendarGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google_calendar3/struct.CalendarInsertCall.html), [*patch*](http://byron.github.io/google-apis-rs/google_calendar3/struct.CalendarPatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google_calendar3/struct.CalendarUpdateCall.html) +* [channels](http://byron.github.io/google-apis-rs/google_calendar3/struct.Channel.html) + * [*stop*](http://byron.github.io/google-apis-rs/google_calendar3/struct.ChannelStopCall.html) * colors - * [*get*](http://byron.github.io/google-apis-rs/google-calendar3/struct.ColorGetCall.html) -* [events](http://byron.github.io/google-apis-rs/google-calendar3/struct.Event.html) - * [*delete*](http://byron.github.io/google-apis-rs/google-calendar3/struct.EventDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google-calendar3/struct.EventGetCall.html), [*import*](http://byron.github.io/google-apis-rs/google-calendar3/struct.EventImportCall.html), [*insert*](http://byron.github.io/google-apis-rs/google-calendar3/struct.EventInsertCall.html), [*instances*](http://byron.github.io/google-apis-rs/google-calendar3/struct.EventInstanceCall.html), [*list*](http://byron.github.io/google-apis-rs/google-calendar3/struct.EventListCall.html), [*move*](http://byron.github.io/google-apis-rs/google-calendar3/struct.EventMoveCall.html), [*patch*](http://byron.github.io/google-apis-rs/google-calendar3/struct.EventPatchCall.html), [*quick add*](http://byron.github.io/google-apis-rs/google-calendar3/struct.EventQuickAddCall.html), [*update*](http://byron.github.io/google-apis-rs/google-calendar3/struct.EventUpdateCall.html) and [*watch*](http://byron.github.io/google-apis-rs/google-calendar3/struct.EventWatchCall.html) + * [*get*](http://byron.github.io/google-apis-rs/google_calendar3/struct.ColorGetCall.html) +* [events](http://byron.github.io/google-apis-rs/google_calendar3/struct.Event.html) + * [*delete*](http://byron.github.io/google-apis-rs/google_calendar3/struct.EventDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google_calendar3/struct.EventGetCall.html), [*import*](http://byron.github.io/google-apis-rs/google_calendar3/struct.EventImportCall.html), [*insert*](http://byron.github.io/google-apis-rs/google_calendar3/struct.EventInsertCall.html), [*instances*](http://byron.github.io/google-apis-rs/google_calendar3/struct.EventInstanceCall.html), [*list*](http://byron.github.io/google-apis-rs/google_calendar3/struct.EventListCall.html), [*move*](http://byron.github.io/google-apis-rs/google_calendar3/struct.EventMoveCall.html), [*patch*](http://byron.github.io/google-apis-rs/google_calendar3/struct.EventPatchCall.html), [*quick add*](http://byron.github.io/google-apis-rs/google_calendar3/struct.EventQuickAddCall.html), [*update*](http://byron.github.io/google-apis-rs/google_calendar3/struct.EventUpdateCall.html) and [*watch*](http://byron.github.io/google-apis-rs/google_calendar3/struct.EventWatchCall.html) * freebusy - * [*query*](http://byron.github.io/google-apis-rs/google-calendar3/struct.FreebusyQueryCall.html) -* [settings](http://byron.github.io/google-apis-rs/google-calendar3/struct.Setting.html) - * [*get*](http://byron.github.io/google-apis-rs/google-calendar3/struct.SettingGetCall.html), [*list*](http://byron.github.io/google-apis-rs/google-calendar3/struct.SettingListCall.html) and [*watch*](http://byron.github.io/google-apis-rs/google-calendar3/struct.SettingWatchCall.html) + * [*query*](http://byron.github.io/google-apis-rs/google_calendar3/struct.FreebusyQueryCall.html) +* [settings](http://byron.github.io/google-apis-rs/google_calendar3/struct.Setting.html) + * [*get*](http://byron.github.io/google-apis-rs/google_calendar3/struct.SettingGetCall.html), [*list*](http://byron.github.io/google-apis-rs/google_calendar3/struct.SettingListCall.html) and [*watch*](http://byron.github.io/google-apis-rs/google_calendar3/struct.SettingWatchCall.html) Subscription supported by ... -* [*list settings*](http://byron.github.io/google-apis-rs/google-calendar3/struct.SettingListCall.html) -* [*list events*](http://byron.github.io/google-apis-rs/google-calendar3/struct.EventListCall.html) -* [*list calendar list*](http://byron.github.io/google-apis-rs/google-calendar3/struct.CalendarListListCall.html) -* [*watch events*](http://byron.github.io/google-apis-rs/google-calendar3/struct.EventWatchCall.html) -* [*instances events*](http://byron.github.io/google-apis-rs/google-calendar3/struct.EventInstanceCall.html) -* [*watch settings*](http://byron.github.io/google-apis-rs/google-calendar3/struct.SettingWatchCall.html) -* [*watch acl*](http://byron.github.io/google-apis-rs/google-calendar3/struct.AclWatchCall.html) -* [*list acl*](http://byron.github.io/google-apis-rs/google-calendar3/struct.AclListCall.html) -* [*watch calendar list*](http://byron.github.io/google-apis-rs/google-calendar3/struct.CalendarListWatchCall.html) +* [*list settings*](http://byron.github.io/google-apis-rs/google_calendar3/struct.SettingListCall.html) +* [*list events*](http://byron.github.io/google-apis-rs/google_calendar3/struct.EventListCall.html) +* [*list calendar list*](http://byron.github.io/google-apis-rs/google_calendar3/struct.CalendarListListCall.html) +* [*watch events*](http://byron.github.io/google-apis-rs/google_calendar3/struct.EventWatchCall.html) +* [*instances events*](http://byron.github.io/google-apis-rs/google_calendar3/struct.EventInstanceCall.html) +* [*watch settings*](http://byron.github.io/google-apis-rs/google_calendar3/struct.SettingWatchCall.html) +* [*watch acl*](http://byron.github.io/google-apis-rs/google_calendar3/struct.AclWatchCall.html) +* [*list acl*](http://byron.github.io/google-apis-rs/google_calendar3/struct.AclListCall.html) +* [*watch calendar list*](http://byron.github.io/google-apis-rs/google_calendar3/struct.CalendarListWatchCall.html) @@ -49,17 +49,17 @@ Subscription supported by ... The API is structured into the following primary items: -* **[Hub](http://byron.github.io/google-apis-rs/google-calendar3/struct.CalendarHub.html)** +* **[Hub](http://byron.github.io/google-apis-rs/google_calendar3/struct.CalendarHub.html)** * a central object to maintain state and allow accessing all *Activities* - * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google-calendar3/trait.MethodsBuilder.html) which in turn - allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google-calendar3/trait.CallBuilder.html) -* **[Resources](http://byron.github.io/google-apis-rs/google-calendar3/trait.Resource.html)** + * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google_calendar3/trait.MethodsBuilder.html) which in turn + allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google_calendar3/trait.CallBuilder.html) +* **[Resources](http://byron.github.io/google-apis-rs/google_calendar3/trait.Resource.html)** * primary types that you can apply *Activities* to * a collection of properties and *Parts* - * **[Parts](http://byron.github.io/google-apis-rs/google-calendar3/trait.Part.html)** + * **[Parts](http://byron.github.io/google-apis-rs/google_calendar3/trait.Part.html)** * a collection of properties * never directly used in *Activities* -* **[Activities](http://byron.github.io/google-apis-rs/google-calendar3/trait.CallBuilder.html)** +* **[Activities](http://byron.github.io/google-apis-rs/google_calendar3/trait.CallBuilder.html)** * operations to apply to *Resources* All *structures* are marked with applicable traits to further categorize them and ease browsing. @@ -171,17 +171,17 @@ match result { ``` ## Handling Errors -All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google-calendar3/enum.Result.html) enumeration as return value of +All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google_calendar3/enum.Result.html) enumeration as return value of the doit() methods, or handed as possibly intermediate results to either the -[Hub Delegate](http://byron.github.io/google-apis-rs/google-calendar3/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google-calendar3/../yup-oauth2/trait.AuthenticatorDelegate.html). +[Hub Delegate](http://byron.github.io/google-apis-rs/google_calendar3/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google_calendar3/../yup-oauth2/trait.AuthenticatorDelegate.html). 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](http://byron.github.io/google-apis-rs/google-calendar3/enum.Result.html), should be +If a method supports downloads, the response body, which is part of the [Result](http://byron.github.io/google-apis-rs/google_calendar3/enum.Result.html), should be read by you to obtain the media. -If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google-calendar3/trait.ResponseResult.html), it will return that by default. +If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google_calendar3/trait.ResponseResult.html), 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")`. @@ -191,29 +191,29 @@ Methods supporting uploads can do so using up to 2 different protocols: ## Customization and Callbacks -You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google-calendar3/trait.Delegate.html) to the -[Method Builder](http://byron.github.io/google-apis-rs/google-calendar3/trait.CallBuilder.html) before making the final `doit()` call. +You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google_calendar3/trait.Delegate.html) to the +[Method Builder](http://byron.github.io/google-apis-rs/google_calendar3/trait.CallBuilder.html) 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](http://byron.github.io/google-apis-rs/google-calendar3/trait.Delegate.html) is default-implemented, allowing you to customize it with minimal effort. +The [delegate trait](http://byron.github.io/google-apis-rs/google_calendar3/trait.Delegate.html) 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](http://byron.github.io/google-apis-rs/google-calendar3/trait.RequestValue.html) and -[decodable](http://byron.github.io/google-apis-rs/google-calendar3/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses +All structures provided by this library are made to be [enocodable](http://byron.github.io/google-apis-rs/google_calendar3/trait.RequestValue.html) and +[decodable](http://byron.github.io/google-apis-rs/google_calendar3/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses are valid. -Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google-calendar3/trait.Part.html) which are identifiable by name, which will be sent to +Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google_calendar3/trait.Part.html) 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](http://byron.github.io/google-apis-rs/google-calendar3/trait.CallBuilder.html), you are able to prepare an action call by repeatedly calling it's methods. +Using [method builders](http://byron.github.io/google-apis-rs/google_calendar3/trait.CallBuilder.html), 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][wiki-pod] are handed by copy * strings are passed as `&str` -* [request values](http://byron.github.io/google-apis-rs/google-calendar3/trait.RequestValue.html) are borrowed +* [request values](http://byron.github.io/google-apis-rs/google_calendar3/trait.RequestValue.html) are borrowed Arguments will always be copied or cloned into the builder, to make them independent of their original life times. diff --git a/gen/civicinfo2/README.md b/gen/civicinfo2/README.md index b6c4a86b10..90baadb1fa 100644 --- a/gen/civicinfo2/README.md +++ b/gen/civicinfo2/README.md @@ -11,14 +11,14 @@ Everything else about the *Civic Info* *v2* API can be found at the [official documentation site](https://developers.google.com/civic-information). # Features -Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google-civicinfo2/struct.CivicInfo.html) ... +Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google_civicinfo2/struct.CivicInfo.html) ... * divisions - * [*search*](http://byron.github.io/google-apis-rs/google-civicinfo2/struct.DivisionSearchCall.html) -* [elections](http://byron.github.io/google-apis-rs/google-civicinfo2/struct.Election.html) - * [*election query*](http://byron.github.io/google-apis-rs/google-civicinfo2/struct.ElectionElectionQueryCall.html) and [*voter info query*](http://byron.github.io/google-apis-rs/google-civicinfo2/struct.ElectionVoterInfoQueryCall.html) + * [*search*](http://byron.github.io/google-apis-rs/google_civicinfo2/struct.DivisionSearchCall.html) +* [elections](http://byron.github.io/google-apis-rs/google_civicinfo2/struct.Election.html) + * [*election query*](http://byron.github.io/google-apis-rs/google_civicinfo2/struct.ElectionElectionQueryCall.html) and [*voter info query*](http://byron.github.io/google-apis-rs/google_civicinfo2/struct.ElectionVoterInfoQueryCall.html) * representatives - * [*representative info by address*](http://byron.github.io/google-apis-rs/google-civicinfo2/struct.RepresentativeRepresentativeInfoByAddresCall.html) and [*representative info by division*](http://byron.github.io/google-apis-rs/google-civicinfo2/struct.RepresentativeRepresentativeInfoByDivisionCall.html) + * [*representative info by address*](http://byron.github.io/google-apis-rs/google_civicinfo2/struct.RepresentativeRepresentativeInfoByAddresCall.html) and [*representative info by division*](http://byron.github.io/google-apis-rs/google_civicinfo2/struct.RepresentativeRepresentativeInfoByDivisionCall.html) @@ -27,17 +27,17 @@ Handle the following *Resources* with ease from the central [hub](http://byron.g The API is structured into the following primary items: -* **[Hub](http://byron.github.io/google-apis-rs/google-civicinfo2/struct.CivicInfo.html)** +* **[Hub](http://byron.github.io/google-apis-rs/google_civicinfo2/struct.CivicInfo.html)** * a central object to maintain state and allow accessing all *Activities* - * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google-civicinfo2/trait.MethodsBuilder.html) which in turn - allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google-civicinfo2/trait.CallBuilder.html) -* **[Resources](http://byron.github.io/google-apis-rs/google-civicinfo2/trait.Resource.html)** + * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google_civicinfo2/trait.MethodsBuilder.html) which in turn + allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google_civicinfo2/trait.CallBuilder.html) +* **[Resources](http://byron.github.io/google-apis-rs/google_civicinfo2/trait.Resource.html)** * primary types that you can apply *Activities* to * a collection of properties and *Parts* - * **[Parts](http://byron.github.io/google-apis-rs/google-civicinfo2/trait.Part.html)** + * **[Parts](http://byron.github.io/google-apis-rs/google_civicinfo2/trait.Part.html)** * a collection of properties * never directly used in *Activities* -* **[Activities](http://byron.github.io/google-apis-rs/google-civicinfo2/trait.CallBuilder.html)** +* **[Activities](http://byron.github.io/google-apis-rs/google_civicinfo2/trait.CallBuilder.html)** * operations to apply to *Resources* All *structures* are marked with applicable traits to further categorize them and ease browsing. @@ -119,17 +119,17 @@ match result { ``` ## Handling Errors -All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google-civicinfo2/enum.Result.html) enumeration as return value of +All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google_civicinfo2/enum.Result.html) enumeration as return value of the doit() methods, or handed as possibly intermediate results to either the -[Hub Delegate](http://byron.github.io/google-apis-rs/google-civicinfo2/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google-civicinfo2/../yup-oauth2/trait.AuthenticatorDelegate.html). +[Hub Delegate](http://byron.github.io/google-apis-rs/google_civicinfo2/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google_civicinfo2/../yup-oauth2/trait.AuthenticatorDelegate.html). 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](http://byron.github.io/google-apis-rs/google-civicinfo2/enum.Result.html), should be +If a method supports downloads, the response body, which is part of the [Result](http://byron.github.io/google-apis-rs/google_civicinfo2/enum.Result.html), should be read by you to obtain the media. -If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google-civicinfo2/trait.ResponseResult.html), it will return that by default. +If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google_civicinfo2/trait.ResponseResult.html), 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")`. @@ -139,29 +139,29 @@ Methods supporting uploads can do so using up to 2 different protocols: ## Customization and Callbacks -You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google-civicinfo2/trait.Delegate.html) to the -[Method Builder](http://byron.github.io/google-apis-rs/google-civicinfo2/trait.CallBuilder.html) before making the final `doit()` call. +You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google_civicinfo2/trait.Delegate.html) to the +[Method Builder](http://byron.github.io/google-apis-rs/google_civicinfo2/trait.CallBuilder.html) 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](http://byron.github.io/google-apis-rs/google-civicinfo2/trait.Delegate.html) is default-implemented, allowing you to customize it with minimal effort. +The [delegate trait](http://byron.github.io/google-apis-rs/google_civicinfo2/trait.Delegate.html) 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](http://byron.github.io/google-apis-rs/google-civicinfo2/trait.RequestValue.html) and -[decodable](http://byron.github.io/google-apis-rs/google-civicinfo2/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses +All structures provided by this library are made to be [enocodable](http://byron.github.io/google-apis-rs/google_civicinfo2/trait.RequestValue.html) and +[decodable](http://byron.github.io/google-apis-rs/google_civicinfo2/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses are valid. -Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google-civicinfo2/trait.Part.html) which are identifiable by name, which will be sent to +Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google_civicinfo2/trait.Part.html) 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](http://byron.github.io/google-apis-rs/google-civicinfo2/trait.CallBuilder.html), you are able to prepare an action call by repeatedly calling it's methods. +Using [method builders](http://byron.github.io/google-apis-rs/google_civicinfo2/trait.CallBuilder.html), 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][wiki-pod] are handed by copy * strings are passed as `&str` -* [request values](http://byron.github.io/google-apis-rs/google-civicinfo2/trait.RequestValue.html) are borrowed +* [request values](http://byron.github.io/google-apis-rs/google_civicinfo2/trait.RequestValue.html) are borrowed Arguments will always be copied or cloned into the builder, to make them independent of their original life times. diff --git a/gen/cloudlatencytest2/README.md b/gen/cloudlatencytest2/README.md index 201dc3e790..c9648b1491 100644 --- a/gen/cloudlatencytest2/README.md +++ b/gen/cloudlatencytest2/README.md @@ -8,10 +8,10 @@ The `google-cloudlatencytest2` library allows access to all features of the *Goo This documentation was generated from *cloudlatencytest* crate version *0.1.5+20150206*, where *20150206* is the exact revision of the *cloudlatencytest:v2* schema built by the [mako](http://www.makotemplates.org/) code generator *v0.1.5*. # Features -Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google-cloudlatencytest2/struct.Cloudlatencytest.html) ... +Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google_cloudlatencytest2/struct.Cloudlatencytest.html) ... * statscollection - * [*updateaggregatedstats*](http://byron.github.io/google-apis-rs/google-cloudlatencytest2/struct.StatscollectionUpdateaggregatedstatCall.html) and [*updatestats*](http://byron.github.io/google-apis-rs/google-cloudlatencytest2/struct.StatscollectionUpdatestatCall.html) + * [*updateaggregatedstats*](http://byron.github.io/google-apis-rs/google_cloudlatencytest2/struct.StatscollectionUpdateaggregatedstatCall.html) and [*updatestats*](http://byron.github.io/google-apis-rs/google_cloudlatencytest2/struct.StatscollectionUpdatestatCall.html) @@ -20,17 +20,17 @@ Handle the following *Resources* with ease from the central [hub](http://byron.g The API is structured into the following primary items: -* **[Hub](http://byron.github.io/google-apis-rs/google-cloudlatencytest2/struct.Cloudlatencytest.html)** +* **[Hub](http://byron.github.io/google-apis-rs/google_cloudlatencytest2/struct.Cloudlatencytest.html)** * a central object to maintain state and allow accessing all *Activities* - * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google-cloudlatencytest2/trait.MethodsBuilder.html) which in turn - allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google-cloudlatencytest2/trait.CallBuilder.html) -* **[Resources](http://byron.github.io/google-apis-rs/google-cloudlatencytest2/trait.Resource.html)** + * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google_cloudlatencytest2/trait.MethodsBuilder.html) which in turn + allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google_cloudlatencytest2/trait.CallBuilder.html) +* **[Resources](http://byron.github.io/google-apis-rs/google_cloudlatencytest2/trait.Resource.html)** * primary types that you can apply *Activities* to * a collection of properties and *Parts* - * **[Parts](http://byron.github.io/google-apis-rs/google-cloudlatencytest2/trait.Part.html)** + * **[Parts](http://byron.github.io/google-apis-rs/google_cloudlatencytest2/trait.Part.html)** * a collection of properties * never directly used in *Activities* -* **[Activities](http://byron.github.io/google-apis-rs/google-cloudlatencytest2/trait.CallBuilder.html)** +* **[Activities](http://byron.github.io/google-apis-rs/google_cloudlatencytest2/trait.CallBuilder.html)** * operations to apply to *Resources* All *structures* are marked with applicable traits to further categorize them and ease browsing. @@ -115,17 +115,17 @@ match result { ``` ## Handling Errors -All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google-cloudlatencytest2/enum.Result.html) enumeration as return value of +All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google_cloudlatencytest2/enum.Result.html) enumeration as return value of the doit() methods, or handed as possibly intermediate results to either the -[Hub Delegate](http://byron.github.io/google-apis-rs/google-cloudlatencytest2/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google-cloudlatencytest2/../yup-oauth2/trait.AuthenticatorDelegate.html). +[Hub Delegate](http://byron.github.io/google-apis-rs/google_cloudlatencytest2/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google_cloudlatencytest2/../yup-oauth2/trait.AuthenticatorDelegate.html). 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](http://byron.github.io/google-apis-rs/google-cloudlatencytest2/enum.Result.html), should be +If a method supports downloads, the response body, which is part of the [Result](http://byron.github.io/google-apis-rs/google_cloudlatencytest2/enum.Result.html), should be read by you to obtain the media. -If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google-cloudlatencytest2/trait.ResponseResult.html), it will return that by default. +If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google_cloudlatencytest2/trait.ResponseResult.html), 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")`. @@ -135,29 +135,29 @@ Methods supporting uploads can do so using up to 2 different protocols: ## Customization and Callbacks -You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google-cloudlatencytest2/trait.Delegate.html) to the -[Method Builder](http://byron.github.io/google-apis-rs/google-cloudlatencytest2/trait.CallBuilder.html) before making the final `doit()` call. +You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google_cloudlatencytest2/trait.Delegate.html) to the +[Method Builder](http://byron.github.io/google-apis-rs/google_cloudlatencytest2/trait.CallBuilder.html) 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](http://byron.github.io/google-apis-rs/google-cloudlatencytest2/trait.Delegate.html) is default-implemented, allowing you to customize it with minimal effort. +The [delegate trait](http://byron.github.io/google-apis-rs/google_cloudlatencytest2/trait.Delegate.html) 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](http://byron.github.io/google-apis-rs/google-cloudlatencytest2/trait.RequestValue.html) and -[decodable](http://byron.github.io/google-apis-rs/google-cloudlatencytest2/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses +All structures provided by this library are made to be [enocodable](http://byron.github.io/google-apis-rs/google_cloudlatencytest2/trait.RequestValue.html) and +[decodable](http://byron.github.io/google-apis-rs/google_cloudlatencytest2/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses are valid. -Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google-cloudlatencytest2/trait.Part.html) which are identifiable by name, which will be sent to +Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google_cloudlatencytest2/trait.Part.html) 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](http://byron.github.io/google-apis-rs/google-cloudlatencytest2/trait.CallBuilder.html), you are able to prepare an action call by repeatedly calling it's methods. +Using [method builders](http://byron.github.io/google-apis-rs/google_cloudlatencytest2/trait.CallBuilder.html), 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][wiki-pod] are handed by copy * strings are passed as `&str` -* [request values](http://byron.github.io/google-apis-rs/google-cloudlatencytest2/trait.RequestValue.html) are borrowed +* [request values](http://byron.github.io/google-apis-rs/google_cloudlatencytest2/trait.RequestValue.html) are borrowed Arguments will always be copied or cloned into the builder, to make them independent of their original life times. diff --git a/gen/cloudmonitoring2_beta2/README.md b/gen/cloudmonitoring2_beta2/README.md index 664d1ae43a..9ef92ce9b7 100644 --- a/gen/cloudmonitoring2_beta2/README.md +++ b/gen/cloudmonitoring2_beta2/README.md @@ -11,14 +11,14 @@ Everything else about the *Cloud Monitoring* *v2_beta2* API can be found at the [official documentation site](https://cloud.google.com/monitoring/v2beta2/). # Features -Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google-cloudmonitoring2_beta2/struct.CloudMonitoring.html) ... +Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google_cloudmonitoring2_beta2/struct.CloudMonitoring.html) ... -* [metric descriptors](http://byron.github.io/google-apis-rs/google-cloudmonitoring2_beta2/struct.MetricDescriptor.html) - * [*create*](http://byron.github.io/google-apis-rs/google-cloudmonitoring2_beta2/struct.MetricDescriptorCreateCall.html), [*delete*](http://byron.github.io/google-apis-rs/google-cloudmonitoring2_beta2/struct.MetricDescriptorDeleteCall.html) and [*list*](http://byron.github.io/google-apis-rs/google-cloudmonitoring2_beta2/struct.MetricDescriptorListCall.html) +* [metric descriptors](http://byron.github.io/google-apis-rs/google_cloudmonitoring2_beta2/struct.MetricDescriptor.html) + * [*create*](http://byron.github.io/google-apis-rs/google_cloudmonitoring2_beta2/struct.MetricDescriptorCreateCall.html), [*delete*](http://byron.github.io/google-apis-rs/google_cloudmonitoring2_beta2/struct.MetricDescriptorDeleteCall.html) and [*list*](http://byron.github.io/google-apis-rs/google_cloudmonitoring2_beta2/struct.MetricDescriptorListCall.html) * timeseries - * [*list*](http://byron.github.io/google-apis-rs/google-cloudmonitoring2_beta2/struct.TimeseryListCall.html) and [*write*](http://byron.github.io/google-apis-rs/google-cloudmonitoring2_beta2/struct.TimeseryWriteCall.html) -* [timeseries descriptors](http://byron.github.io/google-apis-rs/google-cloudmonitoring2_beta2/struct.TimeseriesDescriptor.html) - * [*list*](http://byron.github.io/google-apis-rs/google-cloudmonitoring2_beta2/struct.TimeseriesDescriptorListCall.html) + * [*list*](http://byron.github.io/google-apis-rs/google_cloudmonitoring2_beta2/struct.TimeseryListCall.html) and [*write*](http://byron.github.io/google-apis-rs/google_cloudmonitoring2_beta2/struct.TimeseryWriteCall.html) +* [timeseries descriptors](http://byron.github.io/google-apis-rs/google_cloudmonitoring2_beta2/struct.TimeseriesDescriptor.html) + * [*list*](http://byron.github.io/google-apis-rs/google_cloudmonitoring2_beta2/struct.TimeseriesDescriptorListCall.html) @@ -27,17 +27,17 @@ Handle the following *Resources* with ease from the central [hub](http://byron.g The API is structured into the following primary items: -* **[Hub](http://byron.github.io/google-apis-rs/google-cloudmonitoring2_beta2/struct.CloudMonitoring.html)** +* **[Hub](http://byron.github.io/google-apis-rs/google_cloudmonitoring2_beta2/struct.CloudMonitoring.html)** * a central object to maintain state and allow accessing all *Activities* - * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google-cloudmonitoring2_beta2/trait.MethodsBuilder.html) which in turn - allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google-cloudmonitoring2_beta2/trait.CallBuilder.html) -* **[Resources](http://byron.github.io/google-apis-rs/google-cloudmonitoring2_beta2/trait.Resource.html)** + * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google_cloudmonitoring2_beta2/trait.MethodsBuilder.html) which in turn + allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google_cloudmonitoring2_beta2/trait.CallBuilder.html) +* **[Resources](http://byron.github.io/google-apis-rs/google_cloudmonitoring2_beta2/trait.Resource.html)** * primary types that you can apply *Activities* to * a collection of properties and *Parts* - * **[Parts](http://byron.github.io/google-apis-rs/google-cloudmonitoring2_beta2/trait.Part.html)** + * **[Parts](http://byron.github.io/google-apis-rs/google_cloudmonitoring2_beta2/trait.Part.html)** * a collection of properties * never directly used in *Activities* -* **[Activities](http://byron.github.io/google-apis-rs/google-cloudmonitoring2_beta2/trait.CallBuilder.html)** +* **[Activities](http://byron.github.io/google-apis-rs/google_cloudmonitoring2_beta2/trait.CallBuilder.html)** * operations to apply to *Resources* All *structures* are marked with applicable traits to further categorize them and ease browsing. @@ -127,17 +127,17 @@ match result { ``` ## Handling Errors -All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google-cloudmonitoring2_beta2/enum.Result.html) enumeration as return value of +All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google_cloudmonitoring2_beta2/enum.Result.html) enumeration as return value of the doit() methods, or handed as possibly intermediate results to either the -[Hub Delegate](http://byron.github.io/google-apis-rs/google-cloudmonitoring2_beta2/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google-cloudmonitoring2_beta2/../yup-oauth2/trait.AuthenticatorDelegate.html). +[Hub Delegate](http://byron.github.io/google-apis-rs/google_cloudmonitoring2_beta2/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google_cloudmonitoring2_beta2/../yup-oauth2/trait.AuthenticatorDelegate.html). 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](http://byron.github.io/google-apis-rs/google-cloudmonitoring2_beta2/enum.Result.html), should be +If a method supports downloads, the response body, which is part of the [Result](http://byron.github.io/google-apis-rs/google_cloudmonitoring2_beta2/enum.Result.html), should be read by you to obtain the media. -If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google-cloudmonitoring2_beta2/trait.ResponseResult.html), it will return that by default. +If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google_cloudmonitoring2_beta2/trait.ResponseResult.html), 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")`. @@ -147,29 +147,29 @@ Methods supporting uploads can do so using up to 2 different protocols: ## Customization and Callbacks -You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google-cloudmonitoring2_beta2/trait.Delegate.html) to the -[Method Builder](http://byron.github.io/google-apis-rs/google-cloudmonitoring2_beta2/trait.CallBuilder.html) before making the final `doit()` call. +You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google_cloudmonitoring2_beta2/trait.Delegate.html) to the +[Method Builder](http://byron.github.io/google-apis-rs/google_cloudmonitoring2_beta2/trait.CallBuilder.html) 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](http://byron.github.io/google-apis-rs/google-cloudmonitoring2_beta2/trait.Delegate.html) is default-implemented, allowing you to customize it with minimal effort. +The [delegate trait](http://byron.github.io/google-apis-rs/google_cloudmonitoring2_beta2/trait.Delegate.html) 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](http://byron.github.io/google-apis-rs/google-cloudmonitoring2_beta2/trait.RequestValue.html) and -[decodable](http://byron.github.io/google-apis-rs/google-cloudmonitoring2_beta2/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses +All structures provided by this library are made to be [enocodable](http://byron.github.io/google-apis-rs/google_cloudmonitoring2_beta2/trait.RequestValue.html) and +[decodable](http://byron.github.io/google-apis-rs/google_cloudmonitoring2_beta2/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses are valid. -Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google-cloudmonitoring2_beta2/trait.Part.html) which are identifiable by name, which will be sent to +Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google_cloudmonitoring2_beta2/trait.Part.html) 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](http://byron.github.io/google-apis-rs/google-cloudmonitoring2_beta2/trait.CallBuilder.html), you are able to prepare an action call by repeatedly calling it's methods. +Using [method builders](http://byron.github.io/google-apis-rs/google_cloudmonitoring2_beta2/trait.CallBuilder.html), 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][wiki-pod] are handed by copy * strings are passed as `&str` -* [request values](http://byron.github.io/google-apis-rs/google-cloudmonitoring2_beta2/trait.RequestValue.html) are borrowed +* [request values](http://byron.github.io/google-apis-rs/google_cloudmonitoring2_beta2/trait.RequestValue.html) are borrowed Arguments will always be copied or cloned into the builder, to make them independent of their original life times. diff --git a/gen/cloudsearch1/README.md b/gen/cloudsearch1/README.md index f733fd5fbf..46ba51c87e 100644 --- a/gen/cloudsearch1/README.md +++ b/gen/cloudsearch1/README.md @@ -8,10 +8,10 @@ The `google-cloudsearch1` library allows access to all features of the *Google c This documentation was generated from *cloudsearch* crate version *0.1.5+20150309*, where *20150309* is the exact revision of the *cloudsearch:v1* schema built by the [mako](http://www.makotemplates.org/) code generator *v0.1.5*. # Features -Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google-cloudsearch1/struct.Cloudsearch.html) ... +Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google_cloudsearch1/struct.Cloudsearch.html) ... * projects - * [*indexes documents create*](http://byron.github.io/google-apis-rs/google-cloudsearch1/struct.ProjectIndexeDocumentCreateCall.html), [*indexes documents delete*](http://byron.github.io/google-apis-rs/google-cloudsearch1/struct.ProjectIndexeDocumentDeleteCall.html), [*indexes documents get*](http://byron.github.io/google-apis-rs/google-cloudsearch1/struct.ProjectIndexeDocumentGetCall.html), [*indexes documents list*](http://byron.github.io/google-apis-rs/google-cloudsearch1/struct.ProjectIndexeDocumentListCall.html), [*indexes list*](http://byron.github.io/google-apis-rs/google-cloudsearch1/struct.ProjectIndexeListCall.html) and [*indexes search*](http://byron.github.io/google-apis-rs/google-cloudsearch1/struct.ProjectIndexeSearchCall.html) + * [*indexes documents create*](http://byron.github.io/google-apis-rs/google_cloudsearch1/struct.ProjectIndexeDocumentCreateCall.html), [*indexes documents delete*](http://byron.github.io/google-apis-rs/google_cloudsearch1/struct.ProjectIndexeDocumentDeleteCall.html), [*indexes documents get*](http://byron.github.io/google-apis-rs/google_cloudsearch1/struct.ProjectIndexeDocumentGetCall.html), [*indexes documents list*](http://byron.github.io/google-apis-rs/google_cloudsearch1/struct.ProjectIndexeDocumentListCall.html), [*indexes list*](http://byron.github.io/google-apis-rs/google_cloudsearch1/struct.ProjectIndexeListCall.html) and [*indexes search*](http://byron.github.io/google-apis-rs/google_cloudsearch1/struct.ProjectIndexeSearchCall.html) @@ -20,17 +20,17 @@ Handle the following *Resources* with ease from the central [hub](http://byron.g The API is structured into the following primary items: -* **[Hub](http://byron.github.io/google-apis-rs/google-cloudsearch1/struct.Cloudsearch.html)** +* **[Hub](http://byron.github.io/google-apis-rs/google_cloudsearch1/struct.Cloudsearch.html)** * a central object to maintain state and allow accessing all *Activities* - * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google-cloudsearch1/trait.MethodsBuilder.html) which in turn - allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google-cloudsearch1/trait.CallBuilder.html) -* **[Resources](http://byron.github.io/google-apis-rs/google-cloudsearch1/trait.Resource.html)** + * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google_cloudsearch1/trait.MethodsBuilder.html) which in turn + allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google_cloudsearch1/trait.CallBuilder.html) +* **[Resources](http://byron.github.io/google-apis-rs/google_cloudsearch1/trait.Resource.html)** * primary types that you can apply *Activities* to * a collection of properties and *Parts* - * **[Parts](http://byron.github.io/google-apis-rs/google-cloudsearch1/trait.Part.html)** + * **[Parts](http://byron.github.io/google-apis-rs/google_cloudsearch1/trait.Part.html)** * a collection of properties * never directly used in *Activities* -* **[Activities](http://byron.github.io/google-apis-rs/google-cloudsearch1/trait.CallBuilder.html)** +* **[Activities](http://byron.github.io/google-apis-rs/google_cloudsearch1/trait.CallBuilder.html)** * operations to apply to *Resources* All *structures* are marked with applicable traits to further categorize them and ease browsing. @@ -110,17 +110,17 @@ match result { ``` ## Handling Errors -All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google-cloudsearch1/enum.Result.html) enumeration as return value of +All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google_cloudsearch1/enum.Result.html) enumeration as return value of the doit() methods, or handed as possibly intermediate results to either the -[Hub Delegate](http://byron.github.io/google-apis-rs/google-cloudsearch1/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google-cloudsearch1/../yup-oauth2/trait.AuthenticatorDelegate.html). +[Hub Delegate](http://byron.github.io/google-apis-rs/google_cloudsearch1/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google_cloudsearch1/../yup-oauth2/trait.AuthenticatorDelegate.html). 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](http://byron.github.io/google-apis-rs/google-cloudsearch1/enum.Result.html), should be +If a method supports downloads, the response body, which is part of the [Result](http://byron.github.io/google-apis-rs/google_cloudsearch1/enum.Result.html), should be read by you to obtain the media. -If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google-cloudsearch1/trait.ResponseResult.html), it will return that by default. +If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google_cloudsearch1/trait.ResponseResult.html), 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")`. @@ -130,29 +130,29 @@ Methods supporting uploads can do so using up to 2 different protocols: ## Customization and Callbacks -You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google-cloudsearch1/trait.Delegate.html) to the -[Method Builder](http://byron.github.io/google-apis-rs/google-cloudsearch1/trait.CallBuilder.html) before making the final `doit()` call. +You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google_cloudsearch1/trait.Delegate.html) to the +[Method Builder](http://byron.github.io/google-apis-rs/google_cloudsearch1/trait.CallBuilder.html) 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](http://byron.github.io/google-apis-rs/google-cloudsearch1/trait.Delegate.html) is default-implemented, allowing you to customize it with minimal effort. +The [delegate trait](http://byron.github.io/google-apis-rs/google_cloudsearch1/trait.Delegate.html) 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](http://byron.github.io/google-apis-rs/google-cloudsearch1/trait.RequestValue.html) and -[decodable](http://byron.github.io/google-apis-rs/google-cloudsearch1/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses +All structures provided by this library are made to be [enocodable](http://byron.github.io/google-apis-rs/google_cloudsearch1/trait.RequestValue.html) and +[decodable](http://byron.github.io/google-apis-rs/google_cloudsearch1/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses are valid. -Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google-cloudsearch1/trait.Part.html) which are identifiable by name, which will be sent to +Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google_cloudsearch1/trait.Part.html) 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](http://byron.github.io/google-apis-rs/google-cloudsearch1/trait.CallBuilder.html), you are able to prepare an action call by repeatedly calling it's methods. +Using [method builders](http://byron.github.io/google-apis-rs/google_cloudsearch1/trait.CallBuilder.html), 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][wiki-pod] are handed by copy * strings are passed as `&str` -* [request values](http://byron.github.io/google-apis-rs/google-cloudsearch1/trait.RequestValue.html) are borrowed +* [request values](http://byron.github.io/google-apis-rs/google_cloudsearch1/trait.RequestValue.html) are borrowed Arguments will always be copied or cloned into the builder, to make them independent of their original life times. diff --git a/gen/compute1/README.md b/gen/compute1/README.md index f128643c02..c9f0e4f463 100644 --- a/gen/compute1/README.md +++ b/gen/compute1/README.md @@ -11,66 +11,66 @@ Everything else about the *compute* *v1* API can be found at the [official documentation site](https://developers.google.com/compute/docs/reference/latest/). # Features -Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google-compute1/struct.Compute.html) ... +Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google_compute1/struct.Compute.html) ... * addresses - * [*aggregated list*](http://byron.github.io/google-apis-rs/google-compute1/struct.AddresseAggregatedListCall.html), [*delete*](http://byron.github.io/google-apis-rs/google-compute1/struct.AddresseDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google-compute1/struct.AddresseGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google-compute1/struct.AddresseInsertCall.html) and [*list*](http://byron.github.io/google-apis-rs/google-compute1/struct.AddresseListCall.html) -* [backend services](http://byron.github.io/google-apis-rs/google-compute1/struct.BackendService.html) - * [*delete*](http://byron.github.io/google-apis-rs/google-compute1/struct.BackendServiceDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google-compute1/struct.BackendServiceGetCall.html), [*get health*](http://byron.github.io/google-apis-rs/google-compute1/struct.BackendServiceGetHealthCall.html), [*insert*](http://byron.github.io/google-apis-rs/google-compute1/struct.BackendServiceInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google-compute1/struct.BackendServiceListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google-compute1/struct.BackendServicePatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google-compute1/struct.BackendServiceUpdateCall.html) -* [disk types](http://byron.github.io/google-apis-rs/google-compute1/struct.DiskType.html) - * [*aggregated list*](http://byron.github.io/google-apis-rs/google-compute1/struct.DiskTypeAggregatedListCall.html), [*get*](http://byron.github.io/google-apis-rs/google-compute1/struct.DiskTypeGetCall.html) and [*list*](http://byron.github.io/google-apis-rs/google-compute1/struct.DiskTypeListCall.html) -* [disks](http://byron.github.io/google-apis-rs/google-compute1/struct.Disk.html) - * [*aggregated list*](http://byron.github.io/google-apis-rs/google-compute1/struct.DiskAggregatedListCall.html), [*create snapshot*](http://byron.github.io/google-apis-rs/google-compute1/struct.DiskCreateSnapshotCall.html), [*delete*](http://byron.github.io/google-apis-rs/google-compute1/struct.DiskDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google-compute1/struct.DiskGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google-compute1/struct.DiskInsertCall.html) and [*list*](http://byron.github.io/google-apis-rs/google-compute1/struct.DiskListCall.html) -* [firewalls](http://byron.github.io/google-apis-rs/google-compute1/struct.Firewall.html) - * [*delete*](http://byron.github.io/google-apis-rs/google-compute1/struct.FirewallDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google-compute1/struct.FirewallGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google-compute1/struct.FirewallInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google-compute1/struct.FirewallListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google-compute1/struct.FirewallPatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google-compute1/struct.FirewallUpdateCall.html) -* [forwarding rules](http://byron.github.io/google-apis-rs/google-compute1/struct.ForwardingRule.html) - * [*aggregated list*](http://byron.github.io/google-apis-rs/google-compute1/struct.ForwardingRuleAggregatedListCall.html), [*delete*](http://byron.github.io/google-apis-rs/google-compute1/struct.ForwardingRuleDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google-compute1/struct.ForwardingRuleGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google-compute1/struct.ForwardingRuleInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google-compute1/struct.ForwardingRuleListCall.html) and [*set target*](http://byron.github.io/google-apis-rs/google-compute1/struct.ForwardingRuleSetTargetCall.html) + * [*aggregated list*](http://byron.github.io/google-apis-rs/google_compute1/struct.AddresseAggregatedListCall.html), [*delete*](http://byron.github.io/google-apis-rs/google_compute1/struct.AddresseDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google_compute1/struct.AddresseGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google_compute1/struct.AddresseInsertCall.html) and [*list*](http://byron.github.io/google-apis-rs/google_compute1/struct.AddresseListCall.html) +* [backend services](http://byron.github.io/google-apis-rs/google_compute1/struct.BackendService.html) + * [*delete*](http://byron.github.io/google-apis-rs/google_compute1/struct.BackendServiceDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google_compute1/struct.BackendServiceGetCall.html), [*get health*](http://byron.github.io/google-apis-rs/google_compute1/struct.BackendServiceGetHealthCall.html), [*insert*](http://byron.github.io/google-apis-rs/google_compute1/struct.BackendServiceInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google_compute1/struct.BackendServiceListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google_compute1/struct.BackendServicePatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google_compute1/struct.BackendServiceUpdateCall.html) +* [disk types](http://byron.github.io/google-apis-rs/google_compute1/struct.DiskType.html) + * [*aggregated list*](http://byron.github.io/google-apis-rs/google_compute1/struct.DiskTypeAggregatedListCall.html), [*get*](http://byron.github.io/google-apis-rs/google_compute1/struct.DiskTypeGetCall.html) and [*list*](http://byron.github.io/google-apis-rs/google_compute1/struct.DiskTypeListCall.html) +* [disks](http://byron.github.io/google-apis-rs/google_compute1/struct.Disk.html) + * [*aggregated list*](http://byron.github.io/google-apis-rs/google_compute1/struct.DiskAggregatedListCall.html), [*create snapshot*](http://byron.github.io/google-apis-rs/google_compute1/struct.DiskCreateSnapshotCall.html), [*delete*](http://byron.github.io/google-apis-rs/google_compute1/struct.DiskDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google_compute1/struct.DiskGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google_compute1/struct.DiskInsertCall.html) and [*list*](http://byron.github.io/google-apis-rs/google_compute1/struct.DiskListCall.html) +* [firewalls](http://byron.github.io/google-apis-rs/google_compute1/struct.Firewall.html) + * [*delete*](http://byron.github.io/google-apis-rs/google_compute1/struct.FirewallDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google_compute1/struct.FirewallGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google_compute1/struct.FirewallInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google_compute1/struct.FirewallListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google_compute1/struct.FirewallPatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google_compute1/struct.FirewallUpdateCall.html) +* [forwarding rules](http://byron.github.io/google-apis-rs/google_compute1/struct.ForwardingRule.html) + * [*aggregated list*](http://byron.github.io/google-apis-rs/google_compute1/struct.ForwardingRuleAggregatedListCall.html), [*delete*](http://byron.github.io/google-apis-rs/google_compute1/struct.ForwardingRuleDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google_compute1/struct.ForwardingRuleGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google_compute1/struct.ForwardingRuleInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google_compute1/struct.ForwardingRuleListCall.html) and [*set target*](http://byron.github.io/google-apis-rs/google_compute1/struct.ForwardingRuleSetTargetCall.html) * global addresses - * [*delete*](http://byron.github.io/google-apis-rs/google-compute1/struct.GlobalAddresseDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google-compute1/struct.GlobalAddresseGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google-compute1/struct.GlobalAddresseInsertCall.html) and [*list*](http://byron.github.io/google-apis-rs/google-compute1/struct.GlobalAddresseListCall.html) + * [*delete*](http://byron.github.io/google-apis-rs/google_compute1/struct.GlobalAddresseDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google_compute1/struct.GlobalAddresseGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google_compute1/struct.GlobalAddresseInsertCall.html) and [*list*](http://byron.github.io/google-apis-rs/google_compute1/struct.GlobalAddresseListCall.html) * global forwarding rules - * [*delete*](http://byron.github.io/google-apis-rs/google-compute1/struct.GlobalForwardingRuleDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google-compute1/struct.GlobalForwardingRuleGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google-compute1/struct.GlobalForwardingRuleInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google-compute1/struct.GlobalForwardingRuleListCall.html) and [*set target*](http://byron.github.io/google-apis-rs/google-compute1/struct.GlobalForwardingRuleSetTargetCall.html) + * [*delete*](http://byron.github.io/google-apis-rs/google_compute1/struct.GlobalForwardingRuleDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google_compute1/struct.GlobalForwardingRuleGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google_compute1/struct.GlobalForwardingRuleInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google_compute1/struct.GlobalForwardingRuleListCall.html) and [*set target*](http://byron.github.io/google-apis-rs/google_compute1/struct.GlobalForwardingRuleSetTargetCall.html) * global operations - * [*aggregated list*](http://byron.github.io/google-apis-rs/google-compute1/struct.GlobalOperationAggregatedListCall.html), [*delete*](http://byron.github.io/google-apis-rs/google-compute1/struct.GlobalOperationDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google-compute1/struct.GlobalOperationGetCall.html) and [*list*](http://byron.github.io/google-apis-rs/google-compute1/struct.GlobalOperationListCall.html) -* [http health checks](http://byron.github.io/google-apis-rs/google-compute1/struct.HttpHealthCheck.html) - * [*delete*](http://byron.github.io/google-apis-rs/google-compute1/struct.HttpHealthCheckDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google-compute1/struct.HttpHealthCheckGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google-compute1/struct.HttpHealthCheckInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google-compute1/struct.HttpHealthCheckListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google-compute1/struct.HttpHealthCheckPatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google-compute1/struct.HttpHealthCheckUpdateCall.html) -* [images](http://byron.github.io/google-apis-rs/google-compute1/struct.Image.html) - * [*delete*](http://byron.github.io/google-apis-rs/google-compute1/struct.ImageDeleteCall.html), [*deprecate*](http://byron.github.io/google-apis-rs/google-compute1/struct.ImageDeprecateCall.html), [*get*](http://byron.github.io/google-apis-rs/google-compute1/struct.ImageGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google-compute1/struct.ImageInsertCall.html) and [*list*](http://byron.github.io/google-apis-rs/google-compute1/struct.ImageListCall.html) -* [instance templates](http://byron.github.io/google-apis-rs/google-compute1/struct.InstanceTemplate.html) - * [*delete*](http://byron.github.io/google-apis-rs/google-compute1/struct.InstanceTemplateDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google-compute1/struct.InstanceTemplateGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google-compute1/struct.InstanceTemplateInsertCall.html) and [*list*](http://byron.github.io/google-apis-rs/google-compute1/struct.InstanceTemplateListCall.html) -* [instances](http://byron.github.io/google-apis-rs/google-compute1/struct.Instance.html) - * [*add access config*](http://byron.github.io/google-apis-rs/google-compute1/struct.InstanceAddAccessConfigCall.html), [*aggregated list*](http://byron.github.io/google-apis-rs/google-compute1/struct.InstanceAggregatedListCall.html), [*attach disk*](http://byron.github.io/google-apis-rs/google-compute1/struct.InstanceAttachDiskCall.html), [*delete*](http://byron.github.io/google-apis-rs/google-compute1/struct.InstanceDeleteCall.html), [*delete access config*](http://byron.github.io/google-apis-rs/google-compute1/struct.InstanceDeleteAccessConfigCall.html), [*detach disk*](http://byron.github.io/google-apis-rs/google-compute1/struct.InstanceDetachDiskCall.html), [*get*](http://byron.github.io/google-apis-rs/google-compute1/struct.InstanceGetCall.html), [*get serial port output*](http://byron.github.io/google-apis-rs/google-compute1/struct.InstanceGetSerialPortOutputCall.html), [*insert*](http://byron.github.io/google-apis-rs/google-compute1/struct.InstanceInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google-compute1/struct.InstanceListCall.html), [*reset*](http://byron.github.io/google-apis-rs/google-compute1/struct.InstanceResetCall.html), [*set disk auto delete*](http://byron.github.io/google-apis-rs/google-compute1/struct.InstanceSetDiskAutoDeleteCall.html), [*set metadata*](http://byron.github.io/google-apis-rs/google-compute1/struct.InstanceSetMetadataCall.html), [*set scheduling*](http://byron.github.io/google-apis-rs/google-compute1/struct.InstanceSetSchedulingCall.html), [*set tags*](http://byron.github.io/google-apis-rs/google-compute1/struct.InstanceSetTagCall.html), [*start*](http://byron.github.io/google-apis-rs/google-compute1/struct.InstanceStartCall.html) and [*stop*](http://byron.github.io/google-apis-rs/google-compute1/struct.InstanceStopCall.html) -* [licenses](http://byron.github.io/google-apis-rs/google-compute1/struct.License.html) - * [*get*](http://byron.github.io/google-apis-rs/google-compute1/struct.LicenseGetCall.html) -* [machine types](http://byron.github.io/google-apis-rs/google-compute1/struct.MachineType.html) - * [*aggregated list*](http://byron.github.io/google-apis-rs/google-compute1/struct.MachineTypeAggregatedListCall.html), [*get*](http://byron.github.io/google-apis-rs/google-compute1/struct.MachineTypeGetCall.html) and [*list*](http://byron.github.io/google-apis-rs/google-compute1/struct.MachineTypeListCall.html) -* [networks](http://byron.github.io/google-apis-rs/google-compute1/struct.Network.html) - * [*delete*](http://byron.github.io/google-apis-rs/google-compute1/struct.NetworkDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google-compute1/struct.NetworkGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google-compute1/struct.NetworkInsertCall.html) and [*list*](http://byron.github.io/google-apis-rs/google-compute1/struct.NetworkListCall.html) -* [projects](http://byron.github.io/google-apis-rs/google-compute1/struct.Project.html) - * [*get*](http://byron.github.io/google-apis-rs/google-compute1/struct.ProjectGetCall.html), [*move disk*](http://byron.github.io/google-apis-rs/google-compute1/struct.ProjectMoveDiskCall.html), [*move instance*](http://byron.github.io/google-apis-rs/google-compute1/struct.ProjectMoveInstanceCall.html), [*set common instance metadata*](http://byron.github.io/google-apis-rs/google-compute1/struct.ProjectSetCommonInstanceMetadataCall.html) and [*set usage export bucket*](http://byron.github.io/google-apis-rs/google-compute1/struct.ProjectSetUsageExportBucketCall.html) + * [*aggregated list*](http://byron.github.io/google-apis-rs/google_compute1/struct.GlobalOperationAggregatedListCall.html), [*delete*](http://byron.github.io/google-apis-rs/google_compute1/struct.GlobalOperationDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google_compute1/struct.GlobalOperationGetCall.html) and [*list*](http://byron.github.io/google-apis-rs/google_compute1/struct.GlobalOperationListCall.html) +* [http health checks](http://byron.github.io/google-apis-rs/google_compute1/struct.HttpHealthCheck.html) + * [*delete*](http://byron.github.io/google-apis-rs/google_compute1/struct.HttpHealthCheckDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google_compute1/struct.HttpHealthCheckGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google_compute1/struct.HttpHealthCheckInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google_compute1/struct.HttpHealthCheckListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google_compute1/struct.HttpHealthCheckPatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google_compute1/struct.HttpHealthCheckUpdateCall.html) +* [images](http://byron.github.io/google-apis-rs/google_compute1/struct.Image.html) + * [*delete*](http://byron.github.io/google-apis-rs/google_compute1/struct.ImageDeleteCall.html), [*deprecate*](http://byron.github.io/google-apis-rs/google_compute1/struct.ImageDeprecateCall.html), [*get*](http://byron.github.io/google-apis-rs/google_compute1/struct.ImageGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google_compute1/struct.ImageInsertCall.html) and [*list*](http://byron.github.io/google-apis-rs/google_compute1/struct.ImageListCall.html) +* [instance templates](http://byron.github.io/google-apis-rs/google_compute1/struct.InstanceTemplate.html) + * [*delete*](http://byron.github.io/google-apis-rs/google_compute1/struct.InstanceTemplateDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google_compute1/struct.InstanceTemplateGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google_compute1/struct.InstanceTemplateInsertCall.html) and [*list*](http://byron.github.io/google-apis-rs/google_compute1/struct.InstanceTemplateListCall.html) +* [instances](http://byron.github.io/google-apis-rs/google_compute1/struct.Instance.html) + * [*add access config*](http://byron.github.io/google-apis-rs/google_compute1/struct.InstanceAddAccessConfigCall.html), [*aggregated list*](http://byron.github.io/google-apis-rs/google_compute1/struct.InstanceAggregatedListCall.html), [*attach disk*](http://byron.github.io/google-apis-rs/google_compute1/struct.InstanceAttachDiskCall.html), [*delete*](http://byron.github.io/google-apis-rs/google_compute1/struct.InstanceDeleteCall.html), [*delete access config*](http://byron.github.io/google-apis-rs/google_compute1/struct.InstanceDeleteAccessConfigCall.html), [*detach disk*](http://byron.github.io/google-apis-rs/google_compute1/struct.InstanceDetachDiskCall.html), [*get*](http://byron.github.io/google-apis-rs/google_compute1/struct.InstanceGetCall.html), [*get serial port output*](http://byron.github.io/google-apis-rs/google_compute1/struct.InstanceGetSerialPortOutputCall.html), [*insert*](http://byron.github.io/google-apis-rs/google_compute1/struct.InstanceInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google_compute1/struct.InstanceListCall.html), [*reset*](http://byron.github.io/google-apis-rs/google_compute1/struct.InstanceResetCall.html), [*set disk auto delete*](http://byron.github.io/google-apis-rs/google_compute1/struct.InstanceSetDiskAutoDeleteCall.html), [*set metadata*](http://byron.github.io/google-apis-rs/google_compute1/struct.InstanceSetMetadataCall.html), [*set scheduling*](http://byron.github.io/google-apis-rs/google_compute1/struct.InstanceSetSchedulingCall.html), [*set tags*](http://byron.github.io/google-apis-rs/google_compute1/struct.InstanceSetTagCall.html), [*start*](http://byron.github.io/google-apis-rs/google_compute1/struct.InstanceStartCall.html) and [*stop*](http://byron.github.io/google-apis-rs/google_compute1/struct.InstanceStopCall.html) +* [licenses](http://byron.github.io/google-apis-rs/google_compute1/struct.License.html) + * [*get*](http://byron.github.io/google-apis-rs/google_compute1/struct.LicenseGetCall.html) +* [machine types](http://byron.github.io/google-apis-rs/google_compute1/struct.MachineType.html) + * [*aggregated list*](http://byron.github.io/google-apis-rs/google_compute1/struct.MachineTypeAggregatedListCall.html), [*get*](http://byron.github.io/google-apis-rs/google_compute1/struct.MachineTypeGetCall.html) and [*list*](http://byron.github.io/google-apis-rs/google_compute1/struct.MachineTypeListCall.html) +* [networks](http://byron.github.io/google-apis-rs/google_compute1/struct.Network.html) + * [*delete*](http://byron.github.io/google-apis-rs/google_compute1/struct.NetworkDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google_compute1/struct.NetworkGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google_compute1/struct.NetworkInsertCall.html) and [*list*](http://byron.github.io/google-apis-rs/google_compute1/struct.NetworkListCall.html) +* [projects](http://byron.github.io/google-apis-rs/google_compute1/struct.Project.html) + * [*get*](http://byron.github.io/google-apis-rs/google_compute1/struct.ProjectGetCall.html), [*move disk*](http://byron.github.io/google-apis-rs/google_compute1/struct.ProjectMoveDiskCall.html), [*move instance*](http://byron.github.io/google-apis-rs/google_compute1/struct.ProjectMoveInstanceCall.html), [*set common instance metadata*](http://byron.github.io/google-apis-rs/google_compute1/struct.ProjectSetCommonInstanceMetadataCall.html) and [*set usage export bucket*](http://byron.github.io/google-apis-rs/google_compute1/struct.ProjectSetUsageExportBucketCall.html) * region operations - * [*delete*](http://byron.github.io/google-apis-rs/google-compute1/struct.RegionOperationDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google-compute1/struct.RegionOperationGetCall.html) and [*list*](http://byron.github.io/google-apis-rs/google-compute1/struct.RegionOperationListCall.html) -* [regions](http://byron.github.io/google-apis-rs/google-compute1/struct.Region.html) - * [*get*](http://byron.github.io/google-apis-rs/google-compute1/struct.RegionGetCall.html) and [*list*](http://byron.github.io/google-apis-rs/google-compute1/struct.RegionListCall.html) -* [routes](http://byron.github.io/google-apis-rs/google-compute1/struct.Route.html) - * [*delete*](http://byron.github.io/google-apis-rs/google-compute1/struct.RouteDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google-compute1/struct.RouteGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google-compute1/struct.RouteInsertCall.html) and [*list*](http://byron.github.io/google-apis-rs/google-compute1/struct.RouteListCall.html) -* [snapshots](http://byron.github.io/google-apis-rs/google-compute1/struct.Snapshot.html) - * [*delete*](http://byron.github.io/google-apis-rs/google-compute1/struct.SnapshotDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google-compute1/struct.SnapshotGetCall.html) and [*list*](http://byron.github.io/google-apis-rs/google-compute1/struct.SnapshotListCall.html) -* [target http proxies](http://byron.github.io/google-apis-rs/google-compute1/struct.TargetHttpProxy.html) - * [*delete*](http://byron.github.io/google-apis-rs/google-compute1/struct.TargetHttpProxyDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google-compute1/struct.TargetHttpProxyGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google-compute1/struct.TargetHttpProxyInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google-compute1/struct.TargetHttpProxyListCall.html) and [*set url map*](http://byron.github.io/google-apis-rs/google-compute1/struct.TargetHttpProxySetUrlMapCall.html) -* [target instances](http://byron.github.io/google-apis-rs/google-compute1/struct.TargetInstance.html) - * [*aggregated list*](http://byron.github.io/google-apis-rs/google-compute1/struct.TargetInstanceAggregatedListCall.html), [*delete*](http://byron.github.io/google-apis-rs/google-compute1/struct.TargetInstanceDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google-compute1/struct.TargetInstanceGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google-compute1/struct.TargetInstanceInsertCall.html) and [*list*](http://byron.github.io/google-apis-rs/google-compute1/struct.TargetInstanceListCall.html) -* [target pools](http://byron.github.io/google-apis-rs/google-compute1/struct.TargetPool.html) - * [*add health check*](http://byron.github.io/google-apis-rs/google-compute1/struct.TargetPoolAddHealthCheckCall.html), [*add instance*](http://byron.github.io/google-apis-rs/google-compute1/struct.TargetPoolAddInstanceCall.html), [*aggregated list*](http://byron.github.io/google-apis-rs/google-compute1/struct.TargetPoolAggregatedListCall.html), [*delete*](http://byron.github.io/google-apis-rs/google-compute1/struct.TargetPoolDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google-compute1/struct.TargetPoolGetCall.html), [*get health*](http://byron.github.io/google-apis-rs/google-compute1/struct.TargetPoolGetHealthCall.html), [*insert*](http://byron.github.io/google-apis-rs/google-compute1/struct.TargetPoolInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google-compute1/struct.TargetPoolListCall.html), [*remove health check*](http://byron.github.io/google-apis-rs/google-compute1/struct.TargetPoolRemoveHealthCheckCall.html), [*remove instance*](http://byron.github.io/google-apis-rs/google-compute1/struct.TargetPoolRemoveInstanceCall.html) and [*set backup*](http://byron.github.io/google-apis-rs/google-compute1/struct.TargetPoolSetBackupCall.html) -* [target vpn gateways](http://byron.github.io/google-apis-rs/google-compute1/struct.TargetVpnGateway.html) - * [*aggregated list*](http://byron.github.io/google-apis-rs/google-compute1/struct.TargetVpnGatewayAggregatedListCall.html), [*delete*](http://byron.github.io/google-apis-rs/google-compute1/struct.TargetVpnGatewayDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google-compute1/struct.TargetVpnGatewayGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google-compute1/struct.TargetVpnGatewayInsertCall.html) and [*list*](http://byron.github.io/google-apis-rs/google-compute1/struct.TargetVpnGatewayListCall.html) -* [url maps](http://byron.github.io/google-apis-rs/google-compute1/struct.UrlMap.html) - * [*delete*](http://byron.github.io/google-apis-rs/google-compute1/struct.UrlMapDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google-compute1/struct.UrlMapGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google-compute1/struct.UrlMapInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google-compute1/struct.UrlMapListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google-compute1/struct.UrlMapPatchCall.html), [*update*](http://byron.github.io/google-apis-rs/google-compute1/struct.UrlMapUpdateCall.html) and [*validate*](http://byron.github.io/google-apis-rs/google-compute1/struct.UrlMapValidateCall.html) -* [vpn tunnels](http://byron.github.io/google-apis-rs/google-compute1/struct.VpnTunnel.html) - * [*aggregated list*](http://byron.github.io/google-apis-rs/google-compute1/struct.VpnTunnelAggregatedListCall.html), [*delete*](http://byron.github.io/google-apis-rs/google-compute1/struct.VpnTunnelDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google-compute1/struct.VpnTunnelGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google-compute1/struct.VpnTunnelInsertCall.html) and [*list*](http://byron.github.io/google-apis-rs/google-compute1/struct.VpnTunnelListCall.html) + * [*delete*](http://byron.github.io/google-apis-rs/google_compute1/struct.RegionOperationDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google_compute1/struct.RegionOperationGetCall.html) and [*list*](http://byron.github.io/google-apis-rs/google_compute1/struct.RegionOperationListCall.html) +* [regions](http://byron.github.io/google-apis-rs/google_compute1/struct.Region.html) + * [*get*](http://byron.github.io/google-apis-rs/google_compute1/struct.RegionGetCall.html) and [*list*](http://byron.github.io/google-apis-rs/google_compute1/struct.RegionListCall.html) +* [routes](http://byron.github.io/google-apis-rs/google_compute1/struct.Route.html) + * [*delete*](http://byron.github.io/google-apis-rs/google_compute1/struct.RouteDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google_compute1/struct.RouteGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google_compute1/struct.RouteInsertCall.html) and [*list*](http://byron.github.io/google-apis-rs/google_compute1/struct.RouteListCall.html) +* [snapshots](http://byron.github.io/google-apis-rs/google_compute1/struct.Snapshot.html) + * [*delete*](http://byron.github.io/google-apis-rs/google_compute1/struct.SnapshotDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google_compute1/struct.SnapshotGetCall.html) and [*list*](http://byron.github.io/google-apis-rs/google_compute1/struct.SnapshotListCall.html) +* [target http proxies](http://byron.github.io/google-apis-rs/google_compute1/struct.TargetHttpProxy.html) + * [*delete*](http://byron.github.io/google-apis-rs/google_compute1/struct.TargetHttpProxyDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google_compute1/struct.TargetHttpProxyGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google_compute1/struct.TargetHttpProxyInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google_compute1/struct.TargetHttpProxyListCall.html) and [*set url map*](http://byron.github.io/google-apis-rs/google_compute1/struct.TargetHttpProxySetUrlMapCall.html) +* [target instances](http://byron.github.io/google-apis-rs/google_compute1/struct.TargetInstance.html) + * [*aggregated list*](http://byron.github.io/google-apis-rs/google_compute1/struct.TargetInstanceAggregatedListCall.html), [*delete*](http://byron.github.io/google-apis-rs/google_compute1/struct.TargetInstanceDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google_compute1/struct.TargetInstanceGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google_compute1/struct.TargetInstanceInsertCall.html) and [*list*](http://byron.github.io/google-apis-rs/google_compute1/struct.TargetInstanceListCall.html) +* [target pools](http://byron.github.io/google-apis-rs/google_compute1/struct.TargetPool.html) + * [*add health check*](http://byron.github.io/google-apis-rs/google_compute1/struct.TargetPoolAddHealthCheckCall.html), [*add instance*](http://byron.github.io/google-apis-rs/google_compute1/struct.TargetPoolAddInstanceCall.html), [*aggregated list*](http://byron.github.io/google-apis-rs/google_compute1/struct.TargetPoolAggregatedListCall.html), [*delete*](http://byron.github.io/google-apis-rs/google_compute1/struct.TargetPoolDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google_compute1/struct.TargetPoolGetCall.html), [*get health*](http://byron.github.io/google-apis-rs/google_compute1/struct.TargetPoolGetHealthCall.html), [*insert*](http://byron.github.io/google-apis-rs/google_compute1/struct.TargetPoolInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google_compute1/struct.TargetPoolListCall.html), [*remove health check*](http://byron.github.io/google-apis-rs/google_compute1/struct.TargetPoolRemoveHealthCheckCall.html), [*remove instance*](http://byron.github.io/google-apis-rs/google_compute1/struct.TargetPoolRemoveInstanceCall.html) and [*set backup*](http://byron.github.io/google-apis-rs/google_compute1/struct.TargetPoolSetBackupCall.html) +* [target vpn gateways](http://byron.github.io/google-apis-rs/google_compute1/struct.TargetVpnGateway.html) + * [*aggregated list*](http://byron.github.io/google-apis-rs/google_compute1/struct.TargetVpnGatewayAggregatedListCall.html), [*delete*](http://byron.github.io/google-apis-rs/google_compute1/struct.TargetVpnGatewayDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google_compute1/struct.TargetVpnGatewayGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google_compute1/struct.TargetVpnGatewayInsertCall.html) and [*list*](http://byron.github.io/google-apis-rs/google_compute1/struct.TargetVpnGatewayListCall.html) +* [url maps](http://byron.github.io/google-apis-rs/google_compute1/struct.UrlMap.html) + * [*delete*](http://byron.github.io/google-apis-rs/google_compute1/struct.UrlMapDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google_compute1/struct.UrlMapGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google_compute1/struct.UrlMapInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google_compute1/struct.UrlMapListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google_compute1/struct.UrlMapPatchCall.html), [*update*](http://byron.github.io/google-apis-rs/google_compute1/struct.UrlMapUpdateCall.html) and [*validate*](http://byron.github.io/google-apis-rs/google_compute1/struct.UrlMapValidateCall.html) +* [vpn tunnels](http://byron.github.io/google-apis-rs/google_compute1/struct.VpnTunnel.html) + * [*aggregated list*](http://byron.github.io/google-apis-rs/google_compute1/struct.VpnTunnelAggregatedListCall.html), [*delete*](http://byron.github.io/google-apis-rs/google_compute1/struct.VpnTunnelDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google_compute1/struct.VpnTunnelGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google_compute1/struct.VpnTunnelInsertCall.html) and [*list*](http://byron.github.io/google-apis-rs/google_compute1/struct.VpnTunnelListCall.html) * zone operations - * [*delete*](http://byron.github.io/google-apis-rs/google-compute1/struct.ZoneOperationDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google-compute1/struct.ZoneOperationGetCall.html) and [*list*](http://byron.github.io/google-apis-rs/google-compute1/struct.ZoneOperationListCall.html) -* [zones](http://byron.github.io/google-apis-rs/google-compute1/struct.Zone.html) - * [*get*](http://byron.github.io/google-apis-rs/google-compute1/struct.ZoneGetCall.html) and [*list*](http://byron.github.io/google-apis-rs/google-compute1/struct.ZoneListCall.html) + * [*delete*](http://byron.github.io/google-apis-rs/google_compute1/struct.ZoneOperationDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google_compute1/struct.ZoneOperationGetCall.html) and [*list*](http://byron.github.io/google-apis-rs/google_compute1/struct.ZoneOperationListCall.html) +* [zones](http://byron.github.io/google-apis-rs/google_compute1/struct.Zone.html) + * [*get*](http://byron.github.io/google-apis-rs/google_compute1/struct.ZoneGetCall.html) and [*list*](http://byron.github.io/google-apis-rs/google_compute1/struct.ZoneListCall.html) @@ -79,17 +79,17 @@ Handle the following *Resources* with ease from the central [hub](http://byron.g The API is structured into the following primary items: -* **[Hub](http://byron.github.io/google-apis-rs/google-compute1/struct.Compute.html)** +* **[Hub](http://byron.github.io/google-apis-rs/google_compute1/struct.Compute.html)** * a central object to maintain state and allow accessing all *Activities* - * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google-compute1/trait.MethodsBuilder.html) which in turn - allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google-compute1/trait.CallBuilder.html) -* **[Resources](http://byron.github.io/google-apis-rs/google-compute1/trait.Resource.html)** + * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google_compute1/trait.MethodsBuilder.html) which in turn + allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google_compute1/trait.CallBuilder.html) +* **[Resources](http://byron.github.io/google-apis-rs/google_compute1/trait.Resource.html)** * primary types that you can apply *Activities* to * a collection of properties and *Parts* - * **[Parts](http://byron.github.io/google-apis-rs/google-compute1/trait.Part.html)** + * **[Parts](http://byron.github.io/google-apis-rs/google_compute1/trait.Part.html)** * a collection of properties * never directly used in *Activities* -* **[Activities](http://byron.github.io/google-apis-rs/google-compute1/trait.CallBuilder.html)** +* **[Activities](http://byron.github.io/google-apis-rs/google_compute1/trait.CallBuilder.html)** * operations to apply to *Resources* All *structures* are marked with applicable traits to further categorize them and ease browsing. @@ -242,17 +242,17 @@ match result { ``` ## Handling Errors -All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google-compute1/enum.Result.html) enumeration as return value of +All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google_compute1/enum.Result.html) enumeration as return value of the doit() methods, or handed as possibly intermediate results to either the -[Hub Delegate](http://byron.github.io/google-apis-rs/google-compute1/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google-compute1/../yup-oauth2/trait.AuthenticatorDelegate.html). +[Hub Delegate](http://byron.github.io/google-apis-rs/google_compute1/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google_compute1/../yup-oauth2/trait.AuthenticatorDelegate.html). 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](http://byron.github.io/google-apis-rs/google-compute1/enum.Result.html), should be +If a method supports downloads, the response body, which is part of the [Result](http://byron.github.io/google-apis-rs/google_compute1/enum.Result.html), should be read by you to obtain the media. -If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google-compute1/trait.ResponseResult.html), it will return that by default. +If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google_compute1/trait.ResponseResult.html), 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")`. @@ -262,29 +262,29 @@ Methods supporting uploads can do so using up to 2 different protocols: ## Customization and Callbacks -You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google-compute1/trait.Delegate.html) to the -[Method Builder](http://byron.github.io/google-apis-rs/google-compute1/trait.CallBuilder.html) before making the final `doit()` call. +You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google_compute1/trait.Delegate.html) to the +[Method Builder](http://byron.github.io/google-apis-rs/google_compute1/trait.CallBuilder.html) 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](http://byron.github.io/google-apis-rs/google-compute1/trait.Delegate.html) is default-implemented, allowing you to customize it with minimal effort. +The [delegate trait](http://byron.github.io/google-apis-rs/google_compute1/trait.Delegate.html) 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](http://byron.github.io/google-apis-rs/google-compute1/trait.RequestValue.html) and -[decodable](http://byron.github.io/google-apis-rs/google-compute1/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses +All structures provided by this library are made to be [enocodable](http://byron.github.io/google-apis-rs/google_compute1/trait.RequestValue.html) and +[decodable](http://byron.github.io/google-apis-rs/google_compute1/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses are valid. -Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google-compute1/trait.Part.html) which are identifiable by name, which will be sent to +Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google_compute1/trait.Part.html) 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](http://byron.github.io/google-apis-rs/google-compute1/trait.CallBuilder.html), you are able to prepare an action call by repeatedly calling it's methods. +Using [method builders](http://byron.github.io/google-apis-rs/google_compute1/trait.CallBuilder.html), 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][wiki-pod] are handed by copy * strings are passed as `&str` -* [request values](http://byron.github.io/google-apis-rs/google-compute1/trait.RequestValue.html) are borrowed +* [request values](http://byron.github.io/google-apis-rs/google_compute1/trait.RequestValue.html) are borrowed Arguments will always be copied or cloned into the builder, to make them independent of their original life times. diff --git a/gen/container1_beta1/README.md b/gen/container1_beta1/README.md index 9b205b8d4f..b98f4f8e18 100644 --- a/gen/container1_beta1/README.md +++ b/gen/container1_beta1/README.md @@ -11,10 +11,10 @@ Everything else about the *container* *v1_beta1* API can be found at the [official documentation site](https://cloud.google.com/container-engine/docs/v1beta1/). # Features -Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google-container1_beta1/struct.Container.html) ... +Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google_container1_beta1/struct.Container.html) ... * projects - * [*clusters list*](http://byron.github.io/google-apis-rs/google-container1_beta1/struct.ProjectClusterListCall.html), [*operations list*](http://byron.github.io/google-apis-rs/google-container1_beta1/struct.ProjectOperationListCall.html), [*zones clusters create*](http://byron.github.io/google-apis-rs/google-container1_beta1/struct.ProjectZoneClusterCreateCall.html), [*zones clusters delete*](http://byron.github.io/google-apis-rs/google-container1_beta1/struct.ProjectZoneClusterDeleteCall.html), [*zones clusters get*](http://byron.github.io/google-apis-rs/google-container1_beta1/struct.ProjectZoneClusterGetCall.html), [*zones clusters list*](http://byron.github.io/google-apis-rs/google-container1_beta1/struct.ProjectZoneClusterListCall.html), [*zones operations get*](http://byron.github.io/google-apis-rs/google-container1_beta1/struct.ProjectZoneOperationGetCall.html) and [*zones operations list*](http://byron.github.io/google-apis-rs/google-container1_beta1/struct.ProjectZoneOperationListCall.html) + * [*clusters list*](http://byron.github.io/google-apis-rs/google_container1_beta1/struct.ProjectClusterListCall.html), [*operations list*](http://byron.github.io/google-apis-rs/google_container1_beta1/struct.ProjectOperationListCall.html), [*zones clusters create*](http://byron.github.io/google-apis-rs/google_container1_beta1/struct.ProjectZoneClusterCreateCall.html), [*zones clusters delete*](http://byron.github.io/google-apis-rs/google_container1_beta1/struct.ProjectZoneClusterDeleteCall.html), [*zones clusters get*](http://byron.github.io/google-apis-rs/google_container1_beta1/struct.ProjectZoneClusterGetCall.html), [*zones clusters list*](http://byron.github.io/google-apis-rs/google_container1_beta1/struct.ProjectZoneClusterListCall.html), [*zones operations get*](http://byron.github.io/google-apis-rs/google_container1_beta1/struct.ProjectZoneOperationGetCall.html) and [*zones operations list*](http://byron.github.io/google-apis-rs/google_container1_beta1/struct.ProjectZoneOperationListCall.html) @@ -23,17 +23,17 @@ Handle the following *Resources* with ease from the central [hub](http://byron.g The API is structured into the following primary items: -* **[Hub](http://byron.github.io/google-apis-rs/google-container1_beta1/struct.Container.html)** +* **[Hub](http://byron.github.io/google-apis-rs/google_container1_beta1/struct.Container.html)** * a central object to maintain state and allow accessing all *Activities* - * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google-container1_beta1/trait.MethodsBuilder.html) which in turn - allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google-container1_beta1/trait.CallBuilder.html) -* **[Resources](http://byron.github.io/google-apis-rs/google-container1_beta1/trait.Resource.html)** + * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google_container1_beta1/trait.MethodsBuilder.html) which in turn + allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google_container1_beta1/trait.CallBuilder.html) +* **[Resources](http://byron.github.io/google-apis-rs/google_container1_beta1/trait.Resource.html)** * primary types that you can apply *Activities* to * a collection of properties and *Parts* - * **[Parts](http://byron.github.io/google-apis-rs/google-container1_beta1/trait.Part.html)** + * **[Parts](http://byron.github.io/google-apis-rs/google_container1_beta1/trait.Part.html)** * a collection of properties * never directly used in *Activities* -* **[Activities](http://byron.github.io/google-apis-rs/google-container1_beta1/trait.CallBuilder.html)** +* **[Activities](http://byron.github.io/google-apis-rs/google_container1_beta1/trait.CallBuilder.html)** * operations to apply to *Resources* All *structures* are marked with applicable traits to further categorize them and ease browsing. @@ -114,17 +114,17 @@ match result { ``` ## Handling Errors -All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google-container1_beta1/enum.Result.html) enumeration as return value of +All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google_container1_beta1/enum.Result.html) enumeration as return value of the doit() methods, or handed as possibly intermediate results to either the -[Hub Delegate](http://byron.github.io/google-apis-rs/google-container1_beta1/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google-container1_beta1/../yup-oauth2/trait.AuthenticatorDelegate.html). +[Hub Delegate](http://byron.github.io/google-apis-rs/google_container1_beta1/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google_container1_beta1/../yup-oauth2/trait.AuthenticatorDelegate.html). 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](http://byron.github.io/google-apis-rs/google-container1_beta1/enum.Result.html), should be +If a method supports downloads, the response body, which is part of the [Result](http://byron.github.io/google-apis-rs/google_container1_beta1/enum.Result.html), should be read by you to obtain the media. -If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google-container1_beta1/trait.ResponseResult.html), it will return that by default. +If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google_container1_beta1/trait.ResponseResult.html), 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")`. @@ -134,29 +134,29 @@ Methods supporting uploads can do so using up to 2 different protocols: ## Customization and Callbacks -You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google-container1_beta1/trait.Delegate.html) to the -[Method Builder](http://byron.github.io/google-apis-rs/google-container1_beta1/trait.CallBuilder.html) before making the final `doit()` call. +You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google_container1_beta1/trait.Delegate.html) to the +[Method Builder](http://byron.github.io/google-apis-rs/google_container1_beta1/trait.CallBuilder.html) 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](http://byron.github.io/google-apis-rs/google-container1_beta1/trait.Delegate.html) is default-implemented, allowing you to customize it with minimal effort. +The [delegate trait](http://byron.github.io/google-apis-rs/google_container1_beta1/trait.Delegate.html) 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](http://byron.github.io/google-apis-rs/google-container1_beta1/trait.RequestValue.html) and -[decodable](http://byron.github.io/google-apis-rs/google-container1_beta1/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses +All structures provided by this library are made to be [enocodable](http://byron.github.io/google-apis-rs/google_container1_beta1/trait.RequestValue.html) and +[decodable](http://byron.github.io/google-apis-rs/google_container1_beta1/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses are valid. -Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google-container1_beta1/trait.Part.html) which are identifiable by name, which will be sent to +Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google_container1_beta1/trait.Part.html) 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](http://byron.github.io/google-apis-rs/google-container1_beta1/trait.CallBuilder.html), you are able to prepare an action call by repeatedly calling it's methods. +Using [method builders](http://byron.github.io/google-apis-rs/google_container1_beta1/trait.CallBuilder.html), 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][wiki-pod] are handed by copy * strings are passed as `&str` -* [request values](http://byron.github.io/google-apis-rs/google-container1_beta1/trait.RequestValue.html) are borrowed +* [request values](http://byron.github.io/google-apis-rs/google_container1_beta1/trait.RequestValue.html) are borrowed Arguments will always be copied or cloned into the builder, to make them independent of their original life times. diff --git a/gen/content2/README.md b/gen/content2/README.md index 75ab8a33b1..53b04af568 100644 --- a/gen/content2/README.md +++ b/gen/content2/README.md @@ -11,26 +11,26 @@ Everything else about the *Shopping Content* *v2* API can be found at the [official documentation site](https://developers.google.com/shopping-content/v2/). # Features -Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google-content2/struct.ShoppingContent.html) ... +Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google_content2/struct.ShoppingContent.html) ... -* [accounts](http://byron.github.io/google-apis-rs/google-content2/struct.Account.html) - * [*authinfo*](http://byron.github.io/google-apis-rs/google-content2/struct.AccountAuthinfoCall.html), [*custombatch*](http://byron.github.io/google-apis-rs/google-content2/struct.AccountCustombatchCall.html), [*delete*](http://byron.github.io/google-apis-rs/google-content2/struct.AccountDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google-content2/struct.AccountGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google-content2/struct.AccountInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google-content2/struct.AccountListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google-content2/struct.AccountPatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google-content2/struct.AccountUpdateCall.html) +* [accounts](http://byron.github.io/google-apis-rs/google_content2/struct.Account.html) + * [*authinfo*](http://byron.github.io/google-apis-rs/google_content2/struct.AccountAuthinfoCall.html), [*custombatch*](http://byron.github.io/google-apis-rs/google_content2/struct.AccountCustombatchCall.html), [*delete*](http://byron.github.io/google-apis-rs/google_content2/struct.AccountDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google_content2/struct.AccountGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google_content2/struct.AccountInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google_content2/struct.AccountListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google_content2/struct.AccountPatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google_content2/struct.AccountUpdateCall.html) * accountshipping - * [*custombatch*](http://byron.github.io/google-apis-rs/google-content2/struct.AccountshippingCustombatchCall.html), [*get*](http://byron.github.io/google-apis-rs/google-content2/struct.AccountshippingGetCall.html), [*list*](http://byron.github.io/google-apis-rs/google-content2/struct.AccountshippingListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google-content2/struct.AccountshippingPatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google-content2/struct.AccountshippingUpdateCall.html) + * [*custombatch*](http://byron.github.io/google-apis-rs/google_content2/struct.AccountshippingCustombatchCall.html), [*get*](http://byron.github.io/google-apis-rs/google_content2/struct.AccountshippingGetCall.html), [*list*](http://byron.github.io/google-apis-rs/google_content2/struct.AccountshippingListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google_content2/struct.AccountshippingPatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google_content2/struct.AccountshippingUpdateCall.html) * accountstatuses - * [*custombatch*](http://byron.github.io/google-apis-rs/google-content2/struct.AccountstatuseCustombatchCall.html), [*get*](http://byron.github.io/google-apis-rs/google-content2/struct.AccountstatuseGetCall.html) and [*list*](http://byron.github.io/google-apis-rs/google-content2/struct.AccountstatuseListCall.html) + * [*custombatch*](http://byron.github.io/google-apis-rs/google_content2/struct.AccountstatuseCustombatchCall.html), [*get*](http://byron.github.io/google-apis-rs/google_content2/struct.AccountstatuseGetCall.html) and [*list*](http://byron.github.io/google-apis-rs/google_content2/struct.AccountstatuseListCall.html) * accounttax - * [*custombatch*](http://byron.github.io/google-apis-rs/google-content2/struct.AccounttaxCustombatchCall.html), [*get*](http://byron.github.io/google-apis-rs/google-content2/struct.AccounttaxGetCall.html), [*list*](http://byron.github.io/google-apis-rs/google-content2/struct.AccounttaxListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google-content2/struct.AccounttaxPatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google-content2/struct.AccounttaxUpdateCall.html) -* [datafeeds](http://byron.github.io/google-apis-rs/google-content2/struct.Datafeed.html) - * [*custombatch*](http://byron.github.io/google-apis-rs/google-content2/struct.DatafeedCustombatchCall.html), [*delete*](http://byron.github.io/google-apis-rs/google-content2/struct.DatafeedDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google-content2/struct.DatafeedGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google-content2/struct.DatafeedInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google-content2/struct.DatafeedListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google-content2/struct.DatafeedPatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google-content2/struct.DatafeedUpdateCall.html) + * [*custombatch*](http://byron.github.io/google-apis-rs/google_content2/struct.AccounttaxCustombatchCall.html), [*get*](http://byron.github.io/google-apis-rs/google_content2/struct.AccounttaxGetCall.html), [*list*](http://byron.github.io/google-apis-rs/google_content2/struct.AccounttaxListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google_content2/struct.AccounttaxPatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google_content2/struct.AccounttaxUpdateCall.html) +* [datafeeds](http://byron.github.io/google-apis-rs/google_content2/struct.Datafeed.html) + * [*custombatch*](http://byron.github.io/google-apis-rs/google_content2/struct.DatafeedCustombatchCall.html), [*delete*](http://byron.github.io/google-apis-rs/google_content2/struct.DatafeedDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google_content2/struct.DatafeedGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google_content2/struct.DatafeedInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google_content2/struct.DatafeedListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google_content2/struct.DatafeedPatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google_content2/struct.DatafeedUpdateCall.html) * datafeedstatuses - * [*custombatch*](http://byron.github.io/google-apis-rs/google-content2/struct.DatafeedstatuseCustombatchCall.html), [*get*](http://byron.github.io/google-apis-rs/google-content2/struct.DatafeedstatuseGetCall.html) and [*list*](http://byron.github.io/google-apis-rs/google-content2/struct.DatafeedstatuseListCall.html) -* [inventory](http://byron.github.io/google-apis-rs/google-content2/struct.Inventory.html) - * [*custombatch*](http://byron.github.io/google-apis-rs/google-content2/struct.InventoryCustombatchCall.html) and [*set*](http://byron.github.io/google-apis-rs/google-content2/struct.InventorySetCall.html) -* [products](http://byron.github.io/google-apis-rs/google-content2/struct.Product.html) - * [*custombatch*](http://byron.github.io/google-apis-rs/google-content2/struct.ProductCustombatchCall.html), [*delete*](http://byron.github.io/google-apis-rs/google-content2/struct.ProductDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google-content2/struct.ProductGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google-content2/struct.ProductInsertCall.html) and [*list*](http://byron.github.io/google-apis-rs/google-content2/struct.ProductListCall.html) + * [*custombatch*](http://byron.github.io/google-apis-rs/google_content2/struct.DatafeedstatuseCustombatchCall.html), [*get*](http://byron.github.io/google-apis-rs/google_content2/struct.DatafeedstatuseGetCall.html) and [*list*](http://byron.github.io/google-apis-rs/google_content2/struct.DatafeedstatuseListCall.html) +* [inventory](http://byron.github.io/google-apis-rs/google_content2/struct.Inventory.html) + * [*custombatch*](http://byron.github.io/google-apis-rs/google_content2/struct.InventoryCustombatchCall.html) and [*set*](http://byron.github.io/google-apis-rs/google_content2/struct.InventorySetCall.html) +* [products](http://byron.github.io/google-apis-rs/google_content2/struct.Product.html) + * [*custombatch*](http://byron.github.io/google-apis-rs/google_content2/struct.ProductCustombatchCall.html), [*delete*](http://byron.github.io/google-apis-rs/google_content2/struct.ProductDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google_content2/struct.ProductGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google_content2/struct.ProductInsertCall.html) and [*list*](http://byron.github.io/google-apis-rs/google_content2/struct.ProductListCall.html) * productstatuses - * [*custombatch*](http://byron.github.io/google-apis-rs/google-content2/struct.ProductstatuseCustombatchCall.html), [*get*](http://byron.github.io/google-apis-rs/google-content2/struct.ProductstatuseGetCall.html) and [*list*](http://byron.github.io/google-apis-rs/google-content2/struct.ProductstatuseListCall.html) + * [*custombatch*](http://byron.github.io/google-apis-rs/google_content2/struct.ProductstatuseCustombatchCall.html), [*get*](http://byron.github.io/google-apis-rs/google_content2/struct.ProductstatuseGetCall.html) and [*list*](http://byron.github.io/google-apis-rs/google_content2/struct.ProductstatuseListCall.html) @@ -39,17 +39,17 @@ Handle the following *Resources* with ease from the central [hub](http://byron.g The API is structured into the following primary items: -* **[Hub](http://byron.github.io/google-apis-rs/google-content2/struct.ShoppingContent.html)** +* **[Hub](http://byron.github.io/google-apis-rs/google_content2/struct.ShoppingContent.html)** * a central object to maintain state and allow accessing all *Activities* - * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google-content2/trait.MethodsBuilder.html) which in turn - allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google-content2/trait.CallBuilder.html) -* **[Resources](http://byron.github.io/google-apis-rs/google-content2/trait.Resource.html)** + * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google_content2/trait.MethodsBuilder.html) which in turn + allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google_content2/trait.CallBuilder.html) +* **[Resources](http://byron.github.io/google-apis-rs/google_content2/trait.Resource.html)** * primary types that you can apply *Activities* to * a collection of properties and *Parts* - * **[Parts](http://byron.github.io/google-apis-rs/google-content2/trait.Part.html)** + * **[Parts](http://byron.github.io/google-apis-rs/google_content2/trait.Part.html)** * a collection of properties * never directly used in *Activities* -* **[Activities](http://byron.github.io/google-apis-rs/google-content2/trait.CallBuilder.html)** +* **[Activities](http://byron.github.io/google-apis-rs/google_content2/trait.CallBuilder.html)** * operations to apply to *Resources* All *structures* are marked with applicable traits to further categorize them and ease browsing. @@ -141,17 +141,17 @@ match result { ``` ## Handling Errors -All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google-content2/enum.Result.html) enumeration as return value of +All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google_content2/enum.Result.html) enumeration as return value of the doit() methods, or handed as possibly intermediate results to either the -[Hub Delegate](http://byron.github.io/google-apis-rs/google-content2/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google-content2/../yup-oauth2/trait.AuthenticatorDelegate.html). +[Hub Delegate](http://byron.github.io/google-apis-rs/google_content2/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google_content2/../yup-oauth2/trait.AuthenticatorDelegate.html). 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](http://byron.github.io/google-apis-rs/google-content2/enum.Result.html), should be +If a method supports downloads, the response body, which is part of the [Result](http://byron.github.io/google-apis-rs/google_content2/enum.Result.html), should be read by you to obtain the media. -If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google-content2/trait.ResponseResult.html), it will return that by default. +If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google_content2/trait.ResponseResult.html), 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")`. @@ -161,29 +161,29 @@ Methods supporting uploads can do so using up to 2 different protocols: ## Customization and Callbacks -You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google-content2/trait.Delegate.html) to the -[Method Builder](http://byron.github.io/google-apis-rs/google-content2/trait.CallBuilder.html) before making the final `doit()` call. +You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google_content2/trait.Delegate.html) to the +[Method Builder](http://byron.github.io/google-apis-rs/google_content2/trait.CallBuilder.html) 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](http://byron.github.io/google-apis-rs/google-content2/trait.Delegate.html) is default-implemented, allowing you to customize it with minimal effort. +The [delegate trait](http://byron.github.io/google-apis-rs/google_content2/trait.Delegate.html) 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](http://byron.github.io/google-apis-rs/google-content2/trait.RequestValue.html) and -[decodable](http://byron.github.io/google-apis-rs/google-content2/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses +All structures provided by this library are made to be [enocodable](http://byron.github.io/google-apis-rs/google_content2/trait.RequestValue.html) and +[decodable](http://byron.github.io/google-apis-rs/google_content2/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses are valid. -Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google-content2/trait.Part.html) which are identifiable by name, which will be sent to +Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google_content2/trait.Part.html) 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](http://byron.github.io/google-apis-rs/google-content2/trait.CallBuilder.html), you are able to prepare an action call by repeatedly calling it's methods. +Using [method builders](http://byron.github.io/google-apis-rs/google_content2/trait.CallBuilder.html), 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][wiki-pod] are handed by copy * strings are passed as `&str` -* [request values](http://byron.github.io/google-apis-rs/google-content2/trait.RequestValue.html) are borrowed +* [request values](http://byron.github.io/google-apis-rs/google_content2/trait.RequestValue.html) are borrowed Arguments will always be copied or cloned into the builder, to make them independent of their original life times. diff --git a/gen/coordinate1/README.md b/gen/coordinate1/README.md index 4d7dc617a3..24adfa8d8a 100644 --- a/gen/coordinate1/README.md +++ b/gen/coordinate1/README.md @@ -11,20 +11,20 @@ Everything else about the *coordinate* *v1* API can be found at the [official documentation site](https://developers.google.com/coordinate/). # Features -Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google-coordinate1/struct.Coordinate.html) ... +Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google_coordinate1/struct.Coordinate.html) ... -* [custom field def](http://byron.github.io/google-apis-rs/google-coordinate1/struct.CustomFieldDef.html) - * [*list*](http://byron.github.io/google-apis-rs/google-coordinate1/struct.CustomFieldDefListCall.html) -* [jobs](http://byron.github.io/google-apis-rs/google-coordinate1/struct.Job.html) - * [*get*](http://byron.github.io/google-apis-rs/google-coordinate1/struct.JobGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google-coordinate1/struct.JobInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google-coordinate1/struct.JobListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google-coordinate1/struct.JobPatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google-coordinate1/struct.JobUpdateCall.html) -* [location](http://byron.github.io/google-apis-rs/google-coordinate1/struct.Location.html) - * [*list*](http://byron.github.io/google-apis-rs/google-coordinate1/struct.LocationListCall.html) -* [schedule](http://byron.github.io/google-apis-rs/google-coordinate1/struct.Schedule.html) - * [*get*](http://byron.github.io/google-apis-rs/google-coordinate1/struct.ScheduleGetCall.html), [*patch*](http://byron.github.io/google-apis-rs/google-coordinate1/struct.SchedulePatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google-coordinate1/struct.ScheduleUpdateCall.html) -* [team](http://byron.github.io/google-apis-rs/google-coordinate1/struct.Team.html) - * [*list*](http://byron.github.io/google-apis-rs/google-coordinate1/struct.TeamListCall.html) -* [worker](http://byron.github.io/google-apis-rs/google-coordinate1/struct.Worker.html) - * [*list*](http://byron.github.io/google-apis-rs/google-coordinate1/struct.WorkerListCall.html) +* [custom field def](http://byron.github.io/google-apis-rs/google_coordinate1/struct.CustomFieldDef.html) + * [*list*](http://byron.github.io/google-apis-rs/google_coordinate1/struct.CustomFieldDefListCall.html) +* [jobs](http://byron.github.io/google-apis-rs/google_coordinate1/struct.Job.html) + * [*get*](http://byron.github.io/google-apis-rs/google_coordinate1/struct.JobGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google_coordinate1/struct.JobInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google_coordinate1/struct.JobListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google_coordinate1/struct.JobPatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google_coordinate1/struct.JobUpdateCall.html) +* [location](http://byron.github.io/google-apis-rs/google_coordinate1/struct.Location.html) + * [*list*](http://byron.github.io/google-apis-rs/google_coordinate1/struct.LocationListCall.html) +* [schedule](http://byron.github.io/google-apis-rs/google_coordinate1/struct.Schedule.html) + * [*get*](http://byron.github.io/google-apis-rs/google_coordinate1/struct.ScheduleGetCall.html), [*patch*](http://byron.github.io/google-apis-rs/google_coordinate1/struct.SchedulePatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google_coordinate1/struct.ScheduleUpdateCall.html) +* [team](http://byron.github.io/google-apis-rs/google_coordinate1/struct.Team.html) + * [*list*](http://byron.github.io/google-apis-rs/google_coordinate1/struct.TeamListCall.html) +* [worker](http://byron.github.io/google-apis-rs/google_coordinate1/struct.Worker.html) + * [*list*](http://byron.github.io/google-apis-rs/google_coordinate1/struct.WorkerListCall.html) @@ -33,17 +33,17 @@ Handle the following *Resources* with ease from the central [hub](http://byron.g The API is structured into the following primary items: -* **[Hub](http://byron.github.io/google-apis-rs/google-coordinate1/struct.Coordinate.html)** +* **[Hub](http://byron.github.io/google-apis-rs/google_coordinate1/struct.Coordinate.html)** * a central object to maintain state and allow accessing all *Activities* - * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google-coordinate1/trait.MethodsBuilder.html) which in turn - allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google-coordinate1/trait.CallBuilder.html) -* **[Resources](http://byron.github.io/google-apis-rs/google-coordinate1/trait.Resource.html)** + * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google_coordinate1/trait.MethodsBuilder.html) which in turn + allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google_coordinate1/trait.CallBuilder.html) +* **[Resources](http://byron.github.io/google-apis-rs/google_coordinate1/trait.Resource.html)** * primary types that you can apply *Activities* to * a collection of properties and *Parts* - * **[Parts](http://byron.github.io/google-apis-rs/google-coordinate1/trait.Part.html)** + * **[Parts](http://byron.github.io/google-apis-rs/google_coordinate1/trait.Part.html)** * a collection of properties * never directly used in *Activities* -* **[Activities](http://byron.github.io/google-apis-rs/google-coordinate1/trait.CallBuilder.html)** +* **[Activities](http://byron.github.io/google-apis-rs/google_coordinate1/trait.CallBuilder.html)** * operations to apply to *Resources* All *structures* are marked with applicable traits to further categorize them and ease browsing. @@ -142,17 +142,17 @@ match result { ``` ## Handling Errors -All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google-coordinate1/enum.Result.html) enumeration as return value of +All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google_coordinate1/enum.Result.html) enumeration as return value of the doit() methods, or handed as possibly intermediate results to either the -[Hub Delegate](http://byron.github.io/google-apis-rs/google-coordinate1/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google-coordinate1/../yup-oauth2/trait.AuthenticatorDelegate.html). +[Hub Delegate](http://byron.github.io/google-apis-rs/google_coordinate1/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google_coordinate1/../yup-oauth2/trait.AuthenticatorDelegate.html). 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](http://byron.github.io/google-apis-rs/google-coordinate1/enum.Result.html), should be +If a method supports downloads, the response body, which is part of the [Result](http://byron.github.io/google-apis-rs/google_coordinate1/enum.Result.html), should be read by you to obtain the media. -If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google-coordinate1/trait.ResponseResult.html), it will return that by default. +If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google_coordinate1/trait.ResponseResult.html), 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")`. @@ -162,29 +162,29 @@ Methods supporting uploads can do so using up to 2 different protocols: ## Customization and Callbacks -You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google-coordinate1/trait.Delegate.html) to the -[Method Builder](http://byron.github.io/google-apis-rs/google-coordinate1/trait.CallBuilder.html) before making the final `doit()` call. +You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google_coordinate1/trait.Delegate.html) to the +[Method Builder](http://byron.github.io/google-apis-rs/google_coordinate1/trait.CallBuilder.html) 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](http://byron.github.io/google-apis-rs/google-coordinate1/trait.Delegate.html) is default-implemented, allowing you to customize it with minimal effort. +The [delegate trait](http://byron.github.io/google-apis-rs/google_coordinate1/trait.Delegate.html) 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](http://byron.github.io/google-apis-rs/google-coordinate1/trait.RequestValue.html) and -[decodable](http://byron.github.io/google-apis-rs/google-coordinate1/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses +All structures provided by this library are made to be [enocodable](http://byron.github.io/google-apis-rs/google_coordinate1/trait.RequestValue.html) and +[decodable](http://byron.github.io/google-apis-rs/google_coordinate1/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses are valid. -Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google-coordinate1/trait.Part.html) which are identifiable by name, which will be sent to +Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google_coordinate1/trait.Part.html) 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](http://byron.github.io/google-apis-rs/google-coordinate1/trait.CallBuilder.html), you are able to prepare an action call by repeatedly calling it's methods. +Using [method builders](http://byron.github.io/google-apis-rs/google_coordinate1/trait.CallBuilder.html), 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][wiki-pod] are handed by copy * strings are passed as `&str` -* [request values](http://byron.github.io/google-apis-rs/google-coordinate1/trait.RequestValue.html) are borrowed +* [request values](http://byron.github.io/google-apis-rs/google_coordinate1/trait.RequestValue.html) are borrowed Arguments will always be copied or cloned into the builder, to make them independent of their original life times. diff --git a/gen/customsearch1/README.md b/gen/customsearch1/README.md index 1c4a408271..af67c5b29e 100644 --- a/gen/customsearch1/README.md +++ b/gen/customsearch1/README.md @@ -11,10 +11,10 @@ Everything else about the *customsearch* *v1* API can be found at the [official documentation site](https://developers.google.com/custom-search/v1/using_rest). # Features -Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google-customsearch1/struct.Customsearch.html) ... +Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google_customsearch1/struct.Customsearch.html) ... * cse - * [*list*](http://byron.github.io/google-apis-rs/google-customsearch1/struct.CseListCall.html) + * [*list*](http://byron.github.io/google-apis-rs/google_customsearch1/struct.CseListCall.html) @@ -23,17 +23,17 @@ Handle the following *Resources* with ease from the central [hub](http://byron.g The API is structured into the following primary items: -* **[Hub](http://byron.github.io/google-apis-rs/google-customsearch1/struct.Customsearch.html)** +* **[Hub](http://byron.github.io/google-apis-rs/google_customsearch1/struct.Customsearch.html)** * a central object to maintain state and allow accessing all *Activities* - * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google-customsearch1/trait.MethodsBuilder.html) which in turn - allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google-customsearch1/trait.CallBuilder.html) -* **[Resources](http://byron.github.io/google-apis-rs/google-customsearch1/trait.Resource.html)** + * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google_customsearch1/trait.MethodsBuilder.html) which in turn + allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google_customsearch1/trait.CallBuilder.html) +* **[Resources](http://byron.github.io/google-apis-rs/google_customsearch1/trait.Resource.html)** * primary types that you can apply *Activities* to * a collection of properties and *Parts* - * **[Parts](http://byron.github.io/google-apis-rs/google-customsearch1/trait.Part.html)** + * **[Parts](http://byron.github.io/google-apis-rs/google_customsearch1/trait.Part.html)** * a collection of properties * never directly used in *Activities* -* **[Activities](http://byron.github.io/google-apis-rs/google-customsearch1/trait.CallBuilder.html)** +* **[Activities](http://byron.github.io/google-apis-rs/google_customsearch1/trait.CallBuilder.html)** * operations to apply to *Resources* All *structures* are marked with applicable traits to further categorize them and ease browsing. @@ -143,17 +143,17 @@ match result { ``` ## Handling Errors -All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google-customsearch1/enum.Result.html) enumeration as return value of +All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google_customsearch1/enum.Result.html) enumeration as return value of the doit() methods, or handed as possibly intermediate results to either the -[Hub Delegate](http://byron.github.io/google-apis-rs/google-customsearch1/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google-customsearch1/../yup-oauth2/trait.AuthenticatorDelegate.html). +[Hub Delegate](http://byron.github.io/google-apis-rs/google_customsearch1/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google_customsearch1/../yup-oauth2/trait.AuthenticatorDelegate.html). 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](http://byron.github.io/google-apis-rs/google-customsearch1/enum.Result.html), should be +If a method supports downloads, the response body, which is part of the [Result](http://byron.github.io/google-apis-rs/google_customsearch1/enum.Result.html), should be read by you to obtain the media. -If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google-customsearch1/trait.ResponseResult.html), it will return that by default. +If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google_customsearch1/trait.ResponseResult.html), 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")`. @@ -163,29 +163,29 @@ Methods supporting uploads can do so using up to 2 different protocols: ## Customization and Callbacks -You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google-customsearch1/trait.Delegate.html) to the -[Method Builder](http://byron.github.io/google-apis-rs/google-customsearch1/trait.CallBuilder.html) before making the final `doit()` call. +You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google_customsearch1/trait.Delegate.html) to the +[Method Builder](http://byron.github.io/google-apis-rs/google_customsearch1/trait.CallBuilder.html) 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](http://byron.github.io/google-apis-rs/google-customsearch1/trait.Delegate.html) is default-implemented, allowing you to customize it with minimal effort. +The [delegate trait](http://byron.github.io/google-apis-rs/google_customsearch1/trait.Delegate.html) 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](http://byron.github.io/google-apis-rs/google-customsearch1/trait.RequestValue.html) and -[decodable](http://byron.github.io/google-apis-rs/google-customsearch1/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses +All structures provided by this library are made to be [enocodable](http://byron.github.io/google-apis-rs/google_customsearch1/trait.RequestValue.html) and +[decodable](http://byron.github.io/google-apis-rs/google_customsearch1/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses are valid. -Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google-customsearch1/trait.Part.html) which are identifiable by name, which will be sent to +Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google_customsearch1/trait.Part.html) 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](http://byron.github.io/google-apis-rs/google-customsearch1/trait.CallBuilder.html), you are able to prepare an action call by repeatedly calling it's methods. +Using [method builders](http://byron.github.io/google-apis-rs/google_customsearch1/trait.CallBuilder.html), 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][wiki-pod] are handed by copy * strings are passed as `&str` -* [request values](http://byron.github.io/google-apis-rs/google-customsearch1/trait.RequestValue.html) are borrowed +* [request values](http://byron.github.io/google-apis-rs/google_customsearch1/trait.RequestValue.html) are borrowed Arguments will always be copied or cloned into the builder, to make them independent of their original life times. diff --git a/gen/dataflow1_b4/README.md b/gen/dataflow1_b4/README.md index f474dcdee2..c33eddfca1 100644 --- a/gen/dataflow1_b4/README.md +++ b/gen/dataflow1_b4/README.md @@ -18,17 +18,17 @@ It seems there is nothing you can do here ... . The API is structured into the following primary items: -* **[Hub](http://byron.github.io/google-apis-rs/google-dataflow1_b4/struct.Dataflow.html)** +* **[Hub](http://byron.github.io/google-apis-rs/google_dataflow1_b4/struct.Dataflow.html)** * a central object to maintain state and allow accessing all *Activities* - * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google-dataflow1_b4/trait.MethodsBuilder.html) which in turn - allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google-dataflow1_b4/trait.CallBuilder.html) -* **[Resources](http://byron.github.io/google-apis-rs/google-dataflow1_b4/trait.Resource.html)** + * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google_dataflow1_b4/trait.MethodsBuilder.html) which in turn + allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google_dataflow1_b4/trait.CallBuilder.html) +* **[Resources](http://byron.github.io/google-apis-rs/google_dataflow1_b4/trait.Resource.html)** * primary types that you can apply *Activities* to * a collection of properties and *Parts* - * **[Parts](http://byron.github.io/google-apis-rs/google-dataflow1_b4/trait.Part.html)** + * **[Parts](http://byron.github.io/google-apis-rs/google_dataflow1_b4/trait.Part.html)** * a collection of properties * never directly used in *Activities* -* **[Activities](http://byron.github.io/google-apis-rs/google-dataflow1_b4/trait.CallBuilder.html)** +* **[Activities](http://byron.github.io/google-apis-rs/google_dataflow1_b4/trait.CallBuilder.html)** * operations to apply to *Resources* All *structures* are marked with applicable traits to further categorize them and ease browsing. @@ -84,17 +84,17 @@ let mut hub = Dataflow::new(hyper::Client::new(), auth); ## Handling Errors -All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google-dataflow1_b4/enum.Result.html) enumeration as return value of +All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google_dataflow1_b4/enum.Result.html) enumeration as return value of the doit() methods, or handed as possibly intermediate results to either the -[Hub Delegate](http://byron.github.io/google-apis-rs/google-dataflow1_b4/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google-dataflow1_b4/../yup-oauth2/trait.AuthenticatorDelegate.html). +[Hub Delegate](http://byron.github.io/google-apis-rs/google_dataflow1_b4/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google_dataflow1_b4/../yup-oauth2/trait.AuthenticatorDelegate.html). 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](http://byron.github.io/google-apis-rs/google-dataflow1_b4/enum.Result.html), should be +If a method supports downloads, the response body, which is part of the [Result](http://byron.github.io/google-apis-rs/google_dataflow1_b4/enum.Result.html), should be read by you to obtain the media. -If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google-dataflow1_b4/trait.ResponseResult.html), it will return that by default. +If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google_dataflow1_b4/trait.ResponseResult.html), 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")`. @@ -104,29 +104,29 @@ Methods supporting uploads can do so using up to 2 different protocols: ## Customization and Callbacks -You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google-dataflow1_b4/trait.Delegate.html) to the -[Method Builder](http://byron.github.io/google-apis-rs/google-dataflow1_b4/trait.CallBuilder.html) before making the final `doit()` call. +You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google_dataflow1_b4/trait.Delegate.html) to the +[Method Builder](http://byron.github.io/google-apis-rs/google_dataflow1_b4/trait.CallBuilder.html) 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](http://byron.github.io/google-apis-rs/google-dataflow1_b4/trait.Delegate.html) is default-implemented, allowing you to customize it with minimal effort. +The [delegate trait](http://byron.github.io/google-apis-rs/google_dataflow1_b4/trait.Delegate.html) 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](http://byron.github.io/google-apis-rs/google-dataflow1_b4/trait.RequestValue.html) and -[decodable](http://byron.github.io/google-apis-rs/google-dataflow1_b4/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses +All structures provided by this library are made to be [enocodable](http://byron.github.io/google-apis-rs/google_dataflow1_b4/trait.RequestValue.html) and +[decodable](http://byron.github.io/google-apis-rs/google_dataflow1_b4/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses are valid. -Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google-dataflow1_b4/trait.Part.html) which are identifiable by name, which will be sent to +Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google_dataflow1_b4/trait.Part.html) 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](http://byron.github.io/google-apis-rs/google-dataflow1_b4/trait.CallBuilder.html), you are able to prepare an action call by repeatedly calling it's methods. +Using [method builders](http://byron.github.io/google-apis-rs/google_dataflow1_b4/trait.CallBuilder.html), 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][wiki-pod] are handed by copy * strings are passed as `&str` -* [request values](http://byron.github.io/google-apis-rs/google-dataflow1_b4/trait.RequestValue.html) are borrowed +* [request values](http://byron.github.io/google-apis-rs/google_dataflow1_b4/trait.RequestValue.html) are borrowed Arguments will always be copied or cloned into the builder, to make them independent of their original life times. diff --git a/gen/datastore1_beta2/README.md b/gen/datastore1_beta2/README.md index 35d10760fc..64306df13e 100644 --- a/gen/datastore1_beta2/README.md +++ b/gen/datastore1_beta2/README.md @@ -11,10 +11,10 @@ Everything else about the *datastore* *v1_beta2* API can be found at the [official documentation site](https://developers.google.com/datastore/). # Features -Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google-datastore1_beta2/struct.Datastore.html) ... +Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google_datastore1_beta2/struct.Datastore.html) ... * datasets - * [*allocate ids*](http://byron.github.io/google-apis-rs/google-datastore1_beta2/struct.DatasetAllocateIdCall.html), [*begin transaction*](http://byron.github.io/google-apis-rs/google-datastore1_beta2/struct.DatasetBeginTransactionCall.html), [*commit*](http://byron.github.io/google-apis-rs/google-datastore1_beta2/struct.DatasetCommitCall.html), [*lookup*](http://byron.github.io/google-apis-rs/google-datastore1_beta2/struct.DatasetLookupCall.html), [*rollback*](http://byron.github.io/google-apis-rs/google-datastore1_beta2/struct.DatasetRollbackCall.html) and [*run query*](http://byron.github.io/google-apis-rs/google-datastore1_beta2/struct.DatasetRunQueryCall.html) + * [*allocate ids*](http://byron.github.io/google-apis-rs/google_datastore1_beta2/struct.DatasetAllocateIdCall.html), [*begin transaction*](http://byron.github.io/google-apis-rs/google_datastore1_beta2/struct.DatasetBeginTransactionCall.html), [*commit*](http://byron.github.io/google-apis-rs/google_datastore1_beta2/struct.DatasetCommitCall.html), [*lookup*](http://byron.github.io/google-apis-rs/google_datastore1_beta2/struct.DatasetLookupCall.html), [*rollback*](http://byron.github.io/google-apis-rs/google_datastore1_beta2/struct.DatasetRollbackCall.html) and [*run query*](http://byron.github.io/google-apis-rs/google_datastore1_beta2/struct.DatasetRunQueryCall.html) @@ -23,17 +23,17 @@ Handle the following *Resources* with ease from the central [hub](http://byron.g The API is structured into the following primary items: -* **[Hub](http://byron.github.io/google-apis-rs/google-datastore1_beta2/struct.Datastore.html)** +* **[Hub](http://byron.github.io/google-apis-rs/google_datastore1_beta2/struct.Datastore.html)** * a central object to maintain state and allow accessing all *Activities* - * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google-datastore1_beta2/trait.MethodsBuilder.html) which in turn - allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google-datastore1_beta2/trait.CallBuilder.html) -* **[Resources](http://byron.github.io/google-apis-rs/google-datastore1_beta2/trait.Resource.html)** + * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google_datastore1_beta2/trait.MethodsBuilder.html) which in turn + allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google_datastore1_beta2/trait.CallBuilder.html) +* **[Resources](http://byron.github.io/google-apis-rs/google_datastore1_beta2/trait.Resource.html)** * primary types that you can apply *Activities* to * a collection of properties and *Parts* - * **[Parts](http://byron.github.io/google-apis-rs/google-datastore1_beta2/trait.Part.html)** + * **[Parts](http://byron.github.io/google-apis-rs/google_datastore1_beta2/trait.Part.html)** * a collection of properties * never directly used in *Activities* -* **[Activities](http://byron.github.io/google-apis-rs/google-datastore1_beta2/trait.CallBuilder.html)** +* **[Activities](http://byron.github.io/google-apis-rs/google_datastore1_beta2/trait.CallBuilder.html)** * operations to apply to *Resources* All *structures* are marked with applicable traits to further categorize them and ease browsing. @@ -118,17 +118,17 @@ match result { ``` ## Handling Errors -All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google-datastore1_beta2/enum.Result.html) enumeration as return value of +All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google_datastore1_beta2/enum.Result.html) enumeration as return value of the doit() methods, or handed as possibly intermediate results to either the -[Hub Delegate](http://byron.github.io/google-apis-rs/google-datastore1_beta2/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google-datastore1_beta2/../yup-oauth2/trait.AuthenticatorDelegate.html). +[Hub Delegate](http://byron.github.io/google-apis-rs/google_datastore1_beta2/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google_datastore1_beta2/../yup-oauth2/trait.AuthenticatorDelegate.html). 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](http://byron.github.io/google-apis-rs/google-datastore1_beta2/enum.Result.html), should be +If a method supports downloads, the response body, which is part of the [Result](http://byron.github.io/google-apis-rs/google_datastore1_beta2/enum.Result.html), should be read by you to obtain the media. -If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google-datastore1_beta2/trait.ResponseResult.html), it will return that by default. +If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google_datastore1_beta2/trait.ResponseResult.html), 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")`. @@ -138,29 +138,29 @@ Methods supporting uploads can do so using up to 2 different protocols: ## Customization and Callbacks -You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google-datastore1_beta2/trait.Delegate.html) to the -[Method Builder](http://byron.github.io/google-apis-rs/google-datastore1_beta2/trait.CallBuilder.html) before making the final `doit()` call. +You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google_datastore1_beta2/trait.Delegate.html) to the +[Method Builder](http://byron.github.io/google-apis-rs/google_datastore1_beta2/trait.CallBuilder.html) 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](http://byron.github.io/google-apis-rs/google-datastore1_beta2/trait.Delegate.html) is default-implemented, allowing you to customize it with minimal effort. +The [delegate trait](http://byron.github.io/google-apis-rs/google_datastore1_beta2/trait.Delegate.html) 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](http://byron.github.io/google-apis-rs/google-datastore1_beta2/trait.RequestValue.html) and -[decodable](http://byron.github.io/google-apis-rs/google-datastore1_beta2/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses +All structures provided by this library are made to be [enocodable](http://byron.github.io/google-apis-rs/google_datastore1_beta2/trait.RequestValue.html) and +[decodable](http://byron.github.io/google-apis-rs/google_datastore1_beta2/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses are valid. -Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google-datastore1_beta2/trait.Part.html) which are identifiable by name, which will be sent to +Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google_datastore1_beta2/trait.Part.html) 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](http://byron.github.io/google-apis-rs/google-datastore1_beta2/trait.CallBuilder.html), you are able to prepare an action call by repeatedly calling it's methods. +Using [method builders](http://byron.github.io/google-apis-rs/google_datastore1_beta2/trait.CallBuilder.html), 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][wiki-pod] are handed by copy * strings are passed as `&str` -* [request values](http://byron.github.io/google-apis-rs/google-datastore1_beta2/trait.RequestValue.html) are borrowed +* [request values](http://byron.github.io/google-apis-rs/google_datastore1_beta2/trait.RequestValue.html) are borrowed Arguments will always be copied or cloned into the builder, to make them independent of their original life times. diff --git a/gen/deploymentmanager2_beta1/README.md b/gen/deploymentmanager2_beta1/README.md index dde8803da3..e1a38360a9 100644 --- a/gen/deploymentmanager2_beta1/README.md +++ b/gen/deploymentmanager2_beta1/README.md @@ -11,18 +11,18 @@ Everything else about the *deploymentmanager* *v2_beta1* API can be found at the [official documentation site](https://developers.google.com/deployment-manager/). # Features -Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google-deploymentmanager2_beta1/struct.Deploymentmanager.html) ... +Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google_deploymentmanager2_beta1/struct.Deploymentmanager.html) ... -* [deployments](http://byron.github.io/google-apis-rs/google-deploymentmanager2_beta1/struct.Deployment.html) - * [*delete*](http://byron.github.io/google-apis-rs/google-deploymentmanager2_beta1/struct.DeploymentDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google-deploymentmanager2_beta1/struct.DeploymentGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google-deploymentmanager2_beta1/struct.DeploymentInsertCall.html) and [*list*](http://byron.github.io/google-apis-rs/google-deploymentmanager2_beta1/struct.DeploymentListCall.html) -* [manifests](http://byron.github.io/google-apis-rs/google-deploymentmanager2_beta1/struct.Manifest.html) - * [*get*](http://byron.github.io/google-apis-rs/google-deploymentmanager2_beta1/struct.ManifestGetCall.html) and [*list*](http://byron.github.io/google-apis-rs/google-deploymentmanager2_beta1/struct.ManifestListCall.html) -* [operations](http://byron.github.io/google-apis-rs/google-deploymentmanager2_beta1/struct.Operation.html) - * [*get*](http://byron.github.io/google-apis-rs/google-deploymentmanager2_beta1/struct.OperationGetCall.html) and [*list*](http://byron.github.io/google-apis-rs/google-deploymentmanager2_beta1/struct.OperationListCall.html) -* [resources](http://byron.github.io/google-apis-rs/google-deploymentmanager2_beta1/struct.ResourceType.html) - * [*get*](http://byron.github.io/google-apis-rs/google-deploymentmanager2_beta1/struct.ResourceGetCall.html) and [*list*](http://byron.github.io/google-apis-rs/google-deploymentmanager2_beta1/struct.ResourceListCall.html) -* [types](http://byron.github.io/google-apis-rs/google-deploymentmanager2_beta1/struct.Type.html) - * [*list*](http://byron.github.io/google-apis-rs/google-deploymentmanager2_beta1/struct.TypeListCall.html) +* [deployments](http://byron.github.io/google-apis-rs/google_deploymentmanager2_beta1/struct.Deployment.html) + * [*delete*](http://byron.github.io/google-apis-rs/google_deploymentmanager2_beta1/struct.DeploymentDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google_deploymentmanager2_beta1/struct.DeploymentGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google_deploymentmanager2_beta1/struct.DeploymentInsertCall.html) and [*list*](http://byron.github.io/google-apis-rs/google_deploymentmanager2_beta1/struct.DeploymentListCall.html) +* [manifests](http://byron.github.io/google-apis-rs/google_deploymentmanager2_beta1/struct.Manifest.html) + * [*get*](http://byron.github.io/google-apis-rs/google_deploymentmanager2_beta1/struct.ManifestGetCall.html) and [*list*](http://byron.github.io/google-apis-rs/google_deploymentmanager2_beta1/struct.ManifestListCall.html) +* [operations](http://byron.github.io/google-apis-rs/google_deploymentmanager2_beta1/struct.Operation.html) + * [*get*](http://byron.github.io/google-apis-rs/google_deploymentmanager2_beta1/struct.OperationGetCall.html) and [*list*](http://byron.github.io/google-apis-rs/google_deploymentmanager2_beta1/struct.OperationListCall.html) +* [resources](http://byron.github.io/google-apis-rs/google_deploymentmanager2_beta1/struct.ResourceType.html) + * [*get*](http://byron.github.io/google-apis-rs/google_deploymentmanager2_beta1/struct.ResourceGetCall.html) and [*list*](http://byron.github.io/google-apis-rs/google_deploymentmanager2_beta1/struct.ResourceListCall.html) +* [types](http://byron.github.io/google-apis-rs/google_deploymentmanager2_beta1/struct.Type.html) + * [*list*](http://byron.github.io/google-apis-rs/google_deploymentmanager2_beta1/struct.TypeListCall.html) @@ -31,17 +31,17 @@ Handle the following *Resources* with ease from the central [hub](http://byron.g The API is structured into the following primary items: -* **[Hub](http://byron.github.io/google-apis-rs/google-deploymentmanager2_beta1/struct.Deploymentmanager.html)** +* **[Hub](http://byron.github.io/google-apis-rs/google_deploymentmanager2_beta1/struct.Deploymentmanager.html)** * a central object to maintain state and allow accessing all *Activities* - * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google-deploymentmanager2_beta1/trait.MethodsBuilder.html) which in turn - allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google-deploymentmanager2_beta1/trait.CallBuilder.html) -* **[Resources](http://byron.github.io/google-apis-rs/google-deploymentmanager2_beta1/trait.Resource.html)** + * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google_deploymentmanager2_beta1/trait.MethodsBuilder.html) which in turn + allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google_deploymentmanager2_beta1/trait.CallBuilder.html) +* **[Resources](http://byron.github.io/google-apis-rs/google_deploymentmanager2_beta1/trait.Resource.html)** * primary types that you can apply *Activities* to * a collection of properties and *Parts* - * **[Parts](http://byron.github.io/google-apis-rs/google-deploymentmanager2_beta1/trait.Part.html)** + * **[Parts](http://byron.github.io/google-apis-rs/google_deploymentmanager2_beta1/trait.Part.html)** * a collection of properties * never directly used in *Activities* -* **[Activities](http://byron.github.io/google-apis-rs/google-deploymentmanager2_beta1/trait.CallBuilder.html)** +* **[Activities](http://byron.github.io/google-apis-rs/google_deploymentmanager2_beta1/trait.CallBuilder.html)** * operations to apply to *Resources* All *structures* are marked with applicable traits to further categorize them and ease browsing. @@ -125,17 +125,17 @@ match result { ``` ## Handling Errors -All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google-deploymentmanager2_beta1/enum.Result.html) enumeration as return value of +All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google_deploymentmanager2_beta1/enum.Result.html) enumeration as return value of the doit() methods, or handed as possibly intermediate results to either the -[Hub Delegate](http://byron.github.io/google-apis-rs/google-deploymentmanager2_beta1/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google-deploymentmanager2_beta1/../yup-oauth2/trait.AuthenticatorDelegate.html). +[Hub Delegate](http://byron.github.io/google-apis-rs/google_deploymentmanager2_beta1/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google_deploymentmanager2_beta1/../yup-oauth2/trait.AuthenticatorDelegate.html). 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](http://byron.github.io/google-apis-rs/google-deploymentmanager2_beta1/enum.Result.html), should be +If a method supports downloads, the response body, which is part of the [Result](http://byron.github.io/google-apis-rs/google_deploymentmanager2_beta1/enum.Result.html), should be read by you to obtain the media. -If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google-deploymentmanager2_beta1/trait.ResponseResult.html), it will return that by default. +If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google_deploymentmanager2_beta1/trait.ResponseResult.html), 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")`. @@ -145,29 +145,29 @@ Methods supporting uploads can do so using up to 2 different protocols: ## Customization and Callbacks -You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google-deploymentmanager2_beta1/trait.Delegate.html) to the -[Method Builder](http://byron.github.io/google-apis-rs/google-deploymentmanager2_beta1/trait.CallBuilder.html) before making the final `doit()` call. +You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google_deploymentmanager2_beta1/trait.Delegate.html) to the +[Method Builder](http://byron.github.io/google-apis-rs/google_deploymentmanager2_beta1/trait.CallBuilder.html) 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](http://byron.github.io/google-apis-rs/google-deploymentmanager2_beta1/trait.Delegate.html) is default-implemented, allowing you to customize it with minimal effort. +The [delegate trait](http://byron.github.io/google-apis-rs/google_deploymentmanager2_beta1/trait.Delegate.html) 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](http://byron.github.io/google-apis-rs/google-deploymentmanager2_beta1/trait.RequestValue.html) and -[decodable](http://byron.github.io/google-apis-rs/google-deploymentmanager2_beta1/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses +All structures provided by this library are made to be [enocodable](http://byron.github.io/google-apis-rs/google_deploymentmanager2_beta1/trait.RequestValue.html) and +[decodable](http://byron.github.io/google-apis-rs/google_deploymentmanager2_beta1/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses are valid. -Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google-deploymentmanager2_beta1/trait.Part.html) which are identifiable by name, which will be sent to +Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google_deploymentmanager2_beta1/trait.Part.html) 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](http://byron.github.io/google-apis-rs/google-deploymentmanager2_beta1/trait.CallBuilder.html), you are able to prepare an action call by repeatedly calling it's methods. +Using [method builders](http://byron.github.io/google-apis-rs/google_deploymentmanager2_beta1/trait.CallBuilder.html), 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][wiki-pod] are handed by copy * strings are passed as `&str` -* [request values](http://byron.github.io/google-apis-rs/google-deploymentmanager2_beta1/trait.RequestValue.html) are borrowed +* [request values](http://byron.github.io/google-apis-rs/google_deploymentmanager2_beta1/trait.RequestValue.html) are borrowed Arguments will always be copied or cloned into the builder, to make them independent of their original life times. diff --git a/gen/dfareporting2/README.md b/gen/dfareporting2/README.md index 80fdc040d0..4b6bf77134 100644 --- a/gen/dfareporting2/README.md +++ b/gen/dfareporting2/README.md @@ -11,114 +11,114 @@ Everything else about the *dfareporting* *v2* API can be found at the [official documentation site](https://developers.google.com/doubleclick-advertisers/reporting/). # Features -Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.Dfareporting.html) ... +Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.Dfareporting.html) ... -* [account active ad summaries](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.AccountActiveAdSummary.html) - * [*get*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.AccountActiveAdSummaryGetCall.html) -* [account permission groups](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.AccountPermissionGroup.html) - * [*get*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.AccountPermissionGroupGetCall.html) and [*list*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.AccountPermissionGroupListCall.html) -* [account permissions](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.AccountPermission.html) - * [*get*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.AccountPermissionGetCall.html) and [*list*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.AccountPermissionListCall.html) -* [account user profiles](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.AccountUserProfile.html) - * [*get*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.AccountUserProfileGetCall.html), [*list*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.AccountUserProfileListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.AccountUserProfilePatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.AccountUserProfileUpdateCall.html) -* [accounts](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.Account.html) - * [*get*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.AccountGetCall.html), [*list*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.AccountListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.AccountPatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.AccountUpdateCall.html) -* [ads](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.Ad.html) - * [*get*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.AdGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.AdInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.AdListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.AdPatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.AdUpdateCall.html) -* [advertiser groups](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.AdvertiserGroup.html) - * [*delete*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.AdvertiserGroupDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.AdvertiserGroupGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.AdvertiserGroupInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.AdvertiserGroupListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.AdvertiserGroupPatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.AdvertiserGroupUpdateCall.html) -* [advertisers](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.Advertiser.html) - * [*get*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.AdvertiserGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.AdvertiserInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.AdvertiserListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.AdvertiserPatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.AdvertiserUpdateCall.html) -* [browsers](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.Browser.html) - * [*list*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.BrowserListCall.html) -* [campaign creative associations](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.CampaignCreativeAssociation.html) - * [*insert*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.CampaignCreativeAssociationInsertCall.html) and [*list*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.CampaignCreativeAssociationListCall.html) -* [campaigns](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.Campaign.html) - * [*get*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.CampaignGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.CampaignInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.CampaignListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.CampaignPatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.CampaignUpdateCall.html) -* [change logs](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.ChangeLog.html) - * [*get*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.ChangeLogGetCall.html) and [*list*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.ChangeLogListCall.html) -* [cities](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.City.html) - * [*list*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.CityListCall.html) -* [connection types](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.ConnectionType.html) - * [*list*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.ConnectionTypeListCall.html) -* [content categories](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.ContentCategory.html) - * [*delete*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.ContentCategoryDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.ContentCategoryGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.ContentCategoryInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.ContentCategoryListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.ContentCategoryPatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.ContentCategoryUpdateCall.html) -* [countries](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.Country.html) - * [*get*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.CountryGetCall.html) and [*list*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.CountryListCall.html) -* [creative assets](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.CreativeAsset.html) - * [*insert*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.CreativeAssetInsertCall.html) -* [creative field values](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.CreativeFieldValue.html) - * [*delete*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.CreativeFieldValueDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.CreativeFieldValueGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.CreativeFieldValueInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.CreativeFieldValueListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.CreativeFieldValuePatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.CreativeFieldValueUpdateCall.html) -* [creative fields](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.CreativeField.html) - * [*delete*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.CreativeFieldDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.CreativeFieldGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.CreativeFieldInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.CreativeFieldListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.CreativeFieldPatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.CreativeFieldUpdateCall.html) -* [creative groups](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.CreativeGroup.html) - * [*get*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.CreativeGroupGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.CreativeGroupInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.CreativeGroupListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.CreativeGroupPatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.CreativeGroupUpdateCall.html) -* [creatives](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.Creative.html) - * [*get*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.CreativeGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.CreativeInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.CreativeListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.CreativePatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.CreativeUpdateCall.html) -* [dimension values](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.DimensionValue.html) - * [*query*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.DimensionValueQueryCall.html) -* [directory site contacts](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.DirectorySiteContact.html) - * [*get*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.DirectorySiteContactGetCall.html) and [*list*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.DirectorySiteContactListCall.html) -* [directory sites](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.DirectorySite.html) - * [*get*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.DirectorySiteGetCall.html) and [*list*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.DirectorySiteListCall.html) -* [event tags](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.EventTag.html) - * [*delete*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.EventTagDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.EventTagGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.EventTagInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.EventTagListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.EventTagPatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.EventTagUpdateCall.html) -* [files](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.File.html) - * [*get*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.FileGetCall.html) and [*list*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.FileListCall.html) -* [floodlight activities](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.FloodlightActivity.html) - * [*delete*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.FloodlightActivityDeleteCall.html), [*generatetag*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.FloodlightActivityGeneratetagCall.html), [*get*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.FloodlightActivityGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.FloodlightActivityInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.FloodlightActivityListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.FloodlightActivityPatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.FloodlightActivityUpdateCall.html) -* [floodlight activity groups](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.FloodlightActivityGroup.html) - * [*delete*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.FloodlightActivityGroupDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.FloodlightActivityGroupGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.FloodlightActivityGroupInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.FloodlightActivityGroupListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.FloodlightActivityGroupPatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.FloodlightActivityGroupUpdateCall.html) -* [floodlight configurations](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.FloodlightConfiguration.html) - * [*get*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.FloodlightConfigurationGetCall.html), [*list*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.FloodlightConfigurationListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.FloodlightConfigurationPatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.FloodlightConfigurationUpdateCall.html) -* [landing pages](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.LandingPage.html) - * [*delete*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.LandingPageDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.LandingPageGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.LandingPageInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.LandingPageListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.LandingPagePatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.LandingPageUpdateCall.html) -* [metros](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.Metro.html) - * [*list*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.MetroListCall.html) -* [mobile carriers](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.MobileCarrier.html) - * [*list*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.MobileCarrierListCall.html) -* [operating system versions](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.OperatingSystemVersion.html) - * [*list*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.OperatingSystemVersionListCall.html) -* [operating systems](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.OperatingSystem.html) - * [*list*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.OperatingSystemListCall.html) -* [placement groups](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.PlacementGroup.html) - * [*get*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.PlacementGroupGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.PlacementGroupInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.PlacementGroupListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.PlacementGroupPatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.PlacementGroupUpdateCall.html) -* [placement strategies](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.PlacementStrategy.html) - * [*delete*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.PlacementStrategyDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.PlacementStrategyGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.PlacementStrategyInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.PlacementStrategyListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.PlacementStrategyPatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.PlacementStrategyUpdateCall.html) -* [placements](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.Placement.html) - * [*generatetags*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.PlacementGeneratetagCall.html), [*get*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.PlacementGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.PlacementInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.PlacementListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.PlacementPatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.PlacementUpdateCall.html) -* [platform types](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.PlatformType.html) - * [*list*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.PlatformTypeListCall.html) -* [postal codes](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.PostalCode.html) - * [*list*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.PostalCodeListCall.html) -* [regions](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.Region.html) - * [*list*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.RegionListCall.html) -* [reports](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.Report.html) - * [*compatible fields query*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.ReportCompatibleFieldQueryCall.html), [*delete*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.ReportDeleteCall.html), [*files get*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.ReportFileGetCall.html), [*files list*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.ReportFileListCall.html), [*get*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.ReportGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.ReportInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.ReportListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.ReportPatchCall.html), [*run*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.ReportRunCall.html) and [*update*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.ReportUpdateCall.html) -* [sites](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.Site.html) - * [*get*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.SiteGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.SiteInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.SiteListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.SitePatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.SiteUpdateCall.html) -* [sizes](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.Size.html) - * [*get*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.SizeGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.SizeInsertCall.html) and [*list*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.SizeListCall.html) -* [subaccounts](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.Subaccount.html) - * [*get*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.SubaccountGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.SubaccountInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.SubaccountListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.SubaccountPatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.SubaccountUpdateCall.html) -* [user profiles](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.UserProfile.html) - * [*get*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.UserProfileGetCall.html) and [*list*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.UserProfileListCall.html) -* [user role permission groups](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.UserRolePermissionGroup.html) - * [*get*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.UserRolePermissionGroupGetCall.html) and [*list*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.UserRolePermissionGroupListCall.html) -* [user role permissions](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.UserRolePermission.html) - * [*get*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.UserRolePermissionGetCall.html) and [*list*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.UserRolePermissionListCall.html) -* [user roles](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.UserRole.html) - * [*delete*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.UserRoleDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.UserRoleGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.UserRoleInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.UserRoleListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.UserRolePatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.UserRoleUpdateCall.html) +* [account active ad summaries](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.AccountActiveAdSummary.html) + * [*get*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.AccountActiveAdSummaryGetCall.html) +* [account permission groups](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.AccountPermissionGroup.html) + * [*get*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.AccountPermissionGroupGetCall.html) and [*list*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.AccountPermissionGroupListCall.html) +* [account permissions](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.AccountPermission.html) + * [*get*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.AccountPermissionGetCall.html) and [*list*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.AccountPermissionListCall.html) +* [account user profiles](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.AccountUserProfile.html) + * [*get*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.AccountUserProfileGetCall.html), [*list*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.AccountUserProfileListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.AccountUserProfilePatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.AccountUserProfileUpdateCall.html) +* [accounts](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.Account.html) + * [*get*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.AccountGetCall.html), [*list*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.AccountListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.AccountPatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.AccountUpdateCall.html) +* [ads](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.Ad.html) + * [*get*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.AdGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.AdInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.AdListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.AdPatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.AdUpdateCall.html) +* [advertiser groups](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.AdvertiserGroup.html) + * [*delete*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.AdvertiserGroupDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.AdvertiserGroupGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.AdvertiserGroupInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.AdvertiserGroupListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.AdvertiserGroupPatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.AdvertiserGroupUpdateCall.html) +* [advertisers](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.Advertiser.html) + * [*get*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.AdvertiserGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.AdvertiserInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.AdvertiserListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.AdvertiserPatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.AdvertiserUpdateCall.html) +* [browsers](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.Browser.html) + * [*list*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.BrowserListCall.html) +* [campaign creative associations](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.CampaignCreativeAssociation.html) + * [*insert*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.CampaignCreativeAssociationInsertCall.html) and [*list*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.CampaignCreativeAssociationListCall.html) +* [campaigns](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.Campaign.html) + * [*get*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.CampaignGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.CampaignInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.CampaignListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.CampaignPatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.CampaignUpdateCall.html) +* [change logs](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.ChangeLog.html) + * [*get*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.ChangeLogGetCall.html) and [*list*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.ChangeLogListCall.html) +* [cities](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.City.html) + * [*list*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.CityListCall.html) +* [connection types](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.ConnectionType.html) + * [*list*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.ConnectionTypeListCall.html) +* [content categories](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.ContentCategory.html) + * [*delete*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.ContentCategoryDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.ContentCategoryGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.ContentCategoryInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.ContentCategoryListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.ContentCategoryPatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.ContentCategoryUpdateCall.html) +* [countries](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.Country.html) + * [*get*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.CountryGetCall.html) and [*list*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.CountryListCall.html) +* [creative assets](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.CreativeAsset.html) + * [*insert*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.CreativeAssetInsertCall.html) +* [creative field values](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.CreativeFieldValue.html) + * [*delete*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.CreativeFieldValueDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.CreativeFieldValueGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.CreativeFieldValueInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.CreativeFieldValueListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.CreativeFieldValuePatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.CreativeFieldValueUpdateCall.html) +* [creative fields](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.CreativeField.html) + * [*delete*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.CreativeFieldDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.CreativeFieldGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.CreativeFieldInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.CreativeFieldListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.CreativeFieldPatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.CreativeFieldUpdateCall.html) +* [creative groups](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.CreativeGroup.html) + * [*get*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.CreativeGroupGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.CreativeGroupInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.CreativeGroupListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.CreativeGroupPatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.CreativeGroupUpdateCall.html) +* [creatives](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.Creative.html) + * [*get*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.CreativeGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.CreativeInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.CreativeListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.CreativePatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.CreativeUpdateCall.html) +* [dimension values](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.DimensionValue.html) + * [*query*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.DimensionValueQueryCall.html) +* [directory site contacts](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.DirectorySiteContact.html) + * [*get*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.DirectorySiteContactGetCall.html) and [*list*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.DirectorySiteContactListCall.html) +* [directory sites](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.DirectorySite.html) + * [*get*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.DirectorySiteGetCall.html) and [*list*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.DirectorySiteListCall.html) +* [event tags](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.EventTag.html) + * [*delete*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.EventTagDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.EventTagGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.EventTagInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.EventTagListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.EventTagPatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.EventTagUpdateCall.html) +* [files](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.File.html) + * [*get*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.FileGetCall.html) and [*list*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.FileListCall.html) +* [floodlight activities](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.FloodlightActivity.html) + * [*delete*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.FloodlightActivityDeleteCall.html), [*generatetag*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.FloodlightActivityGeneratetagCall.html), [*get*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.FloodlightActivityGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.FloodlightActivityInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.FloodlightActivityListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.FloodlightActivityPatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.FloodlightActivityUpdateCall.html) +* [floodlight activity groups](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.FloodlightActivityGroup.html) + * [*delete*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.FloodlightActivityGroupDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.FloodlightActivityGroupGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.FloodlightActivityGroupInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.FloodlightActivityGroupListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.FloodlightActivityGroupPatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.FloodlightActivityGroupUpdateCall.html) +* [floodlight configurations](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.FloodlightConfiguration.html) + * [*get*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.FloodlightConfigurationGetCall.html), [*list*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.FloodlightConfigurationListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.FloodlightConfigurationPatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.FloodlightConfigurationUpdateCall.html) +* [landing pages](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.LandingPage.html) + * [*delete*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.LandingPageDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.LandingPageGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.LandingPageInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.LandingPageListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.LandingPagePatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.LandingPageUpdateCall.html) +* [metros](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.Metro.html) + * [*list*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.MetroListCall.html) +* [mobile carriers](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.MobileCarrier.html) + * [*list*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.MobileCarrierListCall.html) +* [operating system versions](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.OperatingSystemVersion.html) + * [*list*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.OperatingSystemVersionListCall.html) +* [operating systems](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.OperatingSystem.html) + * [*list*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.OperatingSystemListCall.html) +* [placement groups](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.PlacementGroup.html) + * [*get*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.PlacementGroupGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.PlacementGroupInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.PlacementGroupListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.PlacementGroupPatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.PlacementGroupUpdateCall.html) +* [placement strategies](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.PlacementStrategy.html) + * [*delete*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.PlacementStrategyDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.PlacementStrategyGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.PlacementStrategyInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.PlacementStrategyListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.PlacementStrategyPatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.PlacementStrategyUpdateCall.html) +* [placements](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.Placement.html) + * [*generatetags*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.PlacementGeneratetagCall.html), [*get*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.PlacementGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.PlacementInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.PlacementListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.PlacementPatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.PlacementUpdateCall.html) +* [platform types](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.PlatformType.html) + * [*list*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.PlatformTypeListCall.html) +* [postal codes](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.PostalCode.html) + * [*list*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.PostalCodeListCall.html) +* [regions](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.Region.html) + * [*list*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.RegionListCall.html) +* [reports](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.Report.html) + * [*compatible fields query*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.ReportCompatibleFieldQueryCall.html), [*delete*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.ReportDeleteCall.html), [*files get*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.ReportFileGetCall.html), [*files list*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.ReportFileListCall.html), [*get*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.ReportGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.ReportInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.ReportListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.ReportPatchCall.html), [*run*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.ReportRunCall.html) and [*update*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.ReportUpdateCall.html) +* [sites](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.Site.html) + * [*get*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.SiteGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.SiteInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.SiteListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.SitePatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.SiteUpdateCall.html) +* [sizes](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.Size.html) + * [*get*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.SizeGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.SizeInsertCall.html) and [*list*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.SizeListCall.html) +* [subaccounts](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.Subaccount.html) + * [*get*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.SubaccountGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.SubaccountInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.SubaccountListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.SubaccountPatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.SubaccountUpdateCall.html) +* [user profiles](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.UserProfile.html) + * [*get*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.UserProfileGetCall.html) and [*list*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.UserProfileListCall.html) +* [user role permission groups](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.UserRolePermissionGroup.html) + * [*get*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.UserRolePermissionGroupGetCall.html) and [*list*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.UserRolePermissionGroupListCall.html) +* [user role permissions](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.UserRolePermission.html) + * [*get*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.UserRolePermissionGetCall.html) and [*list*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.UserRolePermissionListCall.html) +* [user roles](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.UserRole.html) + * [*delete*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.UserRoleDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.UserRoleGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.UserRoleInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.UserRoleListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.UserRolePatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.UserRoleUpdateCall.html) Upload supported by ... -* [*insert creative assets*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.CreativeAssetInsertCall.html) +* [*insert creative assets*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.CreativeAssetInsertCall.html) Download supported by ... -* [*get files*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.FileGetCall.html) -* [*files get reports*](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.ReportFileGetCall.html) +* [*get files*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.FileGetCall.html) +* [*files get reports*](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.ReportFileGetCall.html) @@ -126,17 +126,17 @@ Download supported by ... The API is structured into the following primary items: -* **[Hub](http://byron.github.io/google-apis-rs/google-dfareporting2/struct.Dfareporting.html)** +* **[Hub](http://byron.github.io/google-apis-rs/google_dfareporting2/struct.Dfareporting.html)** * a central object to maintain state and allow accessing all *Activities* - * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google-dfareporting2/trait.MethodsBuilder.html) which in turn - allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google-dfareporting2/trait.CallBuilder.html) -* **[Resources](http://byron.github.io/google-apis-rs/google-dfareporting2/trait.Resource.html)** + * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google_dfareporting2/trait.MethodsBuilder.html) which in turn + allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google_dfareporting2/trait.CallBuilder.html) +* **[Resources](http://byron.github.io/google-apis-rs/google_dfareporting2/trait.Resource.html)** * primary types that you can apply *Activities* to * a collection of properties and *Parts* - * **[Parts](http://byron.github.io/google-apis-rs/google-dfareporting2/trait.Part.html)** + * **[Parts](http://byron.github.io/google-apis-rs/google_dfareporting2/trait.Part.html)** * a collection of properties * never directly used in *Activities* -* **[Activities](http://byron.github.io/google-apis-rs/google-dfareporting2/trait.CallBuilder.html)** +* **[Activities](http://byron.github.io/google-apis-rs/google_dfareporting2/trait.CallBuilder.html)** * operations to apply to *Resources* All *structures* are marked with applicable traits to further categorize them and ease browsing. @@ -229,17 +229,17 @@ match result { ``` ## Handling Errors -All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google-dfareporting2/enum.Result.html) enumeration as return value of +All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google_dfareporting2/enum.Result.html) enumeration as return value of the doit() methods, or handed as possibly intermediate results to either the -[Hub Delegate](http://byron.github.io/google-apis-rs/google-dfareporting2/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google-dfareporting2/../yup-oauth2/trait.AuthenticatorDelegate.html). +[Hub Delegate](http://byron.github.io/google-apis-rs/google_dfareporting2/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google_dfareporting2/../yup-oauth2/trait.AuthenticatorDelegate.html). 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](http://byron.github.io/google-apis-rs/google-dfareporting2/enum.Result.html), should be +If a method supports downloads, the response body, which is part of the [Result](http://byron.github.io/google-apis-rs/google_dfareporting2/enum.Result.html), should be read by you to obtain the media. -If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google-dfareporting2/trait.ResponseResult.html), it will return that by default. +If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google_dfareporting2/trait.ResponseResult.html), 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")`. @@ -249,29 +249,29 @@ Methods supporting uploads can do so using up to 2 different protocols: ## Customization and Callbacks -You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google-dfareporting2/trait.Delegate.html) to the -[Method Builder](http://byron.github.io/google-apis-rs/google-dfareporting2/trait.CallBuilder.html) before making the final `doit()` call. +You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google_dfareporting2/trait.Delegate.html) to the +[Method Builder](http://byron.github.io/google-apis-rs/google_dfareporting2/trait.CallBuilder.html) 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](http://byron.github.io/google-apis-rs/google-dfareporting2/trait.Delegate.html) is default-implemented, allowing you to customize it with minimal effort. +The [delegate trait](http://byron.github.io/google-apis-rs/google_dfareporting2/trait.Delegate.html) 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](http://byron.github.io/google-apis-rs/google-dfareporting2/trait.RequestValue.html) and -[decodable](http://byron.github.io/google-apis-rs/google-dfareporting2/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses +All structures provided by this library are made to be [enocodable](http://byron.github.io/google-apis-rs/google_dfareporting2/trait.RequestValue.html) and +[decodable](http://byron.github.io/google-apis-rs/google_dfareporting2/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses are valid. -Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google-dfareporting2/trait.Part.html) which are identifiable by name, which will be sent to +Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google_dfareporting2/trait.Part.html) 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](http://byron.github.io/google-apis-rs/google-dfareporting2/trait.CallBuilder.html), you are able to prepare an action call by repeatedly calling it's methods. +Using [method builders](http://byron.github.io/google-apis-rs/google_dfareporting2/trait.CallBuilder.html), 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][wiki-pod] are handed by copy * strings are passed as `&str` -* [request values](http://byron.github.io/google-apis-rs/google-dfareporting2/trait.RequestValue.html) are borrowed +* [request values](http://byron.github.io/google-apis-rs/google_dfareporting2/trait.RequestValue.html) are borrowed Arguments will always be copied or cloned into the builder, to make them independent of their original life times. diff --git a/gen/discovery1/README.md b/gen/discovery1/README.md index 8c726132ff..990169f329 100644 --- a/gen/discovery1/README.md +++ b/gen/discovery1/README.md @@ -11,10 +11,10 @@ Everything else about the *discovery* *v1* API can be found at the [official documentation site](https://developers.google.com/discovery/). # Features -Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google-discovery1/struct.Discovery.html) ... +Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google_discovery1/struct.Discovery.html) ... * apis - * [*get rest*](http://byron.github.io/google-apis-rs/google-discovery1/struct.ApiGetRestCall.html) and [*list*](http://byron.github.io/google-apis-rs/google-discovery1/struct.ApiListCall.html) + * [*get rest*](http://byron.github.io/google-apis-rs/google_discovery1/struct.ApiGetRestCall.html) and [*list*](http://byron.github.io/google-apis-rs/google_discovery1/struct.ApiListCall.html) @@ -23,17 +23,17 @@ Handle the following *Resources* with ease from the central [hub](http://byron.g The API is structured into the following primary items: -* **[Hub](http://byron.github.io/google-apis-rs/google-discovery1/struct.Discovery.html)** +* **[Hub](http://byron.github.io/google-apis-rs/google_discovery1/struct.Discovery.html)** * a central object to maintain state and allow accessing all *Activities* - * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google-discovery1/trait.MethodsBuilder.html) which in turn - allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google-discovery1/trait.CallBuilder.html) -* **[Resources](http://byron.github.io/google-apis-rs/google-discovery1/trait.Resource.html)** + * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google_discovery1/trait.MethodsBuilder.html) which in turn + allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google_discovery1/trait.CallBuilder.html) +* **[Resources](http://byron.github.io/google-apis-rs/google_discovery1/trait.Resource.html)** * primary types that you can apply *Activities* to * a collection of properties and *Parts* - * **[Parts](http://byron.github.io/google-apis-rs/google-discovery1/trait.Part.html)** + * **[Parts](http://byron.github.io/google-apis-rs/google_discovery1/trait.Part.html)** * a collection of properties * never directly used in *Activities* -* **[Activities](http://byron.github.io/google-apis-rs/google-discovery1/trait.CallBuilder.html)** +* **[Activities](http://byron.github.io/google-apis-rs/google_discovery1/trait.CallBuilder.html)** * operations to apply to *Resources* All *structures* are marked with applicable traits to further categorize them and ease browsing. @@ -112,17 +112,17 @@ match result { ``` ## Handling Errors -All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google-discovery1/enum.Result.html) enumeration as return value of +All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google_discovery1/enum.Result.html) enumeration as return value of the doit() methods, or handed as possibly intermediate results to either the -[Hub Delegate](http://byron.github.io/google-apis-rs/google-discovery1/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google-discovery1/../yup-oauth2/trait.AuthenticatorDelegate.html). +[Hub Delegate](http://byron.github.io/google-apis-rs/google_discovery1/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google_discovery1/../yup-oauth2/trait.AuthenticatorDelegate.html). 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](http://byron.github.io/google-apis-rs/google-discovery1/enum.Result.html), should be +If a method supports downloads, the response body, which is part of the [Result](http://byron.github.io/google-apis-rs/google_discovery1/enum.Result.html), should be read by you to obtain the media. -If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google-discovery1/trait.ResponseResult.html), it will return that by default. +If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google_discovery1/trait.ResponseResult.html), 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")`. @@ -132,29 +132,29 @@ Methods supporting uploads can do so using up to 2 different protocols: ## Customization and Callbacks -You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google-discovery1/trait.Delegate.html) to the -[Method Builder](http://byron.github.io/google-apis-rs/google-discovery1/trait.CallBuilder.html) before making the final `doit()` call. +You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google_discovery1/trait.Delegate.html) to the +[Method Builder](http://byron.github.io/google-apis-rs/google_discovery1/trait.CallBuilder.html) 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](http://byron.github.io/google-apis-rs/google-discovery1/trait.Delegate.html) is default-implemented, allowing you to customize it with minimal effort. +The [delegate trait](http://byron.github.io/google-apis-rs/google_discovery1/trait.Delegate.html) 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](http://byron.github.io/google-apis-rs/google-discovery1/trait.RequestValue.html) and -[decodable](http://byron.github.io/google-apis-rs/google-discovery1/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses +All structures provided by this library are made to be [enocodable](http://byron.github.io/google-apis-rs/google_discovery1/trait.RequestValue.html) and +[decodable](http://byron.github.io/google-apis-rs/google_discovery1/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses are valid. -Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google-discovery1/trait.Part.html) which are identifiable by name, which will be sent to +Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google_discovery1/trait.Part.html) 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](http://byron.github.io/google-apis-rs/google-discovery1/trait.CallBuilder.html), you are able to prepare an action call by repeatedly calling it's methods. +Using [method builders](http://byron.github.io/google-apis-rs/google_discovery1/trait.CallBuilder.html), 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][wiki-pod] are handed by copy * strings are passed as `&str` -* [request values](http://byron.github.io/google-apis-rs/google-discovery1/trait.RequestValue.html) are borrowed +* [request values](http://byron.github.io/google-apis-rs/google_discovery1/trait.RequestValue.html) are borrowed Arguments will always be copied or cloned into the builder, to make them independent of their original life times. diff --git a/gen/dns1_beta1/README.md b/gen/dns1_beta1/README.md index 1c47842e4d..6c27b44d42 100644 --- a/gen/dns1_beta1/README.md +++ b/gen/dns1_beta1/README.md @@ -11,16 +11,16 @@ Everything else about the *dns* *v1_beta1* API can be found at the [official documentation site](https://developers.google.com/cloud-dns). # Features -Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google-dns1_beta1/struct.Dns.html) ... +Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google_dns1_beta1/struct.Dns.html) ... -* [changes](http://byron.github.io/google-apis-rs/google-dns1_beta1/struct.Change.html) - * [*create*](http://byron.github.io/google-apis-rs/google-dns1_beta1/struct.ChangeCreateCall.html), [*get*](http://byron.github.io/google-apis-rs/google-dns1_beta1/struct.ChangeGetCall.html) and [*list*](http://byron.github.io/google-apis-rs/google-dns1_beta1/struct.ChangeListCall.html) -* [managed zones](http://byron.github.io/google-apis-rs/google-dns1_beta1/struct.ManagedZone.html) - * [*create*](http://byron.github.io/google-apis-rs/google-dns1_beta1/struct.ManagedZoneCreateCall.html), [*delete*](http://byron.github.io/google-apis-rs/google-dns1_beta1/struct.ManagedZoneDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google-dns1_beta1/struct.ManagedZoneGetCall.html) and [*list*](http://byron.github.io/google-apis-rs/google-dns1_beta1/struct.ManagedZoneListCall.html) -* [projects](http://byron.github.io/google-apis-rs/google-dns1_beta1/struct.Project.html) - * [*get*](http://byron.github.io/google-apis-rs/google-dns1_beta1/struct.ProjectGetCall.html) -* [resource record sets](http://byron.github.io/google-apis-rs/google-dns1_beta1/struct.ResourceRecordSet.html) - * [*list*](http://byron.github.io/google-apis-rs/google-dns1_beta1/struct.ResourceRecordSetListCall.html) +* [changes](http://byron.github.io/google-apis-rs/google_dns1_beta1/struct.Change.html) + * [*create*](http://byron.github.io/google-apis-rs/google_dns1_beta1/struct.ChangeCreateCall.html), [*get*](http://byron.github.io/google-apis-rs/google_dns1_beta1/struct.ChangeGetCall.html) and [*list*](http://byron.github.io/google-apis-rs/google_dns1_beta1/struct.ChangeListCall.html) +* [managed zones](http://byron.github.io/google-apis-rs/google_dns1_beta1/struct.ManagedZone.html) + * [*create*](http://byron.github.io/google-apis-rs/google_dns1_beta1/struct.ManagedZoneCreateCall.html), [*delete*](http://byron.github.io/google-apis-rs/google_dns1_beta1/struct.ManagedZoneDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google_dns1_beta1/struct.ManagedZoneGetCall.html) and [*list*](http://byron.github.io/google-apis-rs/google_dns1_beta1/struct.ManagedZoneListCall.html) +* [projects](http://byron.github.io/google-apis-rs/google_dns1_beta1/struct.Project.html) + * [*get*](http://byron.github.io/google-apis-rs/google_dns1_beta1/struct.ProjectGetCall.html) +* [resource record sets](http://byron.github.io/google-apis-rs/google_dns1_beta1/struct.ResourceRecordSet.html) + * [*list*](http://byron.github.io/google-apis-rs/google_dns1_beta1/struct.ResourceRecordSetListCall.html) @@ -29,17 +29,17 @@ Handle the following *Resources* with ease from the central [hub](http://byron.g The API is structured into the following primary items: -* **[Hub](http://byron.github.io/google-apis-rs/google-dns1_beta1/struct.Dns.html)** +* **[Hub](http://byron.github.io/google-apis-rs/google_dns1_beta1/struct.Dns.html)** * a central object to maintain state and allow accessing all *Activities* - * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google-dns1_beta1/trait.MethodsBuilder.html) which in turn - allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google-dns1_beta1/trait.CallBuilder.html) -* **[Resources](http://byron.github.io/google-apis-rs/google-dns1_beta1/trait.Resource.html)** + * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google_dns1_beta1/trait.MethodsBuilder.html) which in turn + allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google_dns1_beta1/trait.CallBuilder.html) +* **[Resources](http://byron.github.io/google-apis-rs/google_dns1_beta1/trait.Resource.html)** * primary types that you can apply *Activities* to * a collection of properties and *Parts* - * **[Parts](http://byron.github.io/google-apis-rs/google-dns1_beta1/trait.Part.html)** + * **[Parts](http://byron.github.io/google-apis-rs/google_dns1_beta1/trait.Part.html)** * a collection of properties * never directly used in *Activities* -* **[Activities](http://byron.github.io/google-apis-rs/google-dns1_beta1/trait.CallBuilder.html)** +* **[Activities](http://byron.github.io/google-apis-rs/google_dns1_beta1/trait.CallBuilder.html)** * operations to apply to *Resources* All *structures* are marked with applicable traits to further categorize them and ease browsing. @@ -123,17 +123,17 @@ match result { ``` ## Handling Errors -All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google-dns1_beta1/enum.Result.html) enumeration as return value of +All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google_dns1_beta1/enum.Result.html) enumeration as return value of the doit() methods, or handed as possibly intermediate results to either the -[Hub Delegate](http://byron.github.io/google-apis-rs/google-dns1_beta1/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google-dns1_beta1/../yup-oauth2/trait.AuthenticatorDelegate.html). +[Hub Delegate](http://byron.github.io/google-apis-rs/google_dns1_beta1/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google_dns1_beta1/../yup-oauth2/trait.AuthenticatorDelegate.html). 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](http://byron.github.io/google-apis-rs/google-dns1_beta1/enum.Result.html), should be +If a method supports downloads, the response body, which is part of the [Result](http://byron.github.io/google-apis-rs/google_dns1_beta1/enum.Result.html), should be read by you to obtain the media. -If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google-dns1_beta1/trait.ResponseResult.html), it will return that by default. +If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google_dns1_beta1/trait.ResponseResult.html), 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")`. @@ -143,29 +143,29 @@ Methods supporting uploads can do so using up to 2 different protocols: ## Customization and Callbacks -You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google-dns1_beta1/trait.Delegate.html) to the -[Method Builder](http://byron.github.io/google-apis-rs/google-dns1_beta1/trait.CallBuilder.html) before making the final `doit()` call. +You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google_dns1_beta1/trait.Delegate.html) to the +[Method Builder](http://byron.github.io/google-apis-rs/google_dns1_beta1/trait.CallBuilder.html) 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](http://byron.github.io/google-apis-rs/google-dns1_beta1/trait.Delegate.html) is default-implemented, allowing you to customize it with minimal effort. +The [delegate trait](http://byron.github.io/google-apis-rs/google_dns1_beta1/trait.Delegate.html) 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](http://byron.github.io/google-apis-rs/google-dns1_beta1/trait.RequestValue.html) and -[decodable](http://byron.github.io/google-apis-rs/google-dns1_beta1/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses +All structures provided by this library are made to be [enocodable](http://byron.github.io/google-apis-rs/google_dns1_beta1/trait.RequestValue.html) and +[decodable](http://byron.github.io/google-apis-rs/google_dns1_beta1/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses are valid. -Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google-dns1_beta1/trait.Part.html) which are identifiable by name, which will be sent to +Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google_dns1_beta1/trait.Part.html) 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](http://byron.github.io/google-apis-rs/google-dns1_beta1/trait.CallBuilder.html), you are able to prepare an action call by repeatedly calling it's methods. +Using [method builders](http://byron.github.io/google-apis-rs/google_dns1_beta1/trait.CallBuilder.html), 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][wiki-pod] are handed by copy * strings are passed as `&str` -* [request values](http://byron.github.io/google-apis-rs/google-dns1_beta1/trait.RequestValue.html) are borrowed +* [request values](http://byron.github.io/google-apis-rs/google_dns1_beta1/trait.RequestValue.html) are borrowed Arguments will always be copied or cloned into the builder, to make them independent of their original life times. diff --git a/gen/doubleclickbidmanager1/README.md b/gen/doubleclickbidmanager1/README.md index fff4890e76..df2354706e 100644 --- a/gen/doubleclickbidmanager1/README.md +++ b/gen/doubleclickbidmanager1/README.md @@ -11,14 +11,14 @@ Everything else about the *DoubleClick Bid Manager* *v1* API can be found at the [official documentation site](https://developers.google.com/bid-manager/). # Features -Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google-doubleclickbidmanager1/struct.DoubleClickBidManager.html) ... +Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google_doubleclickbidmanager1/struct.DoubleClickBidManager.html) ... * lineitems - * [*downloadlineitems*](http://byron.github.io/google-apis-rs/google-doubleclickbidmanager1/struct.LineitemDownloadlineitemCall.html) and [*uploadlineitems*](http://byron.github.io/google-apis-rs/google-doubleclickbidmanager1/struct.LineitemUploadlineitemCall.html) -* [queries](http://byron.github.io/google-apis-rs/google-doubleclickbidmanager1/struct.Query.html) - * [*createquery*](http://byron.github.io/google-apis-rs/google-doubleclickbidmanager1/struct.QueryCreatequeryCall.html), [*deletequery*](http://byron.github.io/google-apis-rs/google-doubleclickbidmanager1/struct.QueryDeletequeryCall.html), [*getquery*](http://byron.github.io/google-apis-rs/google-doubleclickbidmanager1/struct.QueryGetqueryCall.html), [*listqueries*](http://byron.github.io/google-apis-rs/google-doubleclickbidmanager1/struct.QueryListqueryCall.html) and [*runquery*](http://byron.github.io/google-apis-rs/google-doubleclickbidmanager1/struct.QueryRunqueryCall.html) -* [reports](http://byron.github.io/google-apis-rs/google-doubleclickbidmanager1/struct.Report.html) - * [*listreports*](http://byron.github.io/google-apis-rs/google-doubleclickbidmanager1/struct.ReportListreportCall.html) + * [*downloadlineitems*](http://byron.github.io/google-apis-rs/google_doubleclickbidmanager1/struct.LineitemDownloadlineitemCall.html) and [*uploadlineitems*](http://byron.github.io/google-apis-rs/google_doubleclickbidmanager1/struct.LineitemUploadlineitemCall.html) +* [queries](http://byron.github.io/google-apis-rs/google_doubleclickbidmanager1/struct.Query.html) + * [*createquery*](http://byron.github.io/google-apis-rs/google_doubleclickbidmanager1/struct.QueryCreatequeryCall.html), [*deletequery*](http://byron.github.io/google-apis-rs/google_doubleclickbidmanager1/struct.QueryDeletequeryCall.html), [*getquery*](http://byron.github.io/google-apis-rs/google_doubleclickbidmanager1/struct.QueryGetqueryCall.html), [*listqueries*](http://byron.github.io/google-apis-rs/google_doubleclickbidmanager1/struct.QueryListqueryCall.html) and [*runquery*](http://byron.github.io/google-apis-rs/google_doubleclickbidmanager1/struct.QueryRunqueryCall.html) +* [reports](http://byron.github.io/google-apis-rs/google_doubleclickbidmanager1/struct.Report.html) + * [*listreports*](http://byron.github.io/google-apis-rs/google_doubleclickbidmanager1/struct.ReportListreportCall.html) @@ -27,17 +27,17 @@ Handle the following *Resources* with ease from the central [hub](http://byron.g The API is structured into the following primary items: -* **[Hub](http://byron.github.io/google-apis-rs/google-doubleclickbidmanager1/struct.DoubleClickBidManager.html)** +* **[Hub](http://byron.github.io/google-apis-rs/google_doubleclickbidmanager1/struct.DoubleClickBidManager.html)** * a central object to maintain state and allow accessing all *Activities* - * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google-doubleclickbidmanager1/trait.MethodsBuilder.html) which in turn - allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google-doubleclickbidmanager1/trait.CallBuilder.html) -* **[Resources](http://byron.github.io/google-apis-rs/google-doubleclickbidmanager1/trait.Resource.html)** + * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google_doubleclickbidmanager1/trait.MethodsBuilder.html) which in turn + allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google_doubleclickbidmanager1/trait.CallBuilder.html) +* **[Resources](http://byron.github.io/google-apis-rs/google_doubleclickbidmanager1/trait.Resource.html)** * primary types that you can apply *Activities* to * a collection of properties and *Parts* - * **[Parts](http://byron.github.io/google-apis-rs/google-doubleclickbidmanager1/trait.Part.html)** + * **[Parts](http://byron.github.io/google-apis-rs/google_doubleclickbidmanager1/trait.Part.html)** * a collection of properties * never directly used in *Activities* -* **[Activities](http://byron.github.io/google-apis-rs/google-doubleclickbidmanager1/trait.CallBuilder.html)** +* **[Activities](http://byron.github.io/google-apis-rs/google_doubleclickbidmanager1/trait.CallBuilder.html)** * operations to apply to *Resources* All *structures* are marked with applicable traits to further categorize them and ease browsing. @@ -117,17 +117,17 @@ match result { ``` ## Handling Errors -All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google-doubleclickbidmanager1/enum.Result.html) enumeration as return value of +All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google_doubleclickbidmanager1/enum.Result.html) enumeration as return value of the doit() methods, or handed as possibly intermediate results to either the -[Hub Delegate](http://byron.github.io/google-apis-rs/google-doubleclickbidmanager1/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google-doubleclickbidmanager1/../yup-oauth2/trait.AuthenticatorDelegate.html). +[Hub Delegate](http://byron.github.io/google-apis-rs/google_doubleclickbidmanager1/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google_doubleclickbidmanager1/../yup-oauth2/trait.AuthenticatorDelegate.html). 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](http://byron.github.io/google-apis-rs/google-doubleclickbidmanager1/enum.Result.html), should be +If a method supports downloads, the response body, which is part of the [Result](http://byron.github.io/google-apis-rs/google_doubleclickbidmanager1/enum.Result.html), should be read by you to obtain the media. -If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google-doubleclickbidmanager1/trait.ResponseResult.html), it will return that by default. +If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google_doubleclickbidmanager1/trait.ResponseResult.html), 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")`. @@ -137,29 +137,29 @@ Methods supporting uploads can do so using up to 2 different protocols: ## Customization and Callbacks -You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google-doubleclickbidmanager1/trait.Delegate.html) to the -[Method Builder](http://byron.github.io/google-apis-rs/google-doubleclickbidmanager1/trait.CallBuilder.html) before making the final `doit()` call. +You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google_doubleclickbidmanager1/trait.Delegate.html) to the +[Method Builder](http://byron.github.io/google-apis-rs/google_doubleclickbidmanager1/trait.CallBuilder.html) 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](http://byron.github.io/google-apis-rs/google-doubleclickbidmanager1/trait.Delegate.html) is default-implemented, allowing you to customize it with minimal effort. +The [delegate trait](http://byron.github.io/google-apis-rs/google_doubleclickbidmanager1/trait.Delegate.html) 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](http://byron.github.io/google-apis-rs/google-doubleclickbidmanager1/trait.RequestValue.html) and -[decodable](http://byron.github.io/google-apis-rs/google-doubleclickbidmanager1/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses +All structures provided by this library are made to be [enocodable](http://byron.github.io/google-apis-rs/google_doubleclickbidmanager1/trait.RequestValue.html) and +[decodable](http://byron.github.io/google-apis-rs/google_doubleclickbidmanager1/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses are valid. -Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google-doubleclickbidmanager1/trait.Part.html) which are identifiable by name, which will be sent to +Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google_doubleclickbidmanager1/trait.Part.html) 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](http://byron.github.io/google-apis-rs/google-doubleclickbidmanager1/trait.CallBuilder.html), you are able to prepare an action call by repeatedly calling it's methods. +Using [method builders](http://byron.github.io/google-apis-rs/google_doubleclickbidmanager1/trait.CallBuilder.html), 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][wiki-pod] are handed by copy * strings are passed as `&str` -* [request values](http://byron.github.io/google-apis-rs/google-doubleclickbidmanager1/trait.RequestValue.html) are borrowed +* [request values](http://byron.github.io/google-apis-rs/google_doubleclickbidmanager1/trait.RequestValue.html) are borrowed Arguments will always be copied or cloned into the builder, to make them independent of their original life times. diff --git a/gen/doubleclicksearch2/README.md b/gen/doubleclicksearch2/README.md index ab62725bef..f9caba4d73 100644 --- a/gen/doubleclicksearch2/README.md +++ b/gen/doubleclicksearch2/README.md @@ -11,19 +11,19 @@ Everything else about the *doubleclicksearch* *v2* API can be found at the [official documentation site](https://developers.google.com/doubleclick-search/). # Features -Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google-doubleclicksearch2/struct.Doubleclicksearch.html) ... +Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google_doubleclicksearch2/struct.Doubleclicksearch.html) ... -* [conversion](http://byron.github.io/google-apis-rs/google-doubleclicksearch2/struct.Conversion.html) - * [*get*](http://byron.github.io/google-apis-rs/google-doubleclicksearch2/struct.ConversionGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google-doubleclicksearch2/struct.ConversionInsertCall.html), [*patch*](http://byron.github.io/google-apis-rs/google-doubleclicksearch2/struct.ConversionPatchCall.html), [*update*](http://byron.github.io/google-apis-rs/google-doubleclicksearch2/struct.ConversionUpdateCall.html) and [*update availability*](http://byron.github.io/google-apis-rs/google-doubleclicksearch2/struct.ConversionUpdateAvailabilityCall.html) -* [reports](http://byron.github.io/google-apis-rs/google-doubleclicksearch2/struct.Report.html) - * [*generate*](http://byron.github.io/google-apis-rs/google-doubleclicksearch2/struct.ReportGenerateCall.html), [*get*](http://byron.github.io/google-apis-rs/google-doubleclicksearch2/struct.ReportGetCall.html), [*get file*](http://byron.github.io/google-apis-rs/google-doubleclicksearch2/struct.ReportGetFileCall.html) and [*request*](http://byron.github.io/google-apis-rs/google-doubleclicksearch2/struct.ReportRequestCall.html) -* [saved columns](http://byron.github.io/google-apis-rs/google-doubleclicksearch2/struct.SavedColumn.html) - * [*list*](http://byron.github.io/google-apis-rs/google-doubleclicksearch2/struct.SavedColumnListCall.html) +* [conversion](http://byron.github.io/google-apis-rs/google_doubleclicksearch2/struct.Conversion.html) + * [*get*](http://byron.github.io/google-apis-rs/google_doubleclicksearch2/struct.ConversionGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google_doubleclicksearch2/struct.ConversionInsertCall.html), [*patch*](http://byron.github.io/google-apis-rs/google_doubleclicksearch2/struct.ConversionPatchCall.html), [*update*](http://byron.github.io/google-apis-rs/google_doubleclicksearch2/struct.ConversionUpdateCall.html) and [*update availability*](http://byron.github.io/google-apis-rs/google_doubleclicksearch2/struct.ConversionUpdateAvailabilityCall.html) +* [reports](http://byron.github.io/google-apis-rs/google_doubleclicksearch2/struct.Report.html) + * [*generate*](http://byron.github.io/google-apis-rs/google_doubleclicksearch2/struct.ReportGenerateCall.html), [*get*](http://byron.github.io/google-apis-rs/google_doubleclicksearch2/struct.ReportGetCall.html), [*get file*](http://byron.github.io/google-apis-rs/google_doubleclicksearch2/struct.ReportGetFileCall.html) and [*request*](http://byron.github.io/google-apis-rs/google_doubleclicksearch2/struct.ReportRequestCall.html) +* [saved columns](http://byron.github.io/google-apis-rs/google_doubleclicksearch2/struct.SavedColumn.html) + * [*list*](http://byron.github.io/google-apis-rs/google_doubleclicksearch2/struct.SavedColumnListCall.html) Download supported by ... -* [*get file reports*](http://byron.github.io/google-apis-rs/google-doubleclicksearch2/struct.ReportGetFileCall.html) +* [*get file reports*](http://byron.github.io/google-apis-rs/google_doubleclicksearch2/struct.ReportGetFileCall.html) @@ -31,17 +31,17 @@ Download supported by ... The API is structured into the following primary items: -* **[Hub](http://byron.github.io/google-apis-rs/google-doubleclicksearch2/struct.Doubleclicksearch.html)** +* **[Hub](http://byron.github.io/google-apis-rs/google_doubleclicksearch2/struct.Doubleclicksearch.html)** * a central object to maintain state and allow accessing all *Activities* - * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google-doubleclicksearch2/trait.MethodsBuilder.html) which in turn - allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google-doubleclicksearch2/trait.CallBuilder.html) -* **[Resources](http://byron.github.io/google-apis-rs/google-doubleclicksearch2/trait.Resource.html)** + * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google_doubleclicksearch2/trait.MethodsBuilder.html) which in turn + allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google_doubleclicksearch2/trait.CallBuilder.html) +* **[Resources](http://byron.github.io/google-apis-rs/google_doubleclicksearch2/trait.Resource.html)** * primary types that you can apply *Activities* to * a collection of properties and *Parts* - * **[Parts](http://byron.github.io/google-apis-rs/google-doubleclicksearch2/trait.Part.html)** + * **[Parts](http://byron.github.io/google-apis-rs/google_doubleclicksearch2/trait.Part.html)** * a collection of properties * never directly used in *Activities* -* **[Activities](http://byron.github.io/google-apis-rs/google-doubleclicksearch2/trait.CallBuilder.html)** +* **[Activities](http://byron.github.io/google-apis-rs/google_doubleclicksearch2/trait.CallBuilder.html)** * operations to apply to *Resources* All *structures* are marked with applicable traits to further categorize them and ease browsing. @@ -123,17 +123,17 @@ match result { ``` ## Handling Errors -All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google-doubleclicksearch2/enum.Result.html) enumeration as return value of +All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google_doubleclicksearch2/enum.Result.html) enumeration as return value of the doit() methods, or handed as possibly intermediate results to either the -[Hub Delegate](http://byron.github.io/google-apis-rs/google-doubleclicksearch2/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google-doubleclicksearch2/../yup-oauth2/trait.AuthenticatorDelegate.html). +[Hub Delegate](http://byron.github.io/google-apis-rs/google_doubleclicksearch2/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google_doubleclicksearch2/../yup-oauth2/trait.AuthenticatorDelegate.html). 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](http://byron.github.io/google-apis-rs/google-doubleclicksearch2/enum.Result.html), should be +If a method supports downloads, the response body, which is part of the [Result](http://byron.github.io/google-apis-rs/google_doubleclicksearch2/enum.Result.html), should be read by you to obtain the media. -If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google-doubleclicksearch2/trait.ResponseResult.html), it will return that by default. +If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google_doubleclicksearch2/trait.ResponseResult.html), 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")`. @@ -143,29 +143,29 @@ Methods supporting uploads can do so using up to 2 different protocols: ## Customization and Callbacks -You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google-doubleclicksearch2/trait.Delegate.html) to the -[Method Builder](http://byron.github.io/google-apis-rs/google-doubleclicksearch2/trait.CallBuilder.html) before making the final `doit()` call. +You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google_doubleclicksearch2/trait.Delegate.html) to the +[Method Builder](http://byron.github.io/google-apis-rs/google_doubleclicksearch2/trait.CallBuilder.html) 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](http://byron.github.io/google-apis-rs/google-doubleclicksearch2/trait.Delegate.html) is default-implemented, allowing you to customize it with minimal effort. +The [delegate trait](http://byron.github.io/google-apis-rs/google_doubleclicksearch2/trait.Delegate.html) 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](http://byron.github.io/google-apis-rs/google-doubleclicksearch2/trait.RequestValue.html) and -[decodable](http://byron.github.io/google-apis-rs/google-doubleclicksearch2/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses +All structures provided by this library are made to be [enocodable](http://byron.github.io/google-apis-rs/google_doubleclicksearch2/trait.RequestValue.html) and +[decodable](http://byron.github.io/google-apis-rs/google_doubleclicksearch2/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses are valid. -Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google-doubleclicksearch2/trait.Part.html) which are identifiable by name, which will be sent to +Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google_doubleclicksearch2/trait.Part.html) 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](http://byron.github.io/google-apis-rs/google-doubleclicksearch2/trait.CallBuilder.html), you are able to prepare an action call by repeatedly calling it's methods. +Using [method builders](http://byron.github.io/google-apis-rs/google_doubleclicksearch2/trait.CallBuilder.html), 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][wiki-pod] are handed by copy * strings are passed as `&str` -* [request values](http://byron.github.io/google-apis-rs/google-doubleclicksearch2/trait.RequestValue.html) are borrowed +* [request values](http://byron.github.io/google-apis-rs/google_doubleclicksearch2/trait.RequestValue.html) are borrowed Arguments will always be copied or cloned into the builder, to make them independent of their original life times. diff --git a/gen/drive2/README.md b/gen/drive2/README.md index 27469ffeb5..45b10e4ec3 100644 --- a/gen/drive2/README.md +++ b/gen/drive2/README.md @@ -11,55 +11,55 @@ Everything else about the *drive* *v2* API can be found at the [official documentation site](https://developers.google.com/drive/). # Features -Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google-drive2/struct.Drive.html) ... +Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google_drive2/struct.Drive.html) ... -* [about](http://byron.github.io/google-apis-rs/google-drive2/struct.About.html) - * [*get*](http://byron.github.io/google-apis-rs/google-drive2/struct.AboutGetCall.html) -* [apps](http://byron.github.io/google-apis-rs/google-drive2/struct.App.html) - * [*get*](http://byron.github.io/google-apis-rs/google-drive2/struct.AppGetCall.html) and [*list*](http://byron.github.io/google-apis-rs/google-drive2/struct.AppListCall.html) -* [changes](http://byron.github.io/google-apis-rs/google-drive2/struct.Change.html) - * [*get*](http://byron.github.io/google-apis-rs/google-drive2/struct.ChangeGetCall.html), [*list*](http://byron.github.io/google-apis-rs/google-drive2/struct.ChangeListCall.html) and [*watch*](http://byron.github.io/google-apis-rs/google-drive2/struct.ChangeWatchCall.html) -* [channels](http://byron.github.io/google-apis-rs/google-drive2/struct.Channel.html) - * [*stop*](http://byron.github.io/google-apis-rs/google-drive2/struct.ChannelStopCall.html) +* [about](http://byron.github.io/google-apis-rs/google_drive2/struct.About.html) + * [*get*](http://byron.github.io/google-apis-rs/google_drive2/struct.AboutGetCall.html) +* [apps](http://byron.github.io/google-apis-rs/google_drive2/struct.App.html) + * [*get*](http://byron.github.io/google-apis-rs/google_drive2/struct.AppGetCall.html) and [*list*](http://byron.github.io/google-apis-rs/google_drive2/struct.AppListCall.html) +* [changes](http://byron.github.io/google-apis-rs/google_drive2/struct.Change.html) + * [*get*](http://byron.github.io/google-apis-rs/google_drive2/struct.ChangeGetCall.html), [*list*](http://byron.github.io/google-apis-rs/google_drive2/struct.ChangeListCall.html) and [*watch*](http://byron.github.io/google-apis-rs/google_drive2/struct.ChangeWatchCall.html) +* [channels](http://byron.github.io/google-apis-rs/google_drive2/struct.Channel.html) + * [*stop*](http://byron.github.io/google-apis-rs/google_drive2/struct.ChannelStopCall.html) * children - * [*delete*](http://byron.github.io/google-apis-rs/google-drive2/struct.ChildrenDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google-drive2/struct.ChildrenGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google-drive2/struct.ChildrenInsertCall.html) and [*list*](http://byron.github.io/google-apis-rs/google-drive2/struct.ChildrenListCall.html) -* [comments](http://byron.github.io/google-apis-rs/google-drive2/struct.Comment.html) - * [*delete*](http://byron.github.io/google-apis-rs/google-drive2/struct.CommentDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google-drive2/struct.CommentGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google-drive2/struct.CommentInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google-drive2/struct.CommentListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google-drive2/struct.CommentPatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google-drive2/struct.CommentUpdateCall.html) -* [files](http://byron.github.io/google-apis-rs/google-drive2/struct.File.html) - * [*copy*](http://byron.github.io/google-apis-rs/google-drive2/struct.FileCopyCall.html), [*delete*](http://byron.github.io/google-apis-rs/google-drive2/struct.FileDeleteCall.html), [*empty trash*](http://byron.github.io/google-apis-rs/google-drive2/struct.FileEmptyTrashCall.html), [*get*](http://byron.github.io/google-apis-rs/google-drive2/struct.FileGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google-drive2/struct.FileInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google-drive2/struct.FileListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google-drive2/struct.FilePatchCall.html), [*touch*](http://byron.github.io/google-apis-rs/google-drive2/struct.FileTouchCall.html), [*trash*](http://byron.github.io/google-apis-rs/google-drive2/struct.FileTrashCall.html), [*untrash*](http://byron.github.io/google-apis-rs/google-drive2/struct.FileUntrashCall.html), [*update*](http://byron.github.io/google-apis-rs/google-drive2/struct.FileUpdateCall.html) and [*watch*](http://byron.github.io/google-apis-rs/google-drive2/struct.FileWatchCall.html) + * [*delete*](http://byron.github.io/google-apis-rs/google_drive2/struct.ChildrenDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google_drive2/struct.ChildrenGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google_drive2/struct.ChildrenInsertCall.html) and [*list*](http://byron.github.io/google-apis-rs/google_drive2/struct.ChildrenListCall.html) +* [comments](http://byron.github.io/google-apis-rs/google_drive2/struct.Comment.html) + * [*delete*](http://byron.github.io/google-apis-rs/google_drive2/struct.CommentDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google_drive2/struct.CommentGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google_drive2/struct.CommentInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google_drive2/struct.CommentListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google_drive2/struct.CommentPatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google_drive2/struct.CommentUpdateCall.html) +* [files](http://byron.github.io/google-apis-rs/google_drive2/struct.File.html) + * [*copy*](http://byron.github.io/google-apis-rs/google_drive2/struct.FileCopyCall.html), [*delete*](http://byron.github.io/google-apis-rs/google_drive2/struct.FileDeleteCall.html), [*empty trash*](http://byron.github.io/google-apis-rs/google_drive2/struct.FileEmptyTrashCall.html), [*get*](http://byron.github.io/google-apis-rs/google_drive2/struct.FileGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google_drive2/struct.FileInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google_drive2/struct.FileListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google_drive2/struct.FilePatchCall.html), [*touch*](http://byron.github.io/google-apis-rs/google_drive2/struct.FileTouchCall.html), [*trash*](http://byron.github.io/google-apis-rs/google_drive2/struct.FileTrashCall.html), [*untrash*](http://byron.github.io/google-apis-rs/google_drive2/struct.FileUntrashCall.html), [*update*](http://byron.github.io/google-apis-rs/google_drive2/struct.FileUpdateCall.html) and [*watch*](http://byron.github.io/google-apis-rs/google_drive2/struct.FileWatchCall.html) * parents - * [*delete*](http://byron.github.io/google-apis-rs/google-drive2/struct.ParentDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google-drive2/struct.ParentGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google-drive2/struct.ParentInsertCall.html) and [*list*](http://byron.github.io/google-apis-rs/google-drive2/struct.ParentListCall.html) -* [permissions](http://byron.github.io/google-apis-rs/google-drive2/struct.Permission.html) - * [*delete*](http://byron.github.io/google-apis-rs/google-drive2/struct.PermissionDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google-drive2/struct.PermissionGetCall.html), [*get id for email*](http://byron.github.io/google-apis-rs/google-drive2/struct.PermissionGetIdForEmailCall.html), [*insert*](http://byron.github.io/google-apis-rs/google-drive2/struct.PermissionInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google-drive2/struct.PermissionListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google-drive2/struct.PermissionPatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google-drive2/struct.PermissionUpdateCall.html) -* [properties](http://byron.github.io/google-apis-rs/google-drive2/struct.Property.html) - * [*delete*](http://byron.github.io/google-apis-rs/google-drive2/struct.PropertyDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google-drive2/struct.PropertyGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google-drive2/struct.PropertyInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google-drive2/struct.PropertyListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google-drive2/struct.PropertyPatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google-drive2/struct.PropertyUpdateCall.html) + * [*delete*](http://byron.github.io/google-apis-rs/google_drive2/struct.ParentDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google_drive2/struct.ParentGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google_drive2/struct.ParentInsertCall.html) and [*list*](http://byron.github.io/google-apis-rs/google_drive2/struct.ParentListCall.html) +* [permissions](http://byron.github.io/google-apis-rs/google_drive2/struct.Permission.html) + * [*delete*](http://byron.github.io/google-apis-rs/google_drive2/struct.PermissionDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google_drive2/struct.PermissionGetCall.html), [*get id for email*](http://byron.github.io/google-apis-rs/google_drive2/struct.PermissionGetIdForEmailCall.html), [*insert*](http://byron.github.io/google-apis-rs/google_drive2/struct.PermissionInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google_drive2/struct.PermissionListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google_drive2/struct.PermissionPatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google_drive2/struct.PermissionUpdateCall.html) +* [properties](http://byron.github.io/google-apis-rs/google_drive2/struct.Property.html) + * [*delete*](http://byron.github.io/google-apis-rs/google_drive2/struct.PropertyDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google_drive2/struct.PropertyGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google_drive2/struct.PropertyInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google_drive2/struct.PropertyListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google_drive2/struct.PropertyPatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google_drive2/struct.PropertyUpdateCall.html) * realtime - * [*get*](http://byron.github.io/google-apis-rs/google-drive2/struct.RealtimeGetCall.html) and [*update*](http://byron.github.io/google-apis-rs/google-drive2/struct.RealtimeUpdateCall.html) + * [*get*](http://byron.github.io/google-apis-rs/google_drive2/struct.RealtimeGetCall.html) and [*update*](http://byron.github.io/google-apis-rs/google_drive2/struct.RealtimeUpdateCall.html) * replies - * [*delete*](http://byron.github.io/google-apis-rs/google-drive2/struct.ReplyDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google-drive2/struct.ReplyGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google-drive2/struct.ReplyInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google-drive2/struct.ReplyListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google-drive2/struct.ReplyPatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google-drive2/struct.ReplyUpdateCall.html) -* [revisions](http://byron.github.io/google-apis-rs/google-drive2/struct.Revision.html) - * [*delete*](http://byron.github.io/google-apis-rs/google-drive2/struct.RevisionDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google-drive2/struct.RevisionGetCall.html), [*list*](http://byron.github.io/google-apis-rs/google-drive2/struct.RevisionListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google-drive2/struct.RevisionPatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google-drive2/struct.RevisionUpdateCall.html) + * [*delete*](http://byron.github.io/google-apis-rs/google_drive2/struct.ReplyDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google_drive2/struct.ReplyGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google_drive2/struct.ReplyInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google_drive2/struct.ReplyListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google_drive2/struct.ReplyPatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google_drive2/struct.ReplyUpdateCall.html) +* [revisions](http://byron.github.io/google-apis-rs/google_drive2/struct.Revision.html) + * [*delete*](http://byron.github.io/google-apis-rs/google_drive2/struct.RevisionDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google_drive2/struct.RevisionGetCall.html), [*list*](http://byron.github.io/google-apis-rs/google_drive2/struct.RevisionListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google_drive2/struct.RevisionPatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google_drive2/struct.RevisionUpdateCall.html) Upload supported by ... -* [*insert files*](http://byron.github.io/google-apis-rs/google-drive2/struct.FileInsertCall.html) -* [*update realtime*](http://byron.github.io/google-apis-rs/google-drive2/struct.RealtimeUpdateCall.html) -* [*update files*](http://byron.github.io/google-apis-rs/google-drive2/struct.FileUpdateCall.html) +* [*insert files*](http://byron.github.io/google-apis-rs/google_drive2/struct.FileInsertCall.html) +* [*update realtime*](http://byron.github.io/google-apis-rs/google_drive2/struct.RealtimeUpdateCall.html) +* [*update files*](http://byron.github.io/google-apis-rs/google_drive2/struct.FileUpdateCall.html) Download supported by ... -* [*watch files*](http://byron.github.io/google-apis-rs/google-drive2/struct.FileWatchCall.html) -* [*get files*](http://byron.github.io/google-apis-rs/google-drive2/struct.FileGetCall.html) -* [*get realtime*](http://byron.github.io/google-apis-rs/google-drive2/struct.RealtimeGetCall.html) +* [*watch files*](http://byron.github.io/google-apis-rs/google_drive2/struct.FileWatchCall.html) +* [*get files*](http://byron.github.io/google-apis-rs/google_drive2/struct.FileGetCall.html) +* [*get realtime*](http://byron.github.io/google-apis-rs/google_drive2/struct.RealtimeGetCall.html) Subscription supported by ... -* [*watch files*](http://byron.github.io/google-apis-rs/google-drive2/struct.FileWatchCall.html) -* [*get files*](http://byron.github.io/google-apis-rs/google-drive2/struct.FileGetCall.html) -* [*watch changes*](http://byron.github.io/google-apis-rs/google-drive2/struct.ChangeWatchCall.html) -* [*insert files*](http://byron.github.io/google-apis-rs/google-drive2/struct.FileInsertCall.html) -* [*list changes*](http://byron.github.io/google-apis-rs/google-drive2/struct.ChangeListCall.html) +* [*watch files*](http://byron.github.io/google-apis-rs/google_drive2/struct.FileWatchCall.html) +* [*get files*](http://byron.github.io/google-apis-rs/google_drive2/struct.FileGetCall.html) +* [*watch changes*](http://byron.github.io/google-apis-rs/google_drive2/struct.ChangeWatchCall.html) +* [*insert files*](http://byron.github.io/google-apis-rs/google_drive2/struct.FileInsertCall.html) +* [*list changes*](http://byron.github.io/google-apis-rs/google_drive2/struct.ChangeListCall.html) @@ -67,17 +67,17 @@ Subscription supported by ... The API is structured into the following primary items: -* **[Hub](http://byron.github.io/google-apis-rs/google-drive2/struct.Drive.html)** +* **[Hub](http://byron.github.io/google-apis-rs/google_drive2/struct.Drive.html)** * a central object to maintain state and allow accessing all *Activities* - * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google-drive2/trait.MethodsBuilder.html) which in turn - allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google-drive2/trait.CallBuilder.html) -* **[Resources](http://byron.github.io/google-apis-rs/google-drive2/trait.Resource.html)** + * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google_drive2/trait.MethodsBuilder.html) which in turn + allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google_drive2/trait.CallBuilder.html) +* **[Resources](http://byron.github.io/google-apis-rs/google_drive2/trait.Resource.html)** * primary types that you can apply *Activities* to * a collection of properties and *Parts* - * **[Parts](http://byron.github.io/google-apis-rs/google-drive2/trait.Part.html)** + * **[Parts](http://byron.github.io/google-apis-rs/google_drive2/trait.Part.html)** * a collection of properties * never directly used in *Activities* -* **[Activities](http://byron.github.io/google-apis-rs/google-drive2/trait.CallBuilder.html)** +* **[Activities](http://byron.github.io/google-apis-rs/google_drive2/trait.CallBuilder.html)** * operations to apply to *Resources* All *structures* are marked with applicable traits to further categorize them and ease browsing. @@ -185,17 +185,17 @@ match result { ``` ## Handling Errors -All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google-drive2/enum.Result.html) enumeration as return value of +All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google_drive2/enum.Result.html) enumeration as return value of the doit() methods, or handed as possibly intermediate results to either the -[Hub Delegate](http://byron.github.io/google-apis-rs/google-drive2/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google-drive2/../yup-oauth2/trait.AuthenticatorDelegate.html). +[Hub Delegate](http://byron.github.io/google-apis-rs/google_drive2/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google_drive2/../yup-oauth2/trait.AuthenticatorDelegate.html). 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](http://byron.github.io/google-apis-rs/google-drive2/enum.Result.html), should be +If a method supports downloads, the response body, which is part of the [Result](http://byron.github.io/google-apis-rs/google_drive2/enum.Result.html), should be read by you to obtain the media. -If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google-drive2/trait.ResponseResult.html), it will return that by default. +If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google_drive2/trait.ResponseResult.html), 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")`. @@ -205,29 +205,29 @@ Methods supporting uploads can do so using up to 2 different protocols: ## Customization and Callbacks -You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google-drive2/trait.Delegate.html) to the -[Method Builder](http://byron.github.io/google-apis-rs/google-drive2/trait.CallBuilder.html) before making the final `doit()` call. +You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google_drive2/trait.Delegate.html) to the +[Method Builder](http://byron.github.io/google-apis-rs/google_drive2/trait.CallBuilder.html) 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](http://byron.github.io/google-apis-rs/google-drive2/trait.Delegate.html) is default-implemented, allowing you to customize it with minimal effort. +The [delegate trait](http://byron.github.io/google-apis-rs/google_drive2/trait.Delegate.html) 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](http://byron.github.io/google-apis-rs/google-drive2/trait.RequestValue.html) and -[decodable](http://byron.github.io/google-apis-rs/google-drive2/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses +All structures provided by this library are made to be [enocodable](http://byron.github.io/google-apis-rs/google_drive2/trait.RequestValue.html) and +[decodable](http://byron.github.io/google-apis-rs/google_drive2/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses are valid. -Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google-drive2/trait.Part.html) which are identifiable by name, which will be sent to +Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google_drive2/trait.Part.html) 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](http://byron.github.io/google-apis-rs/google-drive2/trait.CallBuilder.html), you are able to prepare an action call by repeatedly calling it's methods. +Using [method builders](http://byron.github.io/google-apis-rs/google_drive2/trait.CallBuilder.html), 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][wiki-pod] are handed by copy * strings are passed as `&str` -* [request values](http://byron.github.io/google-apis-rs/google-drive2/trait.RequestValue.html) are borrowed +* [request values](http://byron.github.io/google-apis-rs/google_drive2/trait.RequestValue.html) are borrowed Arguments will always be copied or cloned into the builder, to make them independent of their original life times. diff --git a/gen/fitness1/README.md b/gen/fitness1/README.md index 1e5b296a82..39fe3b8280 100644 --- a/gen/fitness1/README.md +++ b/gen/fitness1/README.md @@ -11,10 +11,10 @@ Everything else about the *fitness* *v1* API can be found at the [official documentation site](https://developers.google.com/fit/rest/). # Features -Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google-fitness1/struct.Fitness.html) ... +Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google_fitness1/struct.Fitness.html) ... * users - * [*data sources create*](http://byron.github.io/google-apis-rs/google-fitness1/struct.UserDataSourceCreateCall.html), [*data sources datasets delete*](http://byron.github.io/google-apis-rs/google-fitness1/struct.UserDataSourceDatasetDeleteCall.html), [*data sources datasets get*](http://byron.github.io/google-apis-rs/google-fitness1/struct.UserDataSourceDatasetGetCall.html), [*data sources datasets patch*](http://byron.github.io/google-apis-rs/google-fitness1/struct.UserDataSourceDatasetPatchCall.html), [*data sources get*](http://byron.github.io/google-apis-rs/google-fitness1/struct.UserDataSourceGetCall.html), [*data sources list*](http://byron.github.io/google-apis-rs/google-fitness1/struct.UserDataSourceListCall.html), [*data sources patch*](http://byron.github.io/google-apis-rs/google-fitness1/struct.UserDataSourcePatchCall.html), [*data sources update*](http://byron.github.io/google-apis-rs/google-fitness1/struct.UserDataSourceUpdateCall.html), [*sessions delete*](http://byron.github.io/google-apis-rs/google-fitness1/struct.UserSessionDeleteCall.html), [*sessions list*](http://byron.github.io/google-apis-rs/google-fitness1/struct.UserSessionListCall.html) and [*sessions update*](http://byron.github.io/google-apis-rs/google-fitness1/struct.UserSessionUpdateCall.html) + * [*data sources create*](http://byron.github.io/google-apis-rs/google_fitness1/struct.UserDataSourceCreateCall.html), [*data sources datasets delete*](http://byron.github.io/google-apis-rs/google_fitness1/struct.UserDataSourceDatasetDeleteCall.html), [*data sources datasets get*](http://byron.github.io/google-apis-rs/google_fitness1/struct.UserDataSourceDatasetGetCall.html), [*data sources datasets patch*](http://byron.github.io/google-apis-rs/google_fitness1/struct.UserDataSourceDatasetPatchCall.html), [*data sources get*](http://byron.github.io/google-apis-rs/google_fitness1/struct.UserDataSourceGetCall.html), [*data sources list*](http://byron.github.io/google-apis-rs/google_fitness1/struct.UserDataSourceListCall.html), [*data sources patch*](http://byron.github.io/google-apis-rs/google_fitness1/struct.UserDataSourcePatchCall.html), [*data sources update*](http://byron.github.io/google-apis-rs/google_fitness1/struct.UserDataSourceUpdateCall.html), [*sessions delete*](http://byron.github.io/google-apis-rs/google_fitness1/struct.UserSessionDeleteCall.html), [*sessions list*](http://byron.github.io/google-apis-rs/google_fitness1/struct.UserSessionListCall.html) and [*sessions update*](http://byron.github.io/google-apis-rs/google_fitness1/struct.UserSessionUpdateCall.html) @@ -23,17 +23,17 @@ Handle the following *Resources* with ease from the central [hub](http://byron.g The API is structured into the following primary items: -* **[Hub](http://byron.github.io/google-apis-rs/google-fitness1/struct.Fitness.html)** +* **[Hub](http://byron.github.io/google-apis-rs/google_fitness1/struct.Fitness.html)** * a central object to maintain state and allow accessing all *Activities* - * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google-fitness1/trait.MethodsBuilder.html) which in turn - allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google-fitness1/trait.CallBuilder.html) -* **[Resources](http://byron.github.io/google-apis-rs/google-fitness1/trait.Resource.html)** + * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google_fitness1/trait.MethodsBuilder.html) which in turn + allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google_fitness1/trait.CallBuilder.html) +* **[Resources](http://byron.github.io/google-apis-rs/google_fitness1/trait.Resource.html)** * primary types that you can apply *Activities* to * a collection of properties and *Parts* - * **[Parts](http://byron.github.io/google-apis-rs/google-fitness1/trait.Part.html)** + * **[Parts](http://byron.github.io/google-apis-rs/google_fitness1/trait.Part.html)** * a collection of properties * never directly used in *Activities* -* **[Activities](http://byron.github.io/google-apis-rs/google-fitness1/trait.CallBuilder.html)** +* **[Activities](http://byron.github.io/google-apis-rs/google_fitness1/trait.CallBuilder.html)** * operations to apply to *Resources* All *structures* are marked with applicable traits to further categorize them and ease browsing. @@ -121,17 +121,17 @@ match result { ``` ## Handling Errors -All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google-fitness1/enum.Result.html) enumeration as return value of +All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google_fitness1/enum.Result.html) enumeration as return value of the doit() methods, or handed as possibly intermediate results to either the -[Hub Delegate](http://byron.github.io/google-apis-rs/google-fitness1/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google-fitness1/../yup-oauth2/trait.AuthenticatorDelegate.html). +[Hub Delegate](http://byron.github.io/google-apis-rs/google_fitness1/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google_fitness1/../yup-oauth2/trait.AuthenticatorDelegate.html). 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](http://byron.github.io/google-apis-rs/google-fitness1/enum.Result.html), should be +If a method supports downloads, the response body, which is part of the [Result](http://byron.github.io/google-apis-rs/google_fitness1/enum.Result.html), should be read by you to obtain the media. -If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google-fitness1/trait.ResponseResult.html), it will return that by default. +If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google_fitness1/trait.ResponseResult.html), 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")`. @@ -141,29 +141,29 @@ Methods supporting uploads can do so using up to 2 different protocols: ## Customization and Callbacks -You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google-fitness1/trait.Delegate.html) to the -[Method Builder](http://byron.github.io/google-apis-rs/google-fitness1/trait.CallBuilder.html) before making the final `doit()` call. +You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google_fitness1/trait.Delegate.html) to the +[Method Builder](http://byron.github.io/google-apis-rs/google_fitness1/trait.CallBuilder.html) 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](http://byron.github.io/google-apis-rs/google-fitness1/trait.Delegate.html) is default-implemented, allowing you to customize it with minimal effort. +The [delegate trait](http://byron.github.io/google-apis-rs/google_fitness1/trait.Delegate.html) 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](http://byron.github.io/google-apis-rs/google-fitness1/trait.RequestValue.html) and -[decodable](http://byron.github.io/google-apis-rs/google-fitness1/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses +All structures provided by this library are made to be [enocodable](http://byron.github.io/google-apis-rs/google_fitness1/trait.RequestValue.html) and +[decodable](http://byron.github.io/google-apis-rs/google_fitness1/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses are valid. -Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google-fitness1/trait.Part.html) which are identifiable by name, which will be sent to +Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google_fitness1/trait.Part.html) 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](http://byron.github.io/google-apis-rs/google-fitness1/trait.CallBuilder.html), you are able to prepare an action call by repeatedly calling it's methods. +Using [method builders](http://byron.github.io/google-apis-rs/google_fitness1/trait.CallBuilder.html), 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][wiki-pod] are handed by copy * strings are passed as `&str` -* [request values](http://byron.github.io/google-apis-rs/google-fitness1/trait.RequestValue.html) are borrowed +* [request values](http://byron.github.io/google-apis-rs/google_fitness1/trait.RequestValue.html) are borrowed Arguments will always be copied or cloned into the builder, to make them independent of their original life times. diff --git a/gen/freebase1/README.md b/gen/freebase1/README.md index 70a023da51..cef019bff1 100644 --- a/gen/freebase1/README.md +++ b/gen/freebase1/README.md @@ -11,15 +11,15 @@ Everything else about the *freebase* *v1* API can be found at the [official documentation site](https://developers.google.com/freebase/). # Features -Use the following functionality with ease from the central [hub](http://byron.github.io/google-apis-rs/google-freebase1/struct.Freebase.html) ... +Use the following functionality with ease from the central [hub](http://byron.github.io/google-apis-rs/google_freebase1/struct.Freebase.html) ... -* [reconcile](http://byron.github.io/google-apis-rs/google-freebase1/struct.MethodReconcileCall.html) -* [search](http://byron.github.io/google-apis-rs/google-freebase1/struct.MethodSearchCall.html) +* [reconcile](http://byron.github.io/google-apis-rs/google_freebase1/struct.MethodReconcileCall.html) +* [search](http://byron.github.io/google-apis-rs/google_freebase1/struct.MethodSearchCall.html) Download supported by ... -* [*search*](http://byron.github.io/google-apis-rs/google-freebase1/struct.MethodSearchCall.html) +* [*search*](http://byron.github.io/google-apis-rs/google_freebase1/struct.MethodSearchCall.html) @@ -27,17 +27,17 @@ Download supported by ... The API is structured into the following primary items: -* **[Hub](http://byron.github.io/google-apis-rs/google-freebase1/struct.Freebase.html)** +* **[Hub](http://byron.github.io/google-apis-rs/google_freebase1/struct.Freebase.html)** * a central object to maintain state and allow accessing all *Activities* - * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google-freebase1/trait.MethodsBuilder.html) which in turn - allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google-freebase1/trait.CallBuilder.html) -* **[Resources](http://byron.github.io/google-apis-rs/google-freebase1/trait.Resource.html)** + * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google_freebase1/trait.MethodsBuilder.html) which in turn + allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google_freebase1/trait.CallBuilder.html) +* **[Resources](http://byron.github.io/google-apis-rs/google_freebase1/trait.Resource.html)** * primary types that you can apply *Activities* to * a collection of properties and *Parts* - * **[Parts](http://byron.github.io/google-apis-rs/google-freebase1/trait.Part.html)** + * **[Parts](http://byron.github.io/google-apis-rs/google_freebase1/trait.Part.html)** * a collection of properties * never directly used in *Activities* -* **[Activities](http://byron.github.io/google-apis-rs/google-freebase1/trait.CallBuilder.html)** +* **[Activities](http://byron.github.io/google-apis-rs/google_freebase1/trait.CallBuilder.html)** * operations to apply to *Resources* All *structures* are marked with applicable traits to further categorize them and ease browsing. @@ -122,17 +122,17 @@ match result { ``` ## Handling Errors -All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google-freebase1/enum.Result.html) enumeration as return value of +All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google_freebase1/enum.Result.html) enumeration as return value of the doit() methods, or handed as possibly intermediate results to either the -[Hub Delegate](http://byron.github.io/google-apis-rs/google-freebase1/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google-freebase1/../yup-oauth2/trait.AuthenticatorDelegate.html). +[Hub Delegate](http://byron.github.io/google-apis-rs/google_freebase1/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google_freebase1/../yup-oauth2/trait.AuthenticatorDelegate.html). 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](http://byron.github.io/google-apis-rs/google-freebase1/enum.Result.html), should be +If a method supports downloads, the response body, which is part of the [Result](http://byron.github.io/google-apis-rs/google_freebase1/enum.Result.html), should be read by you to obtain the media. -If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google-freebase1/trait.ResponseResult.html), it will return that by default. +If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google_freebase1/trait.ResponseResult.html), 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")`. @@ -142,29 +142,29 @@ Methods supporting uploads can do so using up to 2 different protocols: ## Customization and Callbacks -You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google-freebase1/trait.Delegate.html) to the -[Method Builder](http://byron.github.io/google-apis-rs/google-freebase1/trait.CallBuilder.html) before making the final `doit()` call. +You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google_freebase1/trait.Delegate.html) to the +[Method Builder](http://byron.github.io/google-apis-rs/google_freebase1/trait.CallBuilder.html) 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](http://byron.github.io/google-apis-rs/google-freebase1/trait.Delegate.html) is default-implemented, allowing you to customize it with minimal effort. +The [delegate trait](http://byron.github.io/google-apis-rs/google_freebase1/trait.Delegate.html) 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](http://byron.github.io/google-apis-rs/google-freebase1/trait.RequestValue.html) and -[decodable](http://byron.github.io/google-apis-rs/google-freebase1/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses +All structures provided by this library are made to be [enocodable](http://byron.github.io/google-apis-rs/google_freebase1/trait.RequestValue.html) and +[decodable](http://byron.github.io/google-apis-rs/google_freebase1/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses are valid. -Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google-freebase1/trait.Part.html) which are identifiable by name, which will be sent to +Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google_freebase1/trait.Part.html) 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](http://byron.github.io/google-apis-rs/google-freebase1/trait.CallBuilder.html), you are able to prepare an action call by repeatedly calling it's methods. +Using [method builders](http://byron.github.io/google-apis-rs/google_freebase1/trait.CallBuilder.html), 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][wiki-pod] are handed by copy * strings are passed as `&str` -* [request values](http://byron.github.io/google-apis-rs/google-freebase1/trait.RequestValue.html) are borrowed +* [request values](http://byron.github.io/google-apis-rs/google_freebase1/trait.RequestValue.html) are borrowed Arguments will always be copied or cloned into the builder, to make them independent of their original life times. diff --git a/gen/freebase1_sandbox/README.md b/gen/freebase1_sandbox/README.md index 4229cf9c72..0ba07d656e 100644 --- a/gen/freebase1_sandbox/README.md +++ b/gen/freebase1_sandbox/README.md @@ -11,15 +11,15 @@ Everything else about the *freebase* *v1_sandbox* API can be found at the [official documentation site](https://developers.google.com/freebase/). # Features -Use the following functionality with ease from the central [hub](http://byron.github.io/google-apis-rs/google-freebase1_sandbox/struct.Freebase.html) ... +Use the following functionality with ease from the central [hub](http://byron.github.io/google-apis-rs/google_freebase1_sandbox/struct.Freebase.html) ... -* [reconcile](http://byron.github.io/google-apis-rs/google-freebase1_sandbox/struct.MethodReconcileCall.html) -* [search](http://byron.github.io/google-apis-rs/google-freebase1_sandbox/struct.MethodSearchCall.html) +* [reconcile](http://byron.github.io/google-apis-rs/google_freebase1_sandbox/struct.MethodReconcileCall.html) +* [search](http://byron.github.io/google-apis-rs/google_freebase1_sandbox/struct.MethodSearchCall.html) Download supported by ... -* [*search*](http://byron.github.io/google-apis-rs/google-freebase1_sandbox/struct.MethodSearchCall.html) +* [*search*](http://byron.github.io/google-apis-rs/google_freebase1_sandbox/struct.MethodSearchCall.html) @@ -27,17 +27,17 @@ Download supported by ... The API is structured into the following primary items: -* **[Hub](http://byron.github.io/google-apis-rs/google-freebase1_sandbox/struct.Freebase.html)** +* **[Hub](http://byron.github.io/google-apis-rs/google_freebase1_sandbox/struct.Freebase.html)** * a central object to maintain state and allow accessing all *Activities* - * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google-freebase1_sandbox/trait.MethodsBuilder.html) which in turn - allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google-freebase1_sandbox/trait.CallBuilder.html) -* **[Resources](http://byron.github.io/google-apis-rs/google-freebase1_sandbox/trait.Resource.html)** + * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google_freebase1_sandbox/trait.MethodsBuilder.html) which in turn + allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google_freebase1_sandbox/trait.CallBuilder.html) +* **[Resources](http://byron.github.io/google-apis-rs/google_freebase1_sandbox/trait.Resource.html)** * primary types that you can apply *Activities* to * a collection of properties and *Parts* - * **[Parts](http://byron.github.io/google-apis-rs/google-freebase1_sandbox/trait.Part.html)** + * **[Parts](http://byron.github.io/google-apis-rs/google_freebase1_sandbox/trait.Part.html)** * a collection of properties * never directly used in *Activities* -* **[Activities](http://byron.github.io/google-apis-rs/google-freebase1_sandbox/trait.CallBuilder.html)** +* **[Activities](http://byron.github.io/google-apis-rs/google_freebase1_sandbox/trait.CallBuilder.html)** * operations to apply to *Resources* All *structures* are marked with applicable traits to further categorize them and ease browsing. @@ -122,17 +122,17 @@ match result { ``` ## Handling Errors -All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google-freebase1_sandbox/enum.Result.html) enumeration as return value of +All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google_freebase1_sandbox/enum.Result.html) enumeration as return value of the doit() methods, or handed as possibly intermediate results to either the -[Hub Delegate](http://byron.github.io/google-apis-rs/google-freebase1_sandbox/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google-freebase1_sandbox/../yup-oauth2/trait.AuthenticatorDelegate.html). +[Hub Delegate](http://byron.github.io/google-apis-rs/google_freebase1_sandbox/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google_freebase1_sandbox/../yup-oauth2/trait.AuthenticatorDelegate.html). 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](http://byron.github.io/google-apis-rs/google-freebase1_sandbox/enum.Result.html), should be +If a method supports downloads, the response body, which is part of the [Result](http://byron.github.io/google-apis-rs/google_freebase1_sandbox/enum.Result.html), should be read by you to obtain the media. -If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google-freebase1_sandbox/trait.ResponseResult.html), it will return that by default. +If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google_freebase1_sandbox/trait.ResponseResult.html), 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")`. @@ -142,29 +142,29 @@ Methods supporting uploads can do so using up to 2 different protocols: ## Customization and Callbacks -You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google-freebase1_sandbox/trait.Delegate.html) to the -[Method Builder](http://byron.github.io/google-apis-rs/google-freebase1_sandbox/trait.CallBuilder.html) before making the final `doit()` call. +You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google_freebase1_sandbox/trait.Delegate.html) to the +[Method Builder](http://byron.github.io/google-apis-rs/google_freebase1_sandbox/trait.CallBuilder.html) 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](http://byron.github.io/google-apis-rs/google-freebase1_sandbox/trait.Delegate.html) is default-implemented, allowing you to customize it with minimal effort. +The [delegate trait](http://byron.github.io/google-apis-rs/google_freebase1_sandbox/trait.Delegate.html) 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](http://byron.github.io/google-apis-rs/google-freebase1_sandbox/trait.RequestValue.html) and -[decodable](http://byron.github.io/google-apis-rs/google-freebase1_sandbox/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses +All structures provided by this library are made to be [enocodable](http://byron.github.io/google-apis-rs/google_freebase1_sandbox/trait.RequestValue.html) and +[decodable](http://byron.github.io/google-apis-rs/google_freebase1_sandbox/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses are valid. -Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google-freebase1_sandbox/trait.Part.html) which are identifiable by name, which will be sent to +Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google_freebase1_sandbox/trait.Part.html) 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](http://byron.github.io/google-apis-rs/google-freebase1_sandbox/trait.CallBuilder.html), you are able to prepare an action call by repeatedly calling it's methods. +Using [method builders](http://byron.github.io/google-apis-rs/google_freebase1_sandbox/trait.CallBuilder.html), 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][wiki-pod] are handed by copy * strings are passed as `&str` -* [request values](http://byron.github.io/google-apis-rs/google-freebase1_sandbox/trait.RequestValue.html) are borrowed +* [request values](http://byron.github.io/google-apis-rs/google_freebase1_sandbox/trait.RequestValue.html) are borrowed Arguments will always be copied or cloned into the builder, to make them independent of their original life times. diff --git a/gen/fusiontables2/README.md b/gen/fusiontables2/README.md index 9b9c00fae6..9ebfac2d4e 100644 --- a/gen/fusiontables2/README.md +++ b/gen/fusiontables2/README.md @@ -11,32 +11,32 @@ Everything else about the *fusiontables* *v2* API can be found at the [official documentation site](https://developers.google.com/fusiontables). # Features -Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google-fusiontables2/struct.Fusiontables.html) ... +Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google_fusiontables2/struct.Fusiontables.html) ... -* [column](http://byron.github.io/google-apis-rs/google-fusiontables2/struct.Column.html) - * [*delete*](http://byron.github.io/google-apis-rs/google-fusiontables2/struct.ColumnDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google-fusiontables2/struct.ColumnGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google-fusiontables2/struct.ColumnInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google-fusiontables2/struct.ColumnListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google-fusiontables2/struct.ColumnPatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google-fusiontables2/struct.ColumnUpdateCall.html) +* [column](http://byron.github.io/google-apis-rs/google_fusiontables2/struct.Column.html) + * [*delete*](http://byron.github.io/google-apis-rs/google_fusiontables2/struct.ColumnDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google_fusiontables2/struct.ColumnGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google_fusiontables2/struct.ColumnInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google_fusiontables2/struct.ColumnListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google_fusiontables2/struct.ColumnPatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google_fusiontables2/struct.ColumnUpdateCall.html) * query - * [*sql*](http://byron.github.io/google-apis-rs/google-fusiontables2/struct.QuerySqlCall.html) and [*sql get*](http://byron.github.io/google-apis-rs/google-fusiontables2/struct.QuerySqlGetCall.html) + * [*sql*](http://byron.github.io/google-apis-rs/google_fusiontables2/struct.QuerySqlCall.html) and [*sql get*](http://byron.github.io/google-apis-rs/google_fusiontables2/struct.QuerySqlGetCall.html) * style - * [*delete*](http://byron.github.io/google-apis-rs/google-fusiontables2/struct.StyleDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google-fusiontables2/struct.StyleGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google-fusiontables2/struct.StyleInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google-fusiontables2/struct.StyleListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google-fusiontables2/struct.StylePatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google-fusiontables2/struct.StyleUpdateCall.html) -* [table](http://byron.github.io/google-apis-rs/google-fusiontables2/struct.Table.html) - * [*copy*](http://byron.github.io/google-apis-rs/google-fusiontables2/struct.TableCopyCall.html), [*delete*](http://byron.github.io/google-apis-rs/google-fusiontables2/struct.TableDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google-fusiontables2/struct.TableGetCall.html), [*import rows*](http://byron.github.io/google-apis-rs/google-fusiontables2/struct.TableImportRowCall.html), [*import table*](http://byron.github.io/google-apis-rs/google-fusiontables2/struct.TableImportTableCall.html), [*insert*](http://byron.github.io/google-apis-rs/google-fusiontables2/struct.TableInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google-fusiontables2/struct.TableListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google-fusiontables2/struct.TablePatchCall.html), [*replace rows*](http://byron.github.io/google-apis-rs/google-fusiontables2/struct.TableReplaceRowCall.html) and [*update*](http://byron.github.io/google-apis-rs/google-fusiontables2/struct.TableUpdateCall.html) -* [task](http://byron.github.io/google-apis-rs/google-fusiontables2/struct.Task.html) - * [*delete*](http://byron.github.io/google-apis-rs/google-fusiontables2/struct.TaskDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google-fusiontables2/struct.TaskGetCall.html) and [*list*](http://byron.github.io/google-apis-rs/google-fusiontables2/struct.TaskListCall.html) -* [template](http://byron.github.io/google-apis-rs/google-fusiontables2/struct.Template.html) - * [*delete*](http://byron.github.io/google-apis-rs/google-fusiontables2/struct.TemplateDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google-fusiontables2/struct.TemplateGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google-fusiontables2/struct.TemplateInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google-fusiontables2/struct.TemplateListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google-fusiontables2/struct.TemplatePatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google-fusiontables2/struct.TemplateUpdateCall.html) + * [*delete*](http://byron.github.io/google-apis-rs/google_fusiontables2/struct.StyleDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google_fusiontables2/struct.StyleGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google_fusiontables2/struct.StyleInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google_fusiontables2/struct.StyleListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google_fusiontables2/struct.StylePatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google_fusiontables2/struct.StyleUpdateCall.html) +* [table](http://byron.github.io/google-apis-rs/google_fusiontables2/struct.Table.html) + * [*copy*](http://byron.github.io/google-apis-rs/google_fusiontables2/struct.TableCopyCall.html), [*delete*](http://byron.github.io/google-apis-rs/google_fusiontables2/struct.TableDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google_fusiontables2/struct.TableGetCall.html), [*import rows*](http://byron.github.io/google-apis-rs/google_fusiontables2/struct.TableImportRowCall.html), [*import table*](http://byron.github.io/google-apis-rs/google_fusiontables2/struct.TableImportTableCall.html), [*insert*](http://byron.github.io/google-apis-rs/google_fusiontables2/struct.TableInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google_fusiontables2/struct.TableListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google_fusiontables2/struct.TablePatchCall.html), [*replace rows*](http://byron.github.io/google-apis-rs/google_fusiontables2/struct.TableReplaceRowCall.html) and [*update*](http://byron.github.io/google-apis-rs/google_fusiontables2/struct.TableUpdateCall.html) +* [task](http://byron.github.io/google-apis-rs/google_fusiontables2/struct.Task.html) + * [*delete*](http://byron.github.io/google-apis-rs/google_fusiontables2/struct.TaskDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google_fusiontables2/struct.TaskGetCall.html) and [*list*](http://byron.github.io/google-apis-rs/google_fusiontables2/struct.TaskListCall.html) +* [template](http://byron.github.io/google-apis-rs/google_fusiontables2/struct.Template.html) + * [*delete*](http://byron.github.io/google-apis-rs/google_fusiontables2/struct.TemplateDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google_fusiontables2/struct.TemplateGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google_fusiontables2/struct.TemplateInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google_fusiontables2/struct.TemplateListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google_fusiontables2/struct.TemplatePatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google_fusiontables2/struct.TemplateUpdateCall.html) Upload supported by ... -* [*replace rows table*](http://byron.github.io/google-apis-rs/google-fusiontables2/struct.TableReplaceRowCall.html) -* [*import rows table*](http://byron.github.io/google-apis-rs/google-fusiontables2/struct.TableImportRowCall.html) -* [*import table table*](http://byron.github.io/google-apis-rs/google-fusiontables2/struct.TableImportTableCall.html) +* [*replace rows table*](http://byron.github.io/google-apis-rs/google_fusiontables2/struct.TableReplaceRowCall.html) +* [*import rows table*](http://byron.github.io/google-apis-rs/google_fusiontables2/struct.TableImportRowCall.html) +* [*import table table*](http://byron.github.io/google-apis-rs/google_fusiontables2/struct.TableImportTableCall.html) Download supported by ... -* [*sql get query*](http://byron.github.io/google-apis-rs/google-fusiontables2/struct.QuerySqlGetCall.html) -* [*sql query*](http://byron.github.io/google-apis-rs/google-fusiontables2/struct.QuerySqlCall.html) +* [*sql get query*](http://byron.github.io/google-apis-rs/google_fusiontables2/struct.QuerySqlGetCall.html) +* [*sql query*](http://byron.github.io/google-apis-rs/google_fusiontables2/struct.QuerySqlCall.html) @@ -44,17 +44,17 @@ Download supported by ... The API is structured into the following primary items: -* **[Hub](http://byron.github.io/google-apis-rs/google-fusiontables2/struct.Fusiontables.html)** +* **[Hub](http://byron.github.io/google-apis-rs/google_fusiontables2/struct.Fusiontables.html)** * a central object to maintain state and allow accessing all *Activities* - * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google-fusiontables2/trait.MethodsBuilder.html) which in turn - allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google-fusiontables2/trait.CallBuilder.html) -* **[Resources](http://byron.github.io/google-apis-rs/google-fusiontables2/trait.Resource.html)** + * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google_fusiontables2/trait.MethodsBuilder.html) which in turn + allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google_fusiontables2/trait.CallBuilder.html) +* **[Resources](http://byron.github.io/google-apis-rs/google_fusiontables2/trait.Resource.html)** * primary types that you can apply *Activities* to * a collection of properties and *Parts* - * **[Parts](http://byron.github.io/google-apis-rs/google-fusiontables2/trait.Part.html)** + * **[Parts](http://byron.github.io/google-apis-rs/google_fusiontables2/trait.Part.html)** * a collection of properties * never directly used in *Activities* -* **[Activities](http://byron.github.io/google-apis-rs/google-fusiontables2/trait.CallBuilder.html)** +* **[Activities](http://byron.github.io/google-apis-rs/google_fusiontables2/trait.CallBuilder.html)** * operations to apply to *Resources* All *structures* are marked with applicable traits to further categorize them and ease browsing. @@ -141,17 +141,17 @@ match result { ``` ## Handling Errors -All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google-fusiontables2/enum.Result.html) enumeration as return value of +All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google_fusiontables2/enum.Result.html) enumeration as return value of the doit() methods, or handed as possibly intermediate results to either the -[Hub Delegate](http://byron.github.io/google-apis-rs/google-fusiontables2/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google-fusiontables2/../yup-oauth2/trait.AuthenticatorDelegate.html). +[Hub Delegate](http://byron.github.io/google-apis-rs/google_fusiontables2/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google_fusiontables2/../yup-oauth2/trait.AuthenticatorDelegate.html). 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](http://byron.github.io/google-apis-rs/google-fusiontables2/enum.Result.html), should be +If a method supports downloads, the response body, which is part of the [Result](http://byron.github.io/google-apis-rs/google_fusiontables2/enum.Result.html), should be read by you to obtain the media. -If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google-fusiontables2/trait.ResponseResult.html), it will return that by default. +If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google_fusiontables2/trait.ResponseResult.html), 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")`. @@ -161,29 +161,29 @@ Methods supporting uploads can do so using up to 2 different protocols: ## Customization and Callbacks -You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google-fusiontables2/trait.Delegate.html) to the -[Method Builder](http://byron.github.io/google-apis-rs/google-fusiontables2/trait.CallBuilder.html) before making the final `doit()` call. +You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google_fusiontables2/trait.Delegate.html) to the +[Method Builder](http://byron.github.io/google-apis-rs/google_fusiontables2/trait.CallBuilder.html) 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](http://byron.github.io/google-apis-rs/google-fusiontables2/trait.Delegate.html) is default-implemented, allowing you to customize it with minimal effort. +The [delegate trait](http://byron.github.io/google-apis-rs/google_fusiontables2/trait.Delegate.html) 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](http://byron.github.io/google-apis-rs/google-fusiontables2/trait.RequestValue.html) and -[decodable](http://byron.github.io/google-apis-rs/google-fusiontables2/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses +All structures provided by this library are made to be [enocodable](http://byron.github.io/google-apis-rs/google_fusiontables2/trait.RequestValue.html) and +[decodable](http://byron.github.io/google-apis-rs/google_fusiontables2/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses are valid. -Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google-fusiontables2/trait.Part.html) which are identifiable by name, which will be sent to +Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google_fusiontables2/trait.Part.html) 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](http://byron.github.io/google-apis-rs/google-fusiontables2/trait.CallBuilder.html), you are able to prepare an action call by repeatedly calling it's methods. +Using [method builders](http://byron.github.io/google-apis-rs/google_fusiontables2/trait.CallBuilder.html), 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][wiki-pod] are handed by copy * strings are passed as `&str` -* [request values](http://byron.github.io/google-apis-rs/google-fusiontables2/trait.RequestValue.html) are borrowed +* [request values](http://byron.github.io/google-apis-rs/google_fusiontables2/trait.RequestValue.html) are borrowed Arguments will always be copied or cloned into the builder, to make them independent of their original life times. diff --git a/gen/games1/README.md b/gen/games1/README.md index 49a5598292..0926fecb92 100644 --- a/gen/games1/README.md +++ b/gen/games1/README.md @@ -11,38 +11,38 @@ Everything else about the *Games* *v1* API can be found at the [official documentation site](https://developers.google.com/games/services/). # Features -Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google-games1/struct.Games.html) ... +Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google_games1/struct.Games.html) ... -* [achievement definitions](http://byron.github.io/google-apis-rs/google-games1/struct.AchievementDefinition.html) - * [*list*](http://byron.github.io/google-apis-rs/google-games1/struct.AchievementDefinitionListCall.html) +* [achievement definitions](http://byron.github.io/google-apis-rs/google_games1/struct.AchievementDefinition.html) + * [*list*](http://byron.github.io/google-apis-rs/google_games1/struct.AchievementDefinitionListCall.html) * achievements - * [*increment*](http://byron.github.io/google-apis-rs/google-games1/struct.AchievementIncrementCall.html), [*list*](http://byron.github.io/google-apis-rs/google-games1/struct.AchievementListCall.html), [*reveal*](http://byron.github.io/google-apis-rs/google-games1/struct.AchievementRevealCall.html), [*set steps at least*](http://byron.github.io/google-apis-rs/google-games1/struct.AchievementSetStepsAtLeastCall.html), [*unlock*](http://byron.github.io/google-apis-rs/google-games1/struct.AchievementUnlockCall.html) and [*update multiple*](http://byron.github.io/google-apis-rs/google-games1/struct.AchievementUpdateMultipleCall.html) -* [applications](http://byron.github.io/google-apis-rs/google-games1/struct.Application.html) - * [*get*](http://byron.github.io/google-apis-rs/google-games1/struct.ApplicationGetCall.html) and [*played*](http://byron.github.io/google-apis-rs/google-games1/struct.ApplicationPlayedCall.html) + * [*increment*](http://byron.github.io/google-apis-rs/google_games1/struct.AchievementIncrementCall.html), [*list*](http://byron.github.io/google-apis-rs/google_games1/struct.AchievementListCall.html), [*reveal*](http://byron.github.io/google-apis-rs/google_games1/struct.AchievementRevealCall.html), [*set steps at least*](http://byron.github.io/google-apis-rs/google_games1/struct.AchievementSetStepsAtLeastCall.html), [*unlock*](http://byron.github.io/google-apis-rs/google_games1/struct.AchievementUnlockCall.html) and [*update multiple*](http://byron.github.io/google-apis-rs/google_games1/struct.AchievementUpdateMultipleCall.html) +* [applications](http://byron.github.io/google-apis-rs/google_games1/struct.Application.html) + * [*get*](http://byron.github.io/google-apis-rs/google_games1/struct.ApplicationGetCall.html) and [*played*](http://byron.github.io/google-apis-rs/google_games1/struct.ApplicationPlayedCall.html) * events - * [*list by player*](http://byron.github.io/google-apis-rs/google-games1/struct.EventListByPlayerCall.html), [*list definitions*](http://byron.github.io/google-apis-rs/google-games1/struct.EventListDefinitionCall.html) and [*record*](http://byron.github.io/google-apis-rs/google-games1/struct.EventRecordCall.html) -* [leaderboards](http://byron.github.io/google-apis-rs/google-games1/struct.Leaderboard.html) - * [*get*](http://byron.github.io/google-apis-rs/google-games1/struct.LeaderboardGetCall.html) and [*list*](http://byron.github.io/google-apis-rs/google-games1/struct.LeaderboardListCall.html) + * [*list by player*](http://byron.github.io/google-apis-rs/google_games1/struct.EventListByPlayerCall.html), [*list definitions*](http://byron.github.io/google-apis-rs/google_games1/struct.EventListDefinitionCall.html) and [*record*](http://byron.github.io/google-apis-rs/google_games1/struct.EventRecordCall.html) +* [leaderboards](http://byron.github.io/google-apis-rs/google_games1/struct.Leaderboard.html) + * [*get*](http://byron.github.io/google-apis-rs/google_games1/struct.LeaderboardGetCall.html) and [*list*](http://byron.github.io/google-apis-rs/google_games1/struct.LeaderboardListCall.html) * metagame - * [*get metagame config*](http://byron.github.io/google-apis-rs/google-games1/struct.MetagameGetMetagameConfigCall.html) and [*list categories by player*](http://byron.github.io/google-apis-rs/google-games1/struct.MetagameListCategoriesByPlayerCall.html) -* [players](http://byron.github.io/google-apis-rs/google-games1/struct.Player.html) - * [*get*](http://byron.github.io/google-apis-rs/google-games1/struct.PlayerGetCall.html) and [*list*](http://byron.github.io/google-apis-rs/google-games1/struct.PlayerListCall.html) + * [*get metagame config*](http://byron.github.io/google-apis-rs/google_games1/struct.MetagameGetMetagameConfigCall.html) and [*list categories by player*](http://byron.github.io/google-apis-rs/google_games1/struct.MetagameListCategoriesByPlayerCall.html) +* [players](http://byron.github.io/google-apis-rs/google_games1/struct.Player.html) + * [*get*](http://byron.github.io/google-apis-rs/google_games1/struct.PlayerGetCall.html) and [*list*](http://byron.github.io/google-apis-rs/google_games1/struct.PlayerListCall.html) * pushtokens - * [*remove*](http://byron.github.io/google-apis-rs/google-games1/struct.PushtokenRemoveCall.html) and [*update*](http://byron.github.io/google-apis-rs/google-games1/struct.PushtokenUpdateCall.html) -* [quest milestones](http://byron.github.io/google-apis-rs/google-games1/struct.QuestMilestone.html) - * [*claim*](http://byron.github.io/google-apis-rs/google-games1/struct.QuestMilestoneClaimCall.html) -* [quests](http://byron.github.io/google-apis-rs/google-games1/struct.Quest.html) - * [*accept*](http://byron.github.io/google-apis-rs/google-games1/struct.QuestAcceptCall.html) and [*list*](http://byron.github.io/google-apis-rs/google-games1/struct.QuestListCall.html) + * [*remove*](http://byron.github.io/google-apis-rs/google_games1/struct.PushtokenRemoveCall.html) and [*update*](http://byron.github.io/google-apis-rs/google_games1/struct.PushtokenUpdateCall.html) +* [quest milestones](http://byron.github.io/google-apis-rs/google_games1/struct.QuestMilestone.html) + * [*claim*](http://byron.github.io/google-apis-rs/google_games1/struct.QuestMilestoneClaimCall.html) +* [quests](http://byron.github.io/google-apis-rs/google_games1/struct.Quest.html) + * [*accept*](http://byron.github.io/google-apis-rs/google_games1/struct.QuestAcceptCall.html) and [*list*](http://byron.github.io/google-apis-rs/google_games1/struct.QuestListCall.html) * revisions - * [*check*](http://byron.github.io/google-apis-rs/google-games1/struct.RevisionCheckCall.html) -* [rooms](http://byron.github.io/google-apis-rs/google-games1/struct.Room.html) - * [*create*](http://byron.github.io/google-apis-rs/google-games1/struct.RoomCreateCall.html), [*decline*](http://byron.github.io/google-apis-rs/google-games1/struct.RoomDeclineCall.html), [*dismiss*](http://byron.github.io/google-apis-rs/google-games1/struct.RoomDismisCall.html), [*get*](http://byron.github.io/google-apis-rs/google-games1/struct.RoomGetCall.html), [*join*](http://byron.github.io/google-apis-rs/google-games1/struct.RoomJoinCall.html), [*leave*](http://byron.github.io/google-apis-rs/google-games1/struct.RoomLeaveCall.html), [*list*](http://byron.github.io/google-apis-rs/google-games1/struct.RoomListCall.html) and [*report status*](http://byron.github.io/google-apis-rs/google-games1/struct.RoomReportStatuCall.html) + * [*check*](http://byron.github.io/google-apis-rs/google_games1/struct.RevisionCheckCall.html) +* [rooms](http://byron.github.io/google-apis-rs/google_games1/struct.Room.html) + * [*create*](http://byron.github.io/google-apis-rs/google_games1/struct.RoomCreateCall.html), [*decline*](http://byron.github.io/google-apis-rs/google_games1/struct.RoomDeclineCall.html), [*dismiss*](http://byron.github.io/google-apis-rs/google_games1/struct.RoomDismisCall.html), [*get*](http://byron.github.io/google-apis-rs/google_games1/struct.RoomGetCall.html), [*join*](http://byron.github.io/google-apis-rs/google_games1/struct.RoomJoinCall.html), [*leave*](http://byron.github.io/google-apis-rs/google_games1/struct.RoomLeaveCall.html), [*list*](http://byron.github.io/google-apis-rs/google_games1/struct.RoomListCall.html) and [*report status*](http://byron.github.io/google-apis-rs/google_games1/struct.RoomReportStatuCall.html) * scores - * [*get*](http://byron.github.io/google-apis-rs/google-games1/struct.ScoreGetCall.html), [*list*](http://byron.github.io/google-apis-rs/google-games1/struct.ScoreListCall.html), [*list window*](http://byron.github.io/google-apis-rs/google-games1/struct.ScoreListWindowCall.html), [*submit*](http://byron.github.io/google-apis-rs/google-games1/struct.ScoreSubmitCall.html) and [*submit multiple*](http://byron.github.io/google-apis-rs/google-games1/struct.ScoreSubmitMultipleCall.html) -* [snapshots](http://byron.github.io/google-apis-rs/google-games1/struct.Snapshot.html) - * [*get*](http://byron.github.io/google-apis-rs/google-games1/struct.SnapshotGetCall.html) and [*list*](http://byron.github.io/google-apis-rs/google-games1/struct.SnapshotListCall.html) + * [*get*](http://byron.github.io/google-apis-rs/google_games1/struct.ScoreGetCall.html), [*list*](http://byron.github.io/google-apis-rs/google_games1/struct.ScoreListCall.html), [*list window*](http://byron.github.io/google-apis-rs/google_games1/struct.ScoreListWindowCall.html), [*submit*](http://byron.github.io/google-apis-rs/google_games1/struct.ScoreSubmitCall.html) and [*submit multiple*](http://byron.github.io/google-apis-rs/google_games1/struct.ScoreSubmitMultipleCall.html) +* [snapshots](http://byron.github.io/google-apis-rs/google_games1/struct.Snapshot.html) + * [*get*](http://byron.github.io/google-apis-rs/google_games1/struct.SnapshotGetCall.html) and [*list*](http://byron.github.io/google-apis-rs/google_games1/struct.SnapshotListCall.html) * turn based matches - * [*cancel*](http://byron.github.io/google-apis-rs/google-games1/struct.TurnBasedMatcheCancelCall.html), [*create*](http://byron.github.io/google-apis-rs/google-games1/struct.TurnBasedMatcheCreateCall.html), [*decline*](http://byron.github.io/google-apis-rs/google-games1/struct.TurnBasedMatcheDeclineCall.html), [*dismiss*](http://byron.github.io/google-apis-rs/google-games1/struct.TurnBasedMatcheDismisCall.html), [*finish*](http://byron.github.io/google-apis-rs/google-games1/struct.TurnBasedMatcheFinishCall.html), [*get*](http://byron.github.io/google-apis-rs/google-games1/struct.TurnBasedMatcheGetCall.html), [*join*](http://byron.github.io/google-apis-rs/google-games1/struct.TurnBasedMatcheJoinCall.html), [*leave*](http://byron.github.io/google-apis-rs/google-games1/struct.TurnBasedMatcheLeaveCall.html), [*leave turn*](http://byron.github.io/google-apis-rs/google-games1/struct.TurnBasedMatcheLeaveTurnCall.html), [*list*](http://byron.github.io/google-apis-rs/google-games1/struct.TurnBasedMatcheListCall.html), [*rematch*](http://byron.github.io/google-apis-rs/google-games1/struct.TurnBasedMatcheRematchCall.html), [*sync*](http://byron.github.io/google-apis-rs/google-games1/struct.TurnBasedMatcheSyncCall.html) and [*take turn*](http://byron.github.io/google-apis-rs/google-games1/struct.TurnBasedMatcheTakeTurnCall.html) + * [*cancel*](http://byron.github.io/google-apis-rs/google_games1/struct.TurnBasedMatcheCancelCall.html), [*create*](http://byron.github.io/google-apis-rs/google_games1/struct.TurnBasedMatcheCreateCall.html), [*decline*](http://byron.github.io/google-apis-rs/google_games1/struct.TurnBasedMatcheDeclineCall.html), [*dismiss*](http://byron.github.io/google-apis-rs/google_games1/struct.TurnBasedMatcheDismisCall.html), [*finish*](http://byron.github.io/google-apis-rs/google_games1/struct.TurnBasedMatcheFinishCall.html), [*get*](http://byron.github.io/google-apis-rs/google_games1/struct.TurnBasedMatcheGetCall.html), [*join*](http://byron.github.io/google-apis-rs/google_games1/struct.TurnBasedMatcheJoinCall.html), [*leave*](http://byron.github.io/google-apis-rs/google_games1/struct.TurnBasedMatcheLeaveCall.html), [*leave turn*](http://byron.github.io/google-apis-rs/google_games1/struct.TurnBasedMatcheLeaveTurnCall.html), [*list*](http://byron.github.io/google-apis-rs/google_games1/struct.TurnBasedMatcheListCall.html), [*rematch*](http://byron.github.io/google-apis-rs/google_games1/struct.TurnBasedMatcheRematchCall.html), [*sync*](http://byron.github.io/google-apis-rs/google_games1/struct.TurnBasedMatcheSyncCall.html) and [*take turn*](http://byron.github.io/google-apis-rs/google_games1/struct.TurnBasedMatcheTakeTurnCall.html) @@ -51,17 +51,17 @@ Handle the following *Resources* with ease from the central [hub](http://byron.g The API is structured into the following primary items: -* **[Hub](http://byron.github.io/google-apis-rs/google-games1/struct.Games.html)** +* **[Hub](http://byron.github.io/google-apis-rs/google_games1/struct.Games.html)** * a central object to maintain state and allow accessing all *Activities* - * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google-games1/trait.MethodsBuilder.html) which in turn - allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google-games1/trait.CallBuilder.html) -* **[Resources](http://byron.github.io/google-apis-rs/google-games1/trait.Resource.html)** + * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google_games1/trait.MethodsBuilder.html) which in turn + allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google_games1/trait.CallBuilder.html) +* **[Resources](http://byron.github.io/google-apis-rs/google_games1/trait.Resource.html)** * primary types that you can apply *Activities* to * a collection of properties and *Parts* - * **[Parts](http://byron.github.io/google-apis-rs/google-games1/trait.Part.html)** + * **[Parts](http://byron.github.io/google-apis-rs/google_games1/trait.Part.html)** * a collection of properties * never directly used in *Activities* -* **[Activities](http://byron.github.io/google-apis-rs/google-games1/trait.CallBuilder.html)** +* **[Activities](http://byron.github.io/google-apis-rs/google_games1/trait.CallBuilder.html)** * operations to apply to *Resources* All *structures* are marked with applicable traits to further categorize them and ease browsing. @@ -149,17 +149,17 @@ match result { ``` ## Handling Errors -All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google-games1/enum.Result.html) enumeration as return value of +All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google_games1/enum.Result.html) enumeration as return value of the doit() methods, or handed as possibly intermediate results to either the -[Hub Delegate](http://byron.github.io/google-apis-rs/google-games1/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google-games1/../yup-oauth2/trait.AuthenticatorDelegate.html). +[Hub Delegate](http://byron.github.io/google-apis-rs/google_games1/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google_games1/../yup-oauth2/trait.AuthenticatorDelegate.html). 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](http://byron.github.io/google-apis-rs/google-games1/enum.Result.html), should be +If a method supports downloads, the response body, which is part of the [Result](http://byron.github.io/google-apis-rs/google_games1/enum.Result.html), should be read by you to obtain the media. -If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google-games1/trait.ResponseResult.html), it will return that by default. +If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google_games1/trait.ResponseResult.html), 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")`. @@ -169,29 +169,29 @@ Methods supporting uploads can do so using up to 2 different protocols: ## Customization and Callbacks -You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google-games1/trait.Delegate.html) to the -[Method Builder](http://byron.github.io/google-apis-rs/google-games1/trait.CallBuilder.html) before making the final `doit()` call. +You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google_games1/trait.Delegate.html) to the +[Method Builder](http://byron.github.io/google-apis-rs/google_games1/trait.CallBuilder.html) 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](http://byron.github.io/google-apis-rs/google-games1/trait.Delegate.html) is default-implemented, allowing you to customize it with minimal effort. +The [delegate trait](http://byron.github.io/google-apis-rs/google_games1/trait.Delegate.html) 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](http://byron.github.io/google-apis-rs/google-games1/trait.RequestValue.html) and -[decodable](http://byron.github.io/google-apis-rs/google-games1/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses +All structures provided by this library are made to be [enocodable](http://byron.github.io/google-apis-rs/google_games1/trait.RequestValue.html) and +[decodable](http://byron.github.io/google-apis-rs/google_games1/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses are valid. -Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google-games1/trait.Part.html) which are identifiable by name, which will be sent to +Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google_games1/trait.Part.html) 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](http://byron.github.io/google-apis-rs/google-games1/trait.CallBuilder.html), you are able to prepare an action call by repeatedly calling it's methods. +Using [method builders](http://byron.github.io/google-apis-rs/google_games1/trait.CallBuilder.html), 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][wiki-pod] are handed by copy * strings are passed as `&str` -* [request values](http://byron.github.io/google-apis-rs/google-games1/trait.RequestValue.html) are borrowed +* [request values](http://byron.github.io/google-apis-rs/google_games1/trait.RequestValue.html) are borrowed Arguments will always be copied or cloned into the builder, to make them independent of their original life times. diff --git a/gen/gamesconfiguration1_configuration/README.md b/gen/gamesconfiguration1_configuration/README.md index 405497c3e6..8724a86102 100644 --- a/gen/gamesconfiguration1_configuration/README.md +++ b/gen/gamesconfiguration1_configuration/README.md @@ -11,19 +11,19 @@ Everything else about the *Games Configuration* *v1_configuration* API can be fo [official documentation site](https://developers.google.com/games/services). # Features -Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google-gamesconfiguration1_configuration/struct.GamesConfiguration.html) ... +Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google_gamesconfiguration1_configuration/struct.GamesConfiguration.html) ... -* [achievement configurations](http://byron.github.io/google-apis-rs/google-gamesconfiguration1_configuration/struct.AchievementConfiguration.html) - * [*delete*](http://byron.github.io/google-apis-rs/google-gamesconfiguration1_configuration/struct.AchievementConfigurationDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google-gamesconfiguration1_configuration/struct.AchievementConfigurationGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google-gamesconfiguration1_configuration/struct.AchievementConfigurationInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google-gamesconfiguration1_configuration/struct.AchievementConfigurationListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google-gamesconfiguration1_configuration/struct.AchievementConfigurationPatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google-gamesconfiguration1_configuration/struct.AchievementConfigurationUpdateCall.html) -* [image configurations](http://byron.github.io/google-apis-rs/google-gamesconfiguration1_configuration/struct.ImageConfiguration.html) - * [*upload*](http://byron.github.io/google-apis-rs/google-gamesconfiguration1_configuration/struct.ImageConfigurationUploadCall.html) -* [leaderboard configurations](http://byron.github.io/google-apis-rs/google-gamesconfiguration1_configuration/struct.LeaderboardConfiguration.html) - * [*delete*](http://byron.github.io/google-apis-rs/google-gamesconfiguration1_configuration/struct.LeaderboardConfigurationDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google-gamesconfiguration1_configuration/struct.LeaderboardConfigurationGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google-gamesconfiguration1_configuration/struct.LeaderboardConfigurationInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google-gamesconfiguration1_configuration/struct.LeaderboardConfigurationListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google-gamesconfiguration1_configuration/struct.LeaderboardConfigurationPatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google-gamesconfiguration1_configuration/struct.LeaderboardConfigurationUpdateCall.html) +* [achievement configurations](http://byron.github.io/google-apis-rs/google_gamesconfiguration1_configuration/struct.AchievementConfiguration.html) + * [*delete*](http://byron.github.io/google-apis-rs/google_gamesconfiguration1_configuration/struct.AchievementConfigurationDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google_gamesconfiguration1_configuration/struct.AchievementConfigurationGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google_gamesconfiguration1_configuration/struct.AchievementConfigurationInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google_gamesconfiguration1_configuration/struct.AchievementConfigurationListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google_gamesconfiguration1_configuration/struct.AchievementConfigurationPatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google_gamesconfiguration1_configuration/struct.AchievementConfigurationUpdateCall.html) +* [image configurations](http://byron.github.io/google-apis-rs/google_gamesconfiguration1_configuration/struct.ImageConfiguration.html) + * [*upload*](http://byron.github.io/google-apis-rs/google_gamesconfiguration1_configuration/struct.ImageConfigurationUploadCall.html) +* [leaderboard configurations](http://byron.github.io/google-apis-rs/google_gamesconfiguration1_configuration/struct.LeaderboardConfiguration.html) + * [*delete*](http://byron.github.io/google-apis-rs/google_gamesconfiguration1_configuration/struct.LeaderboardConfigurationDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google_gamesconfiguration1_configuration/struct.LeaderboardConfigurationGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google_gamesconfiguration1_configuration/struct.LeaderboardConfigurationInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google_gamesconfiguration1_configuration/struct.LeaderboardConfigurationListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google_gamesconfiguration1_configuration/struct.LeaderboardConfigurationPatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google_gamesconfiguration1_configuration/struct.LeaderboardConfigurationUpdateCall.html) Upload supported by ... -* [*upload image configurations*](http://byron.github.io/google-apis-rs/google-gamesconfiguration1_configuration/struct.ImageConfigurationUploadCall.html) +* [*upload image configurations*](http://byron.github.io/google-apis-rs/google_gamesconfiguration1_configuration/struct.ImageConfigurationUploadCall.html) @@ -31,17 +31,17 @@ Upload supported by ... The API is structured into the following primary items: -* **[Hub](http://byron.github.io/google-apis-rs/google-gamesconfiguration1_configuration/struct.GamesConfiguration.html)** +* **[Hub](http://byron.github.io/google-apis-rs/google_gamesconfiguration1_configuration/struct.GamesConfiguration.html)** * a central object to maintain state and allow accessing all *Activities* - * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google-gamesconfiguration1_configuration/trait.MethodsBuilder.html) which in turn - allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google-gamesconfiguration1_configuration/trait.CallBuilder.html) -* **[Resources](http://byron.github.io/google-apis-rs/google-gamesconfiguration1_configuration/trait.Resource.html)** + * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google_gamesconfiguration1_configuration/trait.MethodsBuilder.html) which in turn + allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google_gamesconfiguration1_configuration/trait.CallBuilder.html) +* **[Resources](http://byron.github.io/google-apis-rs/google_gamesconfiguration1_configuration/trait.Resource.html)** * primary types that you can apply *Activities* to * a collection of properties and *Parts* - * **[Parts](http://byron.github.io/google-apis-rs/google-gamesconfiguration1_configuration/trait.Part.html)** + * **[Parts](http://byron.github.io/google-apis-rs/google_gamesconfiguration1_configuration/trait.Part.html)** * a collection of properties * never directly used in *Activities* -* **[Activities](http://byron.github.io/google-apis-rs/google-gamesconfiguration1_configuration/trait.CallBuilder.html)** +* **[Activities](http://byron.github.io/google-apis-rs/google_gamesconfiguration1_configuration/trait.CallBuilder.html)** * operations to apply to *Resources* All *structures* are marked with applicable traits to further categorize them and ease browsing. @@ -127,17 +127,17 @@ match result { ``` ## Handling Errors -All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google-gamesconfiguration1_configuration/enum.Result.html) enumeration as return value of +All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google_gamesconfiguration1_configuration/enum.Result.html) enumeration as return value of the doit() methods, or handed as possibly intermediate results to either the -[Hub Delegate](http://byron.github.io/google-apis-rs/google-gamesconfiguration1_configuration/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google-gamesconfiguration1_configuration/../yup-oauth2/trait.AuthenticatorDelegate.html). +[Hub Delegate](http://byron.github.io/google-apis-rs/google_gamesconfiguration1_configuration/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google_gamesconfiguration1_configuration/../yup-oauth2/trait.AuthenticatorDelegate.html). 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](http://byron.github.io/google-apis-rs/google-gamesconfiguration1_configuration/enum.Result.html), should be +If a method supports downloads, the response body, which is part of the [Result](http://byron.github.io/google-apis-rs/google_gamesconfiguration1_configuration/enum.Result.html), should be read by you to obtain the media. -If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google-gamesconfiguration1_configuration/trait.ResponseResult.html), it will return that by default. +If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google_gamesconfiguration1_configuration/trait.ResponseResult.html), 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")`. @@ -147,29 +147,29 @@ Methods supporting uploads can do so using up to 2 different protocols: ## Customization and Callbacks -You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google-gamesconfiguration1_configuration/trait.Delegate.html) to the -[Method Builder](http://byron.github.io/google-apis-rs/google-gamesconfiguration1_configuration/trait.CallBuilder.html) before making the final `doit()` call. +You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google_gamesconfiguration1_configuration/trait.Delegate.html) to the +[Method Builder](http://byron.github.io/google-apis-rs/google_gamesconfiguration1_configuration/trait.CallBuilder.html) 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](http://byron.github.io/google-apis-rs/google-gamesconfiguration1_configuration/trait.Delegate.html) is default-implemented, allowing you to customize it with minimal effort. +The [delegate trait](http://byron.github.io/google-apis-rs/google_gamesconfiguration1_configuration/trait.Delegate.html) 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](http://byron.github.io/google-apis-rs/google-gamesconfiguration1_configuration/trait.RequestValue.html) and -[decodable](http://byron.github.io/google-apis-rs/google-gamesconfiguration1_configuration/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses +All structures provided by this library are made to be [enocodable](http://byron.github.io/google-apis-rs/google_gamesconfiguration1_configuration/trait.RequestValue.html) and +[decodable](http://byron.github.io/google-apis-rs/google_gamesconfiguration1_configuration/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses are valid. -Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google-gamesconfiguration1_configuration/trait.Part.html) which are identifiable by name, which will be sent to +Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google_gamesconfiguration1_configuration/trait.Part.html) 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](http://byron.github.io/google-apis-rs/google-gamesconfiguration1_configuration/trait.CallBuilder.html), you are able to prepare an action call by repeatedly calling it's methods. +Using [method builders](http://byron.github.io/google-apis-rs/google_gamesconfiguration1_configuration/trait.CallBuilder.html), 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][wiki-pod] are handed by copy * strings are passed as `&str` -* [request values](http://byron.github.io/google-apis-rs/google-gamesconfiguration1_configuration/trait.RequestValue.html) are borrowed +* [request values](http://byron.github.io/google-apis-rs/google_gamesconfiguration1_configuration/trait.RequestValue.html) are borrowed Arguments will always be copied or cloned into the builder, to make them independent of their original life times. diff --git a/gen/gamesmanagement1_management/README.md b/gen/gamesmanagement1_management/README.md index 4b7b1f2437..0112e4c1bd 100644 --- a/gen/gamesmanagement1_management/README.md +++ b/gen/gamesmanagement1_management/README.md @@ -11,24 +11,24 @@ Everything else about the *Games Management* *v1_management* API can be found at [official documentation site](https://developers.google.com/games/services). # Features -Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google-gamesmanagement1_management/struct.GamesManagement.html) ... +Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google_gamesmanagement1_management/struct.GamesManagement.html) ... * achievements - * [*reset*](http://byron.github.io/google-apis-rs/google-gamesmanagement1_management/struct.AchievementResetCall.html), [*reset all*](http://byron.github.io/google-apis-rs/google-gamesmanagement1_management/struct.AchievementResetAllCall.html), [*reset all for all players*](http://byron.github.io/google-apis-rs/google-gamesmanagement1_management/struct.AchievementResetAllForAllPlayerCall.html), [*reset for all players*](http://byron.github.io/google-apis-rs/google-gamesmanagement1_management/struct.AchievementResetForAllPlayerCall.html) and [*reset multiple for all players*](http://byron.github.io/google-apis-rs/google-gamesmanagement1_management/struct.AchievementResetMultipleForAllPlayerCall.html) + * [*reset*](http://byron.github.io/google-apis-rs/google_gamesmanagement1_management/struct.AchievementResetCall.html), [*reset all*](http://byron.github.io/google-apis-rs/google_gamesmanagement1_management/struct.AchievementResetAllCall.html), [*reset all for all players*](http://byron.github.io/google-apis-rs/google_gamesmanagement1_management/struct.AchievementResetAllForAllPlayerCall.html), [*reset for all players*](http://byron.github.io/google-apis-rs/google_gamesmanagement1_management/struct.AchievementResetForAllPlayerCall.html) and [*reset multiple for all players*](http://byron.github.io/google-apis-rs/google_gamesmanagement1_management/struct.AchievementResetMultipleForAllPlayerCall.html) * applications - * [*list hidden*](http://byron.github.io/google-apis-rs/google-gamesmanagement1_management/struct.ApplicationListHiddenCall.html) + * [*list hidden*](http://byron.github.io/google-apis-rs/google_gamesmanagement1_management/struct.ApplicationListHiddenCall.html) * events - * [*reset*](http://byron.github.io/google-apis-rs/google-gamesmanagement1_management/struct.EventResetCall.html), [*reset all*](http://byron.github.io/google-apis-rs/google-gamesmanagement1_management/struct.EventResetAllCall.html), [*reset all for all players*](http://byron.github.io/google-apis-rs/google-gamesmanagement1_management/struct.EventResetAllForAllPlayerCall.html), [*reset for all players*](http://byron.github.io/google-apis-rs/google-gamesmanagement1_management/struct.EventResetForAllPlayerCall.html) and [*reset multiple for all players*](http://byron.github.io/google-apis-rs/google-gamesmanagement1_management/struct.EventResetMultipleForAllPlayerCall.html) -* [players](http://byron.github.io/google-apis-rs/google-gamesmanagement1_management/struct.Player.html) - * [*hide*](http://byron.github.io/google-apis-rs/google-gamesmanagement1_management/struct.PlayerHideCall.html) and [*unhide*](http://byron.github.io/google-apis-rs/google-gamesmanagement1_management/struct.PlayerUnhideCall.html) + * [*reset*](http://byron.github.io/google-apis-rs/google_gamesmanagement1_management/struct.EventResetCall.html), [*reset all*](http://byron.github.io/google-apis-rs/google_gamesmanagement1_management/struct.EventResetAllCall.html), [*reset all for all players*](http://byron.github.io/google-apis-rs/google_gamesmanagement1_management/struct.EventResetAllForAllPlayerCall.html), [*reset for all players*](http://byron.github.io/google-apis-rs/google_gamesmanagement1_management/struct.EventResetForAllPlayerCall.html) and [*reset multiple for all players*](http://byron.github.io/google-apis-rs/google_gamesmanagement1_management/struct.EventResetMultipleForAllPlayerCall.html) +* [players](http://byron.github.io/google-apis-rs/google_gamesmanagement1_management/struct.Player.html) + * [*hide*](http://byron.github.io/google-apis-rs/google_gamesmanagement1_management/struct.PlayerHideCall.html) and [*unhide*](http://byron.github.io/google-apis-rs/google_gamesmanagement1_management/struct.PlayerUnhideCall.html) * quests - * [*reset*](http://byron.github.io/google-apis-rs/google-gamesmanagement1_management/struct.QuestResetCall.html), [*reset all*](http://byron.github.io/google-apis-rs/google-gamesmanagement1_management/struct.QuestResetAllCall.html), [*reset all for all players*](http://byron.github.io/google-apis-rs/google-gamesmanagement1_management/struct.QuestResetAllForAllPlayerCall.html), [*reset for all players*](http://byron.github.io/google-apis-rs/google-gamesmanagement1_management/struct.QuestResetForAllPlayerCall.html) and [*reset multiple for all players*](http://byron.github.io/google-apis-rs/google-gamesmanagement1_management/struct.QuestResetMultipleForAllPlayerCall.html) + * [*reset*](http://byron.github.io/google-apis-rs/google_gamesmanagement1_management/struct.QuestResetCall.html), [*reset all*](http://byron.github.io/google-apis-rs/google_gamesmanagement1_management/struct.QuestResetAllCall.html), [*reset all for all players*](http://byron.github.io/google-apis-rs/google_gamesmanagement1_management/struct.QuestResetAllForAllPlayerCall.html), [*reset for all players*](http://byron.github.io/google-apis-rs/google_gamesmanagement1_management/struct.QuestResetForAllPlayerCall.html) and [*reset multiple for all players*](http://byron.github.io/google-apis-rs/google_gamesmanagement1_management/struct.QuestResetMultipleForAllPlayerCall.html) * rooms - * [*reset*](http://byron.github.io/google-apis-rs/google-gamesmanagement1_management/struct.RoomResetCall.html) and [*reset for all players*](http://byron.github.io/google-apis-rs/google-gamesmanagement1_management/struct.RoomResetForAllPlayerCall.html) + * [*reset*](http://byron.github.io/google-apis-rs/google_gamesmanagement1_management/struct.RoomResetCall.html) and [*reset for all players*](http://byron.github.io/google-apis-rs/google_gamesmanagement1_management/struct.RoomResetForAllPlayerCall.html) * scores - * [*reset*](http://byron.github.io/google-apis-rs/google-gamesmanagement1_management/struct.ScoreResetCall.html), [*reset all*](http://byron.github.io/google-apis-rs/google-gamesmanagement1_management/struct.ScoreResetAllCall.html), [*reset all for all players*](http://byron.github.io/google-apis-rs/google-gamesmanagement1_management/struct.ScoreResetAllForAllPlayerCall.html), [*reset for all players*](http://byron.github.io/google-apis-rs/google-gamesmanagement1_management/struct.ScoreResetForAllPlayerCall.html) and [*reset multiple for all players*](http://byron.github.io/google-apis-rs/google-gamesmanagement1_management/struct.ScoreResetMultipleForAllPlayerCall.html) + * [*reset*](http://byron.github.io/google-apis-rs/google_gamesmanagement1_management/struct.ScoreResetCall.html), [*reset all*](http://byron.github.io/google-apis-rs/google_gamesmanagement1_management/struct.ScoreResetAllCall.html), [*reset all for all players*](http://byron.github.io/google-apis-rs/google_gamesmanagement1_management/struct.ScoreResetAllForAllPlayerCall.html), [*reset for all players*](http://byron.github.io/google-apis-rs/google_gamesmanagement1_management/struct.ScoreResetForAllPlayerCall.html) and [*reset multiple for all players*](http://byron.github.io/google-apis-rs/google_gamesmanagement1_management/struct.ScoreResetMultipleForAllPlayerCall.html) * turn based matches - * [*reset*](http://byron.github.io/google-apis-rs/google-gamesmanagement1_management/struct.TurnBasedMatcheResetCall.html) and [*reset for all players*](http://byron.github.io/google-apis-rs/google-gamesmanagement1_management/struct.TurnBasedMatcheResetForAllPlayerCall.html) + * [*reset*](http://byron.github.io/google-apis-rs/google_gamesmanagement1_management/struct.TurnBasedMatcheResetCall.html) and [*reset for all players*](http://byron.github.io/google-apis-rs/google_gamesmanagement1_management/struct.TurnBasedMatcheResetForAllPlayerCall.html) @@ -37,17 +37,17 @@ Handle the following *Resources* with ease from the central [hub](http://byron.g The API is structured into the following primary items: -* **[Hub](http://byron.github.io/google-apis-rs/google-gamesmanagement1_management/struct.GamesManagement.html)** +* **[Hub](http://byron.github.io/google-apis-rs/google_gamesmanagement1_management/struct.GamesManagement.html)** * a central object to maintain state and allow accessing all *Activities* - * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google-gamesmanagement1_management/trait.MethodsBuilder.html) which in turn - allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google-gamesmanagement1_management/trait.CallBuilder.html) -* **[Resources](http://byron.github.io/google-apis-rs/google-gamesmanagement1_management/trait.Resource.html)** + * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google_gamesmanagement1_management/trait.MethodsBuilder.html) which in turn + allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google_gamesmanagement1_management/trait.CallBuilder.html) +* **[Resources](http://byron.github.io/google-apis-rs/google_gamesmanagement1_management/trait.Resource.html)** * primary types that you can apply *Activities* to * a collection of properties and *Parts* - * **[Parts](http://byron.github.io/google-apis-rs/google-gamesmanagement1_management/trait.Part.html)** + * **[Parts](http://byron.github.io/google-apis-rs/google_gamesmanagement1_management/trait.Part.html)** * a collection of properties * never directly used in *Activities* -* **[Activities](http://byron.github.io/google-apis-rs/google-gamesmanagement1_management/trait.CallBuilder.html)** +* **[Activities](http://byron.github.io/google-apis-rs/google_gamesmanagement1_management/trait.CallBuilder.html)** * operations to apply to *Resources* All *structures* are marked with applicable traits to further categorize them and ease browsing. @@ -127,17 +127,17 @@ match result { ``` ## Handling Errors -All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google-gamesmanagement1_management/enum.Result.html) enumeration as return value of +All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google_gamesmanagement1_management/enum.Result.html) enumeration as return value of the doit() methods, or handed as possibly intermediate results to either the -[Hub Delegate](http://byron.github.io/google-apis-rs/google-gamesmanagement1_management/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google-gamesmanagement1_management/../yup-oauth2/trait.AuthenticatorDelegate.html). +[Hub Delegate](http://byron.github.io/google-apis-rs/google_gamesmanagement1_management/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google_gamesmanagement1_management/../yup-oauth2/trait.AuthenticatorDelegate.html). 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](http://byron.github.io/google-apis-rs/google-gamesmanagement1_management/enum.Result.html), should be +If a method supports downloads, the response body, which is part of the [Result](http://byron.github.io/google-apis-rs/google_gamesmanagement1_management/enum.Result.html), should be read by you to obtain the media. -If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google-gamesmanagement1_management/trait.ResponseResult.html), it will return that by default. +If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google_gamesmanagement1_management/trait.ResponseResult.html), 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")`. @@ -147,29 +147,29 @@ Methods supporting uploads can do so using up to 2 different protocols: ## Customization and Callbacks -You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google-gamesmanagement1_management/trait.Delegate.html) to the -[Method Builder](http://byron.github.io/google-apis-rs/google-gamesmanagement1_management/trait.CallBuilder.html) before making the final `doit()` call. +You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google_gamesmanagement1_management/trait.Delegate.html) to the +[Method Builder](http://byron.github.io/google-apis-rs/google_gamesmanagement1_management/trait.CallBuilder.html) 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](http://byron.github.io/google-apis-rs/google-gamesmanagement1_management/trait.Delegate.html) is default-implemented, allowing you to customize it with minimal effort. +The [delegate trait](http://byron.github.io/google-apis-rs/google_gamesmanagement1_management/trait.Delegate.html) 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](http://byron.github.io/google-apis-rs/google-gamesmanagement1_management/trait.RequestValue.html) and -[decodable](http://byron.github.io/google-apis-rs/google-gamesmanagement1_management/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses +All structures provided by this library are made to be [enocodable](http://byron.github.io/google-apis-rs/google_gamesmanagement1_management/trait.RequestValue.html) and +[decodable](http://byron.github.io/google-apis-rs/google_gamesmanagement1_management/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses are valid. -Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google-gamesmanagement1_management/trait.Part.html) which are identifiable by name, which will be sent to +Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google_gamesmanagement1_management/trait.Part.html) 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](http://byron.github.io/google-apis-rs/google-gamesmanagement1_management/trait.CallBuilder.html), you are able to prepare an action call by repeatedly calling it's methods. +Using [method builders](http://byron.github.io/google-apis-rs/google_gamesmanagement1_management/trait.CallBuilder.html), 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][wiki-pod] are handed by copy * strings are passed as `&str` -* [request values](http://byron.github.io/google-apis-rs/google-gamesmanagement1_management/trait.RequestValue.html) are borrowed +* [request values](http://byron.github.io/google-apis-rs/google_gamesmanagement1_management/trait.RequestValue.html) are borrowed Arguments will always be copied or cloned into the builder, to make them independent of their original life times. diff --git a/gen/gan1_beta1/README.md b/gen/gan1_beta1/README.md index 5d1df09d5c..de941bfdb1 100644 --- a/gen/gan1_beta1/README.md +++ b/gen/gan1_beta1/README.md @@ -11,20 +11,20 @@ Everything else about the *gan* *v1_beta1* API can be found at the [official documentation site](https://developers.google.com/affiliate-network/). # Features -Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google-gan1_beta1/struct.Gan.html) ... +Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google_gan1_beta1/struct.Gan.html) ... -* [advertisers](http://byron.github.io/google-apis-rs/google-gan1_beta1/struct.Advertiser.html) - * [*get*](http://byron.github.io/google-apis-rs/google-gan1_beta1/struct.AdvertiserGetCall.html) and [*list*](http://byron.github.io/google-apis-rs/google-gan1_beta1/struct.AdvertiserListCall.html) -* [cc offers](http://byron.github.io/google-apis-rs/google-gan1_beta1/struct.CcOffer.html) - * [*list*](http://byron.github.io/google-apis-rs/google-gan1_beta1/struct.CcOfferListCall.html) -* [events](http://byron.github.io/google-apis-rs/google-gan1_beta1/struct.Event.html) - * [*list*](http://byron.github.io/google-apis-rs/google-gan1_beta1/struct.EventListCall.html) -* [links](http://byron.github.io/google-apis-rs/google-gan1_beta1/struct.Link.html) - * [*get*](http://byron.github.io/google-apis-rs/google-gan1_beta1/struct.LinkGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google-gan1_beta1/struct.LinkInsertCall.html) and [*list*](http://byron.github.io/google-apis-rs/google-gan1_beta1/struct.LinkListCall.html) -* [publishers](http://byron.github.io/google-apis-rs/google-gan1_beta1/struct.Publisher.html) - * [*get*](http://byron.github.io/google-apis-rs/google-gan1_beta1/struct.PublisherGetCall.html) and [*list*](http://byron.github.io/google-apis-rs/google-gan1_beta1/struct.PublisherListCall.html) -* [reports](http://byron.github.io/google-apis-rs/google-gan1_beta1/struct.Report.html) - * [*get*](http://byron.github.io/google-apis-rs/google-gan1_beta1/struct.ReportGetCall.html) +* [advertisers](http://byron.github.io/google-apis-rs/google_gan1_beta1/struct.Advertiser.html) + * [*get*](http://byron.github.io/google-apis-rs/google_gan1_beta1/struct.AdvertiserGetCall.html) and [*list*](http://byron.github.io/google-apis-rs/google_gan1_beta1/struct.AdvertiserListCall.html) +* [cc offers](http://byron.github.io/google-apis-rs/google_gan1_beta1/struct.CcOffer.html) + * [*list*](http://byron.github.io/google-apis-rs/google_gan1_beta1/struct.CcOfferListCall.html) +* [events](http://byron.github.io/google-apis-rs/google_gan1_beta1/struct.Event.html) + * [*list*](http://byron.github.io/google-apis-rs/google_gan1_beta1/struct.EventListCall.html) +* [links](http://byron.github.io/google-apis-rs/google_gan1_beta1/struct.Link.html) + * [*get*](http://byron.github.io/google-apis-rs/google_gan1_beta1/struct.LinkGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google_gan1_beta1/struct.LinkInsertCall.html) and [*list*](http://byron.github.io/google-apis-rs/google_gan1_beta1/struct.LinkListCall.html) +* [publishers](http://byron.github.io/google-apis-rs/google_gan1_beta1/struct.Publisher.html) + * [*get*](http://byron.github.io/google-apis-rs/google_gan1_beta1/struct.PublisherGetCall.html) and [*list*](http://byron.github.io/google-apis-rs/google_gan1_beta1/struct.PublisherListCall.html) +* [reports](http://byron.github.io/google-apis-rs/google_gan1_beta1/struct.Report.html) + * [*get*](http://byron.github.io/google-apis-rs/google_gan1_beta1/struct.ReportGetCall.html) @@ -33,17 +33,17 @@ Handle the following *Resources* with ease from the central [hub](http://byron.g The API is structured into the following primary items: -* **[Hub](http://byron.github.io/google-apis-rs/google-gan1_beta1/struct.Gan.html)** +* **[Hub](http://byron.github.io/google-apis-rs/google_gan1_beta1/struct.Gan.html)** * a central object to maintain state and allow accessing all *Activities* - * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google-gan1_beta1/trait.MethodsBuilder.html) which in turn - allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google-gan1_beta1/trait.CallBuilder.html) -* **[Resources](http://byron.github.io/google-apis-rs/google-gan1_beta1/trait.Resource.html)** + * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google_gan1_beta1/trait.MethodsBuilder.html) which in turn + allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google_gan1_beta1/trait.CallBuilder.html) +* **[Resources](http://byron.github.io/google-apis-rs/google_gan1_beta1/trait.Resource.html)** * primary types that you can apply *Activities* to * a collection of properties and *Parts* - * **[Parts](http://byron.github.io/google-apis-rs/google-gan1_beta1/trait.Part.html)** + * **[Parts](http://byron.github.io/google-apis-rs/google_gan1_beta1/trait.Part.html)** * a collection of properties * never directly used in *Activities* -* **[Activities](http://byron.github.io/google-apis-rs/google-gan1_beta1/trait.CallBuilder.html)** +* **[Activities](http://byron.github.io/google-apis-rs/google_gan1_beta1/trait.CallBuilder.html)** * operations to apply to *Resources* All *structures* are marked with applicable traits to further categorize them and ease browsing. @@ -137,17 +137,17 @@ match result { ``` ## Handling Errors -All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google-gan1_beta1/enum.Result.html) enumeration as return value of +All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google_gan1_beta1/enum.Result.html) enumeration as return value of the doit() methods, or handed as possibly intermediate results to either the -[Hub Delegate](http://byron.github.io/google-apis-rs/google-gan1_beta1/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google-gan1_beta1/../yup-oauth2/trait.AuthenticatorDelegate.html). +[Hub Delegate](http://byron.github.io/google-apis-rs/google_gan1_beta1/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google_gan1_beta1/../yup-oauth2/trait.AuthenticatorDelegate.html). 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](http://byron.github.io/google-apis-rs/google-gan1_beta1/enum.Result.html), should be +If a method supports downloads, the response body, which is part of the [Result](http://byron.github.io/google-apis-rs/google_gan1_beta1/enum.Result.html), should be read by you to obtain the media. -If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google-gan1_beta1/trait.ResponseResult.html), it will return that by default. +If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google_gan1_beta1/trait.ResponseResult.html), 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")`. @@ -157,29 +157,29 @@ Methods supporting uploads can do so using up to 2 different protocols: ## Customization and Callbacks -You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google-gan1_beta1/trait.Delegate.html) to the -[Method Builder](http://byron.github.io/google-apis-rs/google-gan1_beta1/trait.CallBuilder.html) before making the final `doit()` call. +You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google_gan1_beta1/trait.Delegate.html) to the +[Method Builder](http://byron.github.io/google-apis-rs/google_gan1_beta1/trait.CallBuilder.html) 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](http://byron.github.io/google-apis-rs/google-gan1_beta1/trait.Delegate.html) is default-implemented, allowing you to customize it with minimal effort. +The [delegate trait](http://byron.github.io/google-apis-rs/google_gan1_beta1/trait.Delegate.html) 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](http://byron.github.io/google-apis-rs/google-gan1_beta1/trait.RequestValue.html) and -[decodable](http://byron.github.io/google-apis-rs/google-gan1_beta1/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses +All structures provided by this library are made to be [enocodable](http://byron.github.io/google-apis-rs/google_gan1_beta1/trait.RequestValue.html) and +[decodable](http://byron.github.io/google-apis-rs/google_gan1_beta1/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses are valid. -Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google-gan1_beta1/trait.Part.html) which are identifiable by name, which will be sent to +Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google_gan1_beta1/trait.Part.html) 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](http://byron.github.io/google-apis-rs/google-gan1_beta1/trait.CallBuilder.html), you are able to prepare an action call by repeatedly calling it's methods. +Using [method builders](http://byron.github.io/google-apis-rs/google_gan1_beta1/trait.CallBuilder.html), 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][wiki-pod] are handed by copy * strings are passed as `&str` -* [request values](http://byron.github.io/google-apis-rs/google-gan1_beta1/trait.RequestValue.html) are borrowed +* [request values](http://byron.github.io/google-apis-rs/google_gan1_beta1/trait.RequestValue.html) are borrowed Arguments will always be copied or cloned into the builder, to make them independent of their original life times. diff --git a/gen/genomics1_beta2/README.md b/gen/genomics1_beta2/README.md index 488febbac8..08217bf3cb 100644 --- a/gen/genomics1_beta2/README.md +++ b/gen/genomics1_beta2/README.md @@ -11,34 +11,34 @@ Everything else about the *genomics* *v1_beta2* API can be found at the [official documentation site](https://developers.google.com/genomics/v1beta2/reference). # Features -Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google-genomics1_beta2/struct.Genomics.html) ... +Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google_genomics1_beta2/struct.Genomics.html) ... -* [annotation sets](http://byron.github.io/google-apis-rs/google-genomics1_beta2/struct.AnnotationSet.html) - * [*create*](http://byron.github.io/google-apis-rs/google-genomics1_beta2/struct.AnnotationSetCreateCall.html), [*delete*](http://byron.github.io/google-apis-rs/google-genomics1_beta2/struct.AnnotationSetDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google-genomics1_beta2/struct.AnnotationSetGetCall.html), [*patch*](http://byron.github.io/google-apis-rs/google-genomics1_beta2/struct.AnnotationSetPatchCall.html), [*search*](http://byron.github.io/google-apis-rs/google-genomics1_beta2/struct.AnnotationSetSearchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google-genomics1_beta2/struct.AnnotationSetUpdateCall.html) -* [annotations](http://byron.github.io/google-apis-rs/google-genomics1_beta2/struct.Annotation.html) - * [*batch create*](http://byron.github.io/google-apis-rs/google-genomics1_beta2/struct.AnnotationBatchCreateCall.html), [*create*](http://byron.github.io/google-apis-rs/google-genomics1_beta2/struct.AnnotationCreateCall.html), [*delete*](http://byron.github.io/google-apis-rs/google-genomics1_beta2/struct.AnnotationDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google-genomics1_beta2/struct.AnnotationGetCall.html), [*patch*](http://byron.github.io/google-apis-rs/google-genomics1_beta2/struct.AnnotationPatchCall.html), [*search*](http://byron.github.io/google-apis-rs/google-genomics1_beta2/struct.AnnotationSearchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google-genomics1_beta2/struct.AnnotationUpdateCall.html) +* [annotation sets](http://byron.github.io/google-apis-rs/google_genomics1_beta2/struct.AnnotationSet.html) + * [*create*](http://byron.github.io/google-apis-rs/google_genomics1_beta2/struct.AnnotationSetCreateCall.html), [*delete*](http://byron.github.io/google-apis-rs/google_genomics1_beta2/struct.AnnotationSetDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google_genomics1_beta2/struct.AnnotationSetGetCall.html), [*patch*](http://byron.github.io/google-apis-rs/google_genomics1_beta2/struct.AnnotationSetPatchCall.html), [*search*](http://byron.github.io/google-apis-rs/google_genomics1_beta2/struct.AnnotationSetSearchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google_genomics1_beta2/struct.AnnotationSetUpdateCall.html) +* [annotations](http://byron.github.io/google-apis-rs/google_genomics1_beta2/struct.Annotation.html) + * [*batch create*](http://byron.github.io/google-apis-rs/google_genomics1_beta2/struct.AnnotationBatchCreateCall.html), [*create*](http://byron.github.io/google-apis-rs/google_genomics1_beta2/struct.AnnotationCreateCall.html), [*delete*](http://byron.github.io/google-apis-rs/google_genomics1_beta2/struct.AnnotationDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google_genomics1_beta2/struct.AnnotationGetCall.html), [*patch*](http://byron.github.io/google-apis-rs/google_genomics1_beta2/struct.AnnotationPatchCall.html), [*search*](http://byron.github.io/google-apis-rs/google_genomics1_beta2/struct.AnnotationSearchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google_genomics1_beta2/struct.AnnotationUpdateCall.html) * callsets - * [*create*](http://byron.github.io/google-apis-rs/google-genomics1_beta2/struct.CallsetCreateCall.html), [*delete*](http://byron.github.io/google-apis-rs/google-genomics1_beta2/struct.CallsetDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google-genomics1_beta2/struct.CallsetGetCall.html), [*patch*](http://byron.github.io/google-apis-rs/google-genomics1_beta2/struct.CallsetPatchCall.html), [*search*](http://byron.github.io/google-apis-rs/google-genomics1_beta2/struct.CallsetSearchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google-genomics1_beta2/struct.CallsetUpdateCall.html) -* [datasets](http://byron.github.io/google-apis-rs/google-genomics1_beta2/struct.Dataset.html) - * [*create*](http://byron.github.io/google-apis-rs/google-genomics1_beta2/struct.DatasetCreateCall.html), [*delete*](http://byron.github.io/google-apis-rs/google-genomics1_beta2/struct.DatasetDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google-genomics1_beta2/struct.DatasetGetCall.html), [*list*](http://byron.github.io/google-apis-rs/google-genomics1_beta2/struct.DatasetListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google-genomics1_beta2/struct.DatasetPatchCall.html), [*undelete*](http://byron.github.io/google-apis-rs/google-genomics1_beta2/struct.DatasetUndeleteCall.html) and [*update*](http://byron.github.io/google-apis-rs/google-genomics1_beta2/struct.DatasetUpdateCall.html) + * [*create*](http://byron.github.io/google-apis-rs/google_genomics1_beta2/struct.CallsetCreateCall.html), [*delete*](http://byron.github.io/google-apis-rs/google_genomics1_beta2/struct.CallsetDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google_genomics1_beta2/struct.CallsetGetCall.html), [*patch*](http://byron.github.io/google-apis-rs/google_genomics1_beta2/struct.CallsetPatchCall.html), [*search*](http://byron.github.io/google-apis-rs/google_genomics1_beta2/struct.CallsetSearchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google_genomics1_beta2/struct.CallsetUpdateCall.html) +* [datasets](http://byron.github.io/google-apis-rs/google_genomics1_beta2/struct.Dataset.html) + * [*create*](http://byron.github.io/google-apis-rs/google_genomics1_beta2/struct.DatasetCreateCall.html), [*delete*](http://byron.github.io/google-apis-rs/google_genomics1_beta2/struct.DatasetDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google_genomics1_beta2/struct.DatasetGetCall.html), [*list*](http://byron.github.io/google-apis-rs/google_genomics1_beta2/struct.DatasetListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google_genomics1_beta2/struct.DatasetPatchCall.html), [*undelete*](http://byron.github.io/google-apis-rs/google_genomics1_beta2/struct.DatasetUndeleteCall.html) and [*update*](http://byron.github.io/google-apis-rs/google_genomics1_beta2/struct.DatasetUpdateCall.html) * experimental - * [*jobs create*](http://byron.github.io/google-apis-rs/google-genomics1_beta2/struct.ExperimentalJobCreateCall.html) -* [jobs](http://byron.github.io/google-apis-rs/google-genomics1_beta2/struct.Job.html) - * [*cancel*](http://byron.github.io/google-apis-rs/google-genomics1_beta2/struct.JobCancelCall.html), [*get*](http://byron.github.io/google-apis-rs/google-genomics1_beta2/struct.JobGetCall.html) and [*search*](http://byron.github.io/google-apis-rs/google-genomics1_beta2/struct.JobSearchCall.html) + * [*jobs create*](http://byron.github.io/google-apis-rs/google_genomics1_beta2/struct.ExperimentalJobCreateCall.html) +* [jobs](http://byron.github.io/google-apis-rs/google_genomics1_beta2/struct.Job.html) + * [*cancel*](http://byron.github.io/google-apis-rs/google_genomics1_beta2/struct.JobCancelCall.html), [*get*](http://byron.github.io/google-apis-rs/google_genomics1_beta2/struct.JobGetCall.html) and [*search*](http://byron.github.io/google-apis-rs/google_genomics1_beta2/struct.JobSearchCall.html) * readgroupsets - * [*align*](http://byron.github.io/google-apis-rs/google-genomics1_beta2/struct.ReadgroupsetAlignCall.html), [*call*](http://byron.github.io/google-apis-rs/google-genomics1_beta2/struct.ReadgroupsetCallCall.html), [*coveragebuckets list*](http://byron.github.io/google-apis-rs/google-genomics1_beta2/struct.ReadgroupsetCoveragebucketListCall.html), [*delete*](http://byron.github.io/google-apis-rs/google-genomics1_beta2/struct.ReadgroupsetDeleteCall.html), [*export*](http://byron.github.io/google-apis-rs/google-genomics1_beta2/struct.ReadgroupsetExportCall.html), [*get*](http://byron.github.io/google-apis-rs/google-genomics1_beta2/struct.ReadgroupsetGetCall.html), [*import*](http://byron.github.io/google-apis-rs/google-genomics1_beta2/struct.ReadgroupsetImportCall.html), [*patch*](http://byron.github.io/google-apis-rs/google-genomics1_beta2/struct.ReadgroupsetPatchCall.html), [*search*](http://byron.github.io/google-apis-rs/google-genomics1_beta2/struct.ReadgroupsetSearchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google-genomics1_beta2/struct.ReadgroupsetUpdateCall.html) -* [reads](http://byron.github.io/google-apis-rs/google-genomics1_beta2/struct.Read.html) - * [*search*](http://byron.github.io/google-apis-rs/google-genomics1_beta2/struct.ReadSearchCall.html) -* [references](http://byron.github.io/google-apis-rs/google-genomics1_beta2/struct.Reference.html) - * [*bases list*](http://byron.github.io/google-apis-rs/google-genomics1_beta2/struct.ReferenceBaseListCall.html), [*get*](http://byron.github.io/google-apis-rs/google-genomics1_beta2/struct.ReferenceGetCall.html) and [*search*](http://byron.github.io/google-apis-rs/google-genomics1_beta2/struct.ReferenceSearchCall.html) + * [*align*](http://byron.github.io/google-apis-rs/google_genomics1_beta2/struct.ReadgroupsetAlignCall.html), [*call*](http://byron.github.io/google-apis-rs/google_genomics1_beta2/struct.ReadgroupsetCallCall.html), [*coveragebuckets list*](http://byron.github.io/google-apis-rs/google_genomics1_beta2/struct.ReadgroupsetCoveragebucketListCall.html), [*delete*](http://byron.github.io/google-apis-rs/google_genomics1_beta2/struct.ReadgroupsetDeleteCall.html), [*export*](http://byron.github.io/google-apis-rs/google_genomics1_beta2/struct.ReadgroupsetExportCall.html), [*get*](http://byron.github.io/google-apis-rs/google_genomics1_beta2/struct.ReadgroupsetGetCall.html), [*import*](http://byron.github.io/google-apis-rs/google_genomics1_beta2/struct.ReadgroupsetImportCall.html), [*patch*](http://byron.github.io/google-apis-rs/google_genomics1_beta2/struct.ReadgroupsetPatchCall.html), [*search*](http://byron.github.io/google-apis-rs/google_genomics1_beta2/struct.ReadgroupsetSearchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google_genomics1_beta2/struct.ReadgroupsetUpdateCall.html) +* [reads](http://byron.github.io/google-apis-rs/google_genomics1_beta2/struct.Read.html) + * [*search*](http://byron.github.io/google-apis-rs/google_genomics1_beta2/struct.ReadSearchCall.html) +* [references](http://byron.github.io/google-apis-rs/google_genomics1_beta2/struct.Reference.html) + * [*bases list*](http://byron.github.io/google-apis-rs/google_genomics1_beta2/struct.ReferenceBaseListCall.html), [*get*](http://byron.github.io/google-apis-rs/google_genomics1_beta2/struct.ReferenceGetCall.html) and [*search*](http://byron.github.io/google-apis-rs/google_genomics1_beta2/struct.ReferenceSearchCall.html) * referencesets - * [*get*](http://byron.github.io/google-apis-rs/google-genomics1_beta2/struct.ReferencesetGetCall.html) and [*search*](http://byron.github.io/google-apis-rs/google-genomics1_beta2/struct.ReferencesetSearchCall.html) + * [*get*](http://byron.github.io/google-apis-rs/google_genomics1_beta2/struct.ReferencesetGetCall.html) and [*search*](http://byron.github.io/google-apis-rs/google_genomics1_beta2/struct.ReferencesetSearchCall.html) * streaming variant store - * [*streamvariants*](http://byron.github.io/google-apis-rs/google-genomics1_beta2/struct.StreamingVariantStoreStreamvariantCall.html) -* [variants](http://byron.github.io/google-apis-rs/google-genomics1_beta2/struct.Variant.html) - * [*create*](http://byron.github.io/google-apis-rs/google-genomics1_beta2/struct.VariantCreateCall.html), [*delete*](http://byron.github.io/google-apis-rs/google-genomics1_beta2/struct.VariantDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google-genomics1_beta2/struct.VariantGetCall.html), [*search*](http://byron.github.io/google-apis-rs/google-genomics1_beta2/struct.VariantSearchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google-genomics1_beta2/struct.VariantUpdateCall.html) + * [*streamvariants*](http://byron.github.io/google-apis-rs/google_genomics1_beta2/struct.StreamingVariantStoreStreamvariantCall.html) +* [variants](http://byron.github.io/google-apis-rs/google_genomics1_beta2/struct.Variant.html) + * [*create*](http://byron.github.io/google-apis-rs/google_genomics1_beta2/struct.VariantCreateCall.html), [*delete*](http://byron.github.io/google-apis-rs/google_genomics1_beta2/struct.VariantDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google_genomics1_beta2/struct.VariantGetCall.html), [*search*](http://byron.github.io/google-apis-rs/google_genomics1_beta2/struct.VariantSearchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google_genomics1_beta2/struct.VariantUpdateCall.html) * variantsets - * [*delete*](http://byron.github.io/google-apis-rs/google-genomics1_beta2/struct.VariantsetDeleteCall.html), [*export*](http://byron.github.io/google-apis-rs/google-genomics1_beta2/struct.VariantsetExportCall.html), [*get*](http://byron.github.io/google-apis-rs/google-genomics1_beta2/struct.VariantsetGetCall.html), [*import variants*](http://byron.github.io/google-apis-rs/google-genomics1_beta2/struct.VariantsetImportVariantCall.html), [*merge variants*](http://byron.github.io/google-apis-rs/google-genomics1_beta2/struct.VariantsetMergeVariantCall.html), [*patch*](http://byron.github.io/google-apis-rs/google-genomics1_beta2/struct.VariantsetPatchCall.html), [*search*](http://byron.github.io/google-apis-rs/google-genomics1_beta2/struct.VariantsetSearchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google-genomics1_beta2/struct.VariantsetUpdateCall.html) + * [*delete*](http://byron.github.io/google-apis-rs/google_genomics1_beta2/struct.VariantsetDeleteCall.html), [*export*](http://byron.github.io/google-apis-rs/google_genomics1_beta2/struct.VariantsetExportCall.html), [*get*](http://byron.github.io/google-apis-rs/google_genomics1_beta2/struct.VariantsetGetCall.html), [*import variants*](http://byron.github.io/google-apis-rs/google_genomics1_beta2/struct.VariantsetImportVariantCall.html), [*merge variants*](http://byron.github.io/google-apis-rs/google_genomics1_beta2/struct.VariantsetMergeVariantCall.html), [*patch*](http://byron.github.io/google-apis-rs/google_genomics1_beta2/struct.VariantsetPatchCall.html), [*search*](http://byron.github.io/google-apis-rs/google_genomics1_beta2/struct.VariantsetSearchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google_genomics1_beta2/struct.VariantsetUpdateCall.html) @@ -47,17 +47,17 @@ Handle the following *Resources* with ease from the central [hub](http://byron.g The API is structured into the following primary items: -* **[Hub](http://byron.github.io/google-apis-rs/google-genomics1_beta2/struct.Genomics.html)** +* **[Hub](http://byron.github.io/google-apis-rs/google_genomics1_beta2/struct.Genomics.html)** * a central object to maintain state and allow accessing all *Activities* - * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google-genomics1_beta2/trait.MethodsBuilder.html) which in turn - allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google-genomics1_beta2/trait.CallBuilder.html) -* **[Resources](http://byron.github.io/google-apis-rs/google-genomics1_beta2/trait.Resource.html)** + * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google_genomics1_beta2/trait.MethodsBuilder.html) which in turn + allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google_genomics1_beta2/trait.CallBuilder.html) +* **[Resources](http://byron.github.io/google-apis-rs/google_genomics1_beta2/trait.Resource.html)** * primary types that you can apply *Activities* to * a collection of properties and *Parts* - * **[Parts](http://byron.github.io/google-apis-rs/google-genomics1_beta2/trait.Part.html)** + * **[Parts](http://byron.github.io/google-apis-rs/google_genomics1_beta2/trait.Part.html)** * a collection of properties * never directly used in *Activities* -* **[Activities](http://byron.github.io/google-apis-rs/google-genomics1_beta2/trait.CallBuilder.html)** +* **[Activities](http://byron.github.io/google-apis-rs/google_genomics1_beta2/trait.CallBuilder.html)** * operations to apply to *Resources* All *structures* are marked with applicable traits to further categorize them and ease browsing. @@ -148,17 +148,17 @@ match result { ``` ## Handling Errors -All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google-genomics1_beta2/enum.Result.html) enumeration as return value of +All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google_genomics1_beta2/enum.Result.html) enumeration as return value of the doit() methods, or handed as possibly intermediate results to either the -[Hub Delegate](http://byron.github.io/google-apis-rs/google-genomics1_beta2/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google-genomics1_beta2/../yup-oauth2/trait.AuthenticatorDelegate.html). +[Hub Delegate](http://byron.github.io/google-apis-rs/google_genomics1_beta2/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google_genomics1_beta2/../yup-oauth2/trait.AuthenticatorDelegate.html). 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](http://byron.github.io/google-apis-rs/google-genomics1_beta2/enum.Result.html), should be +If a method supports downloads, the response body, which is part of the [Result](http://byron.github.io/google-apis-rs/google_genomics1_beta2/enum.Result.html), should be read by you to obtain the media. -If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google-genomics1_beta2/trait.ResponseResult.html), it will return that by default. +If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google_genomics1_beta2/trait.ResponseResult.html), 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")`. @@ -168,29 +168,29 @@ Methods supporting uploads can do so using up to 2 different protocols: ## Customization and Callbacks -You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google-genomics1_beta2/trait.Delegate.html) to the -[Method Builder](http://byron.github.io/google-apis-rs/google-genomics1_beta2/trait.CallBuilder.html) before making the final `doit()` call. +You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google_genomics1_beta2/trait.Delegate.html) to the +[Method Builder](http://byron.github.io/google-apis-rs/google_genomics1_beta2/trait.CallBuilder.html) 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](http://byron.github.io/google-apis-rs/google-genomics1_beta2/trait.Delegate.html) is default-implemented, allowing you to customize it with minimal effort. +The [delegate trait](http://byron.github.io/google-apis-rs/google_genomics1_beta2/trait.Delegate.html) 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](http://byron.github.io/google-apis-rs/google-genomics1_beta2/trait.RequestValue.html) and -[decodable](http://byron.github.io/google-apis-rs/google-genomics1_beta2/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses +All structures provided by this library are made to be [enocodable](http://byron.github.io/google-apis-rs/google_genomics1_beta2/trait.RequestValue.html) and +[decodable](http://byron.github.io/google-apis-rs/google_genomics1_beta2/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses are valid. -Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google-genomics1_beta2/trait.Part.html) which are identifiable by name, which will be sent to +Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google_genomics1_beta2/trait.Part.html) 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](http://byron.github.io/google-apis-rs/google-genomics1_beta2/trait.CallBuilder.html), you are able to prepare an action call by repeatedly calling it's methods. +Using [method builders](http://byron.github.io/google-apis-rs/google_genomics1_beta2/trait.CallBuilder.html), 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][wiki-pod] are handed by copy * strings are passed as `&str` -* [request values](http://byron.github.io/google-apis-rs/google-genomics1_beta2/trait.RequestValue.html) are borrowed +* [request values](http://byron.github.io/google-apis-rs/google_genomics1_beta2/trait.RequestValue.html) are borrowed Arguments will always be copied or cloned into the builder, to make them independent of their original life times. diff --git a/gen/gmail1/README.md b/gen/gmail1/README.md index 49588a5210..c1f6446bbb 100644 --- a/gen/gmail1/README.md +++ b/gen/gmail1/README.md @@ -11,20 +11,20 @@ Everything else about the *gmail* *v1* API can be found at the [official documentation site](https://developers.google.com/gmail/api/). # Features -Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google-gmail1/struct.Gmail.html) ... +Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google_gmail1/struct.Gmail.html) ... * users - * [*drafts create*](http://byron.github.io/google-apis-rs/google-gmail1/struct.UserDraftCreateCall.html), [*drafts delete*](http://byron.github.io/google-apis-rs/google-gmail1/struct.UserDraftDeleteCall.html), [*drafts get*](http://byron.github.io/google-apis-rs/google-gmail1/struct.UserDraftGetCall.html), [*drafts list*](http://byron.github.io/google-apis-rs/google-gmail1/struct.UserDraftListCall.html), [*drafts send*](http://byron.github.io/google-apis-rs/google-gmail1/struct.UserDraftSendCall.html), [*drafts update*](http://byron.github.io/google-apis-rs/google-gmail1/struct.UserDraftUpdateCall.html), [*get profile*](http://byron.github.io/google-apis-rs/google-gmail1/struct.UserGetProfileCall.html), [*history list*](http://byron.github.io/google-apis-rs/google-gmail1/struct.UserHistoryListCall.html), [*labels create*](http://byron.github.io/google-apis-rs/google-gmail1/struct.UserLabelCreateCall.html), [*labels delete*](http://byron.github.io/google-apis-rs/google-gmail1/struct.UserLabelDeleteCall.html), [*labels get*](http://byron.github.io/google-apis-rs/google-gmail1/struct.UserLabelGetCall.html), [*labels list*](http://byron.github.io/google-apis-rs/google-gmail1/struct.UserLabelListCall.html), [*labels patch*](http://byron.github.io/google-apis-rs/google-gmail1/struct.UserLabelPatchCall.html), [*labels update*](http://byron.github.io/google-apis-rs/google-gmail1/struct.UserLabelUpdateCall.html), [*messages attachments get*](http://byron.github.io/google-apis-rs/google-gmail1/struct.UserMessageAttachmentGetCall.html), [*messages delete*](http://byron.github.io/google-apis-rs/google-gmail1/struct.UserMessageDeleteCall.html), [*messages get*](http://byron.github.io/google-apis-rs/google-gmail1/struct.UserMessageGetCall.html), [*messages import*](http://byron.github.io/google-apis-rs/google-gmail1/struct.UserMessageImportCall.html), [*messages insert*](http://byron.github.io/google-apis-rs/google-gmail1/struct.UserMessageInsertCall.html), [*messages list*](http://byron.github.io/google-apis-rs/google-gmail1/struct.UserMessageListCall.html), [*messages modify*](http://byron.github.io/google-apis-rs/google-gmail1/struct.UserMessageModifyCall.html), [*messages send*](http://byron.github.io/google-apis-rs/google-gmail1/struct.UserMessageSendCall.html), [*messages trash*](http://byron.github.io/google-apis-rs/google-gmail1/struct.UserMessageTrashCall.html), [*messages untrash*](http://byron.github.io/google-apis-rs/google-gmail1/struct.UserMessageUntrashCall.html), [*threads delete*](http://byron.github.io/google-apis-rs/google-gmail1/struct.UserThreadDeleteCall.html), [*threads get*](http://byron.github.io/google-apis-rs/google-gmail1/struct.UserThreadGetCall.html), [*threads list*](http://byron.github.io/google-apis-rs/google-gmail1/struct.UserThreadListCall.html), [*threads modify*](http://byron.github.io/google-apis-rs/google-gmail1/struct.UserThreadModifyCall.html), [*threads trash*](http://byron.github.io/google-apis-rs/google-gmail1/struct.UserThreadTrashCall.html) and [*threads untrash*](http://byron.github.io/google-apis-rs/google-gmail1/struct.UserThreadUntrashCall.html) + * [*drafts create*](http://byron.github.io/google-apis-rs/google_gmail1/struct.UserDraftCreateCall.html), [*drafts delete*](http://byron.github.io/google-apis-rs/google_gmail1/struct.UserDraftDeleteCall.html), [*drafts get*](http://byron.github.io/google-apis-rs/google_gmail1/struct.UserDraftGetCall.html), [*drafts list*](http://byron.github.io/google-apis-rs/google_gmail1/struct.UserDraftListCall.html), [*drafts send*](http://byron.github.io/google-apis-rs/google_gmail1/struct.UserDraftSendCall.html), [*drafts update*](http://byron.github.io/google-apis-rs/google_gmail1/struct.UserDraftUpdateCall.html), [*get profile*](http://byron.github.io/google-apis-rs/google_gmail1/struct.UserGetProfileCall.html), [*history list*](http://byron.github.io/google-apis-rs/google_gmail1/struct.UserHistoryListCall.html), [*labels create*](http://byron.github.io/google-apis-rs/google_gmail1/struct.UserLabelCreateCall.html), [*labels delete*](http://byron.github.io/google-apis-rs/google_gmail1/struct.UserLabelDeleteCall.html), [*labels get*](http://byron.github.io/google-apis-rs/google_gmail1/struct.UserLabelGetCall.html), [*labels list*](http://byron.github.io/google-apis-rs/google_gmail1/struct.UserLabelListCall.html), [*labels patch*](http://byron.github.io/google-apis-rs/google_gmail1/struct.UserLabelPatchCall.html), [*labels update*](http://byron.github.io/google-apis-rs/google_gmail1/struct.UserLabelUpdateCall.html), [*messages attachments get*](http://byron.github.io/google-apis-rs/google_gmail1/struct.UserMessageAttachmentGetCall.html), [*messages delete*](http://byron.github.io/google-apis-rs/google_gmail1/struct.UserMessageDeleteCall.html), [*messages get*](http://byron.github.io/google-apis-rs/google_gmail1/struct.UserMessageGetCall.html), [*messages import*](http://byron.github.io/google-apis-rs/google_gmail1/struct.UserMessageImportCall.html), [*messages insert*](http://byron.github.io/google-apis-rs/google_gmail1/struct.UserMessageInsertCall.html), [*messages list*](http://byron.github.io/google-apis-rs/google_gmail1/struct.UserMessageListCall.html), [*messages modify*](http://byron.github.io/google-apis-rs/google_gmail1/struct.UserMessageModifyCall.html), [*messages send*](http://byron.github.io/google-apis-rs/google_gmail1/struct.UserMessageSendCall.html), [*messages trash*](http://byron.github.io/google-apis-rs/google_gmail1/struct.UserMessageTrashCall.html), [*messages untrash*](http://byron.github.io/google-apis-rs/google_gmail1/struct.UserMessageUntrashCall.html), [*threads delete*](http://byron.github.io/google-apis-rs/google_gmail1/struct.UserThreadDeleteCall.html), [*threads get*](http://byron.github.io/google-apis-rs/google_gmail1/struct.UserThreadGetCall.html), [*threads list*](http://byron.github.io/google-apis-rs/google_gmail1/struct.UserThreadListCall.html), [*threads modify*](http://byron.github.io/google-apis-rs/google_gmail1/struct.UserThreadModifyCall.html), [*threads trash*](http://byron.github.io/google-apis-rs/google_gmail1/struct.UserThreadTrashCall.html) and [*threads untrash*](http://byron.github.io/google-apis-rs/google_gmail1/struct.UserThreadUntrashCall.html) Upload supported by ... -* [*messages import users*](http://byron.github.io/google-apis-rs/google-gmail1/struct.UserMessageImportCall.html) -* [*drafts create users*](http://byron.github.io/google-apis-rs/google-gmail1/struct.UserDraftCreateCall.html) -* [*drafts send users*](http://byron.github.io/google-apis-rs/google-gmail1/struct.UserDraftSendCall.html) -* [*messages send users*](http://byron.github.io/google-apis-rs/google-gmail1/struct.UserMessageSendCall.html) -* [*drafts update users*](http://byron.github.io/google-apis-rs/google-gmail1/struct.UserDraftUpdateCall.html) -* [*messages insert users*](http://byron.github.io/google-apis-rs/google-gmail1/struct.UserMessageInsertCall.html) +* [*messages import users*](http://byron.github.io/google-apis-rs/google_gmail1/struct.UserMessageImportCall.html) +* [*drafts create users*](http://byron.github.io/google-apis-rs/google_gmail1/struct.UserDraftCreateCall.html) +* [*drafts send users*](http://byron.github.io/google-apis-rs/google_gmail1/struct.UserDraftSendCall.html) +* [*messages send users*](http://byron.github.io/google-apis-rs/google_gmail1/struct.UserMessageSendCall.html) +* [*drafts update users*](http://byron.github.io/google-apis-rs/google_gmail1/struct.UserDraftUpdateCall.html) +* [*messages insert users*](http://byron.github.io/google-apis-rs/google_gmail1/struct.UserMessageInsertCall.html) @@ -32,17 +32,17 @@ Upload supported by ... The API is structured into the following primary items: -* **[Hub](http://byron.github.io/google-apis-rs/google-gmail1/struct.Gmail.html)** +* **[Hub](http://byron.github.io/google-apis-rs/google_gmail1/struct.Gmail.html)** * a central object to maintain state and allow accessing all *Activities* - * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google-gmail1/trait.MethodsBuilder.html) which in turn - allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google-gmail1/trait.CallBuilder.html) -* **[Resources](http://byron.github.io/google-apis-rs/google-gmail1/trait.Resource.html)** + * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google_gmail1/trait.MethodsBuilder.html) which in turn + allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google_gmail1/trait.CallBuilder.html) +* **[Resources](http://byron.github.io/google-apis-rs/google_gmail1/trait.Resource.html)** * primary types that you can apply *Activities* to * a collection of properties and *Parts* - * **[Parts](http://byron.github.io/google-apis-rs/google-gmail1/trait.Part.html)** + * **[Parts](http://byron.github.io/google-apis-rs/google_gmail1/trait.Part.html)** * a collection of properties * never directly used in *Activities* -* **[Activities](http://byron.github.io/google-apis-rs/google-gmail1/trait.CallBuilder.html)** +* **[Activities](http://byron.github.io/google-apis-rs/google_gmail1/trait.CallBuilder.html)** * operations to apply to *Resources* All *structures* are marked with applicable traits to further categorize them and ease browsing. @@ -139,17 +139,17 @@ match result { ``` ## Handling Errors -All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google-gmail1/enum.Result.html) enumeration as return value of +All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google_gmail1/enum.Result.html) enumeration as return value of the doit() methods, or handed as possibly intermediate results to either the -[Hub Delegate](http://byron.github.io/google-apis-rs/google-gmail1/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google-gmail1/../yup-oauth2/trait.AuthenticatorDelegate.html). +[Hub Delegate](http://byron.github.io/google-apis-rs/google_gmail1/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google_gmail1/../yup-oauth2/trait.AuthenticatorDelegate.html). 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](http://byron.github.io/google-apis-rs/google-gmail1/enum.Result.html), should be +If a method supports downloads, the response body, which is part of the [Result](http://byron.github.io/google-apis-rs/google_gmail1/enum.Result.html), should be read by you to obtain the media. -If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google-gmail1/trait.ResponseResult.html), it will return that by default. +If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google_gmail1/trait.ResponseResult.html), 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")`. @@ -159,29 +159,29 @@ Methods supporting uploads can do so using up to 2 different protocols: ## Customization and Callbacks -You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google-gmail1/trait.Delegate.html) to the -[Method Builder](http://byron.github.io/google-apis-rs/google-gmail1/trait.CallBuilder.html) before making the final `doit()` call. +You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google_gmail1/trait.Delegate.html) to the +[Method Builder](http://byron.github.io/google-apis-rs/google_gmail1/trait.CallBuilder.html) 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](http://byron.github.io/google-apis-rs/google-gmail1/trait.Delegate.html) is default-implemented, allowing you to customize it with minimal effort. +The [delegate trait](http://byron.github.io/google-apis-rs/google_gmail1/trait.Delegate.html) 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](http://byron.github.io/google-apis-rs/google-gmail1/trait.RequestValue.html) and -[decodable](http://byron.github.io/google-apis-rs/google-gmail1/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses +All structures provided by this library are made to be [enocodable](http://byron.github.io/google-apis-rs/google_gmail1/trait.RequestValue.html) and +[decodable](http://byron.github.io/google-apis-rs/google_gmail1/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses are valid. -Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google-gmail1/trait.Part.html) which are identifiable by name, which will be sent to +Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google_gmail1/trait.Part.html) 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](http://byron.github.io/google-apis-rs/google-gmail1/trait.CallBuilder.html), you are able to prepare an action call by repeatedly calling it's methods. +Using [method builders](http://byron.github.io/google-apis-rs/google_gmail1/trait.CallBuilder.html), 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][wiki-pod] are handed by copy * strings are passed as `&str` -* [request values](http://byron.github.io/google-apis-rs/google-gmail1/trait.RequestValue.html) are borrowed +* [request values](http://byron.github.io/google-apis-rs/google_gmail1/trait.RequestValue.html) are borrowed Arguments will always be copied or cloned into the builder, to make them independent of their original life times. diff --git a/gen/groupsmigration1/README.md b/gen/groupsmigration1/README.md index 2c91b13fee..d36d156dac 100644 --- a/gen/groupsmigration1/README.md +++ b/gen/groupsmigration1/README.md @@ -11,15 +11,15 @@ Everything else about the *Groups Migration* *v1* API can be found at the [official documentation site](https://developers.google.com/google-apps/groups-migration/). # Features -Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google-groupsmigration1/struct.GroupsMigration.html) ... +Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google_groupsmigration1/struct.GroupsMigration.html) ... * archive - * [*insert*](http://byron.github.io/google-apis-rs/google-groupsmigration1/struct.ArchiveInsertCall.html) + * [*insert*](http://byron.github.io/google-apis-rs/google_groupsmigration1/struct.ArchiveInsertCall.html) Upload supported by ... -* [*insert archive*](http://byron.github.io/google-apis-rs/google-groupsmigration1/struct.ArchiveInsertCall.html) +* [*insert archive*](http://byron.github.io/google-apis-rs/google_groupsmigration1/struct.ArchiveInsertCall.html) @@ -27,17 +27,17 @@ Upload supported by ... The API is structured into the following primary items: -* **[Hub](http://byron.github.io/google-apis-rs/google-groupsmigration1/struct.GroupsMigration.html)** +* **[Hub](http://byron.github.io/google-apis-rs/google_groupsmigration1/struct.GroupsMigration.html)** * a central object to maintain state and allow accessing all *Activities* - * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google-groupsmigration1/trait.MethodsBuilder.html) which in turn - allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google-groupsmigration1/trait.CallBuilder.html) -* **[Resources](http://byron.github.io/google-apis-rs/google-groupsmigration1/trait.Resource.html)** + * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google_groupsmigration1/trait.MethodsBuilder.html) which in turn + allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google_groupsmigration1/trait.CallBuilder.html) +* **[Resources](http://byron.github.io/google-apis-rs/google_groupsmigration1/trait.Resource.html)** * primary types that you can apply *Activities* to * a collection of properties and *Parts* - * **[Parts](http://byron.github.io/google-apis-rs/google-groupsmigration1/trait.Part.html)** + * **[Parts](http://byron.github.io/google-apis-rs/google_groupsmigration1/trait.Part.html)** * a collection of properties * never directly used in *Activities* -* **[Activities](http://byron.github.io/google-apis-rs/google-groupsmigration1/trait.CallBuilder.html)** +* **[Activities](http://byron.github.io/google-apis-rs/google_groupsmigration1/trait.CallBuilder.html)** * operations to apply to *Resources* All *structures* are marked with applicable traits to further categorize them and ease browsing. @@ -117,17 +117,17 @@ match result { ``` ## Handling Errors -All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google-groupsmigration1/enum.Result.html) enumeration as return value of +All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google_groupsmigration1/enum.Result.html) enumeration as return value of the doit() methods, or handed as possibly intermediate results to either the -[Hub Delegate](http://byron.github.io/google-apis-rs/google-groupsmigration1/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google-groupsmigration1/../yup-oauth2/trait.AuthenticatorDelegate.html). +[Hub Delegate](http://byron.github.io/google-apis-rs/google_groupsmigration1/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google_groupsmigration1/../yup-oauth2/trait.AuthenticatorDelegate.html). 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](http://byron.github.io/google-apis-rs/google-groupsmigration1/enum.Result.html), should be +If a method supports downloads, the response body, which is part of the [Result](http://byron.github.io/google-apis-rs/google_groupsmigration1/enum.Result.html), should be read by you to obtain the media. -If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google-groupsmigration1/trait.ResponseResult.html), it will return that by default. +If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google_groupsmigration1/trait.ResponseResult.html), 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")`. @@ -137,29 +137,29 @@ Methods supporting uploads can do so using up to 2 different protocols: ## Customization and Callbacks -You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google-groupsmigration1/trait.Delegate.html) to the -[Method Builder](http://byron.github.io/google-apis-rs/google-groupsmigration1/trait.CallBuilder.html) before making the final `doit()` call. +You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google_groupsmigration1/trait.Delegate.html) to the +[Method Builder](http://byron.github.io/google-apis-rs/google_groupsmigration1/trait.CallBuilder.html) 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](http://byron.github.io/google-apis-rs/google-groupsmigration1/trait.Delegate.html) is default-implemented, allowing you to customize it with minimal effort. +The [delegate trait](http://byron.github.io/google-apis-rs/google_groupsmigration1/trait.Delegate.html) 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](http://byron.github.io/google-apis-rs/google-groupsmigration1/trait.RequestValue.html) and -[decodable](http://byron.github.io/google-apis-rs/google-groupsmigration1/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses +All structures provided by this library are made to be [enocodable](http://byron.github.io/google-apis-rs/google_groupsmigration1/trait.RequestValue.html) and +[decodable](http://byron.github.io/google-apis-rs/google_groupsmigration1/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses are valid. -Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google-groupsmigration1/trait.Part.html) which are identifiable by name, which will be sent to +Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google_groupsmigration1/trait.Part.html) 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](http://byron.github.io/google-apis-rs/google-groupsmigration1/trait.CallBuilder.html), you are able to prepare an action call by repeatedly calling it's methods. +Using [method builders](http://byron.github.io/google-apis-rs/google_groupsmigration1/trait.CallBuilder.html), 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][wiki-pod] are handed by copy * strings are passed as `&str` -* [request values](http://byron.github.io/google-apis-rs/google-groupsmigration1/trait.RequestValue.html) are borrowed +* [request values](http://byron.github.io/google-apis-rs/google_groupsmigration1/trait.RequestValue.html) are borrowed Arguments will always be copied or cloned into the builder, to make them independent of their original life times. diff --git a/gen/groupssettings1/README.md b/gen/groupssettings1/README.md index a9ececadd0..6fd9c3a1d1 100644 --- a/gen/groupssettings1/README.md +++ b/gen/groupssettings1/README.md @@ -11,10 +11,10 @@ Everything else about the *groupssettings* *v1* API can be found at the [official documentation site](https://developers.google.com/google-apps/groups-settings/get_started). # Features -Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google-groupssettings1/struct.Groupssettings.html) ... +Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google_groupssettings1/struct.Groupssettings.html) ... * groups - * [*get*](http://byron.github.io/google-apis-rs/google-groupssettings1/struct.GroupGetCall.html), [*patch*](http://byron.github.io/google-apis-rs/google-groupssettings1/struct.GroupPatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google-groupssettings1/struct.GroupUpdateCall.html) + * [*get*](http://byron.github.io/google-apis-rs/google_groupssettings1/struct.GroupGetCall.html), [*patch*](http://byron.github.io/google-apis-rs/google_groupssettings1/struct.GroupPatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google_groupssettings1/struct.GroupUpdateCall.html) @@ -23,17 +23,17 @@ Handle the following *Resources* with ease from the central [hub](http://byron.g The API is structured into the following primary items: -* **[Hub](http://byron.github.io/google-apis-rs/google-groupssettings1/struct.Groupssettings.html)** +* **[Hub](http://byron.github.io/google-apis-rs/google_groupssettings1/struct.Groupssettings.html)** * a central object to maintain state and allow accessing all *Activities* - * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google-groupssettings1/trait.MethodsBuilder.html) which in turn - allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google-groupssettings1/trait.CallBuilder.html) -* **[Resources](http://byron.github.io/google-apis-rs/google-groupssettings1/trait.Resource.html)** + * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google_groupssettings1/trait.MethodsBuilder.html) which in turn + allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google_groupssettings1/trait.CallBuilder.html) +* **[Resources](http://byron.github.io/google-apis-rs/google_groupssettings1/trait.Resource.html)** * primary types that you can apply *Activities* to * a collection of properties and *Parts* - * **[Parts](http://byron.github.io/google-apis-rs/google-groupssettings1/trait.Part.html)** + * **[Parts](http://byron.github.io/google-apis-rs/google_groupssettings1/trait.Part.html)** * a collection of properties * never directly used in *Activities* -* **[Activities](http://byron.github.io/google-apis-rs/google-groupssettings1/trait.CallBuilder.html)** +* **[Activities](http://byron.github.io/google-apis-rs/google_groupssettings1/trait.CallBuilder.html)** * operations to apply to *Resources* All *structures* are marked with applicable traits to further categorize them and ease browsing. @@ -120,17 +120,17 @@ match result { ``` ## Handling Errors -All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google-groupssettings1/enum.Result.html) enumeration as return value of +All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google_groupssettings1/enum.Result.html) enumeration as return value of the doit() methods, or handed as possibly intermediate results to either the -[Hub Delegate](http://byron.github.io/google-apis-rs/google-groupssettings1/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google-groupssettings1/../yup-oauth2/trait.AuthenticatorDelegate.html). +[Hub Delegate](http://byron.github.io/google-apis-rs/google_groupssettings1/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google_groupssettings1/../yup-oauth2/trait.AuthenticatorDelegate.html). 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](http://byron.github.io/google-apis-rs/google-groupssettings1/enum.Result.html), should be +If a method supports downloads, the response body, which is part of the [Result](http://byron.github.io/google-apis-rs/google_groupssettings1/enum.Result.html), should be read by you to obtain the media. -If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google-groupssettings1/trait.ResponseResult.html), it will return that by default. +If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google_groupssettings1/trait.ResponseResult.html), 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")`. @@ -140,29 +140,29 @@ Methods supporting uploads can do so using up to 2 different protocols: ## Customization and Callbacks -You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google-groupssettings1/trait.Delegate.html) to the -[Method Builder](http://byron.github.io/google-apis-rs/google-groupssettings1/trait.CallBuilder.html) before making the final `doit()` call. +You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google_groupssettings1/trait.Delegate.html) to the +[Method Builder](http://byron.github.io/google-apis-rs/google_groupssettings1/trait.CallBuilder.html) 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](http://byron.github.io/google-apis-rs/google-groupssettings1/trait.Delegate.html) is default-implemented, allowing you to customize it with minimal effort. +The [delegate trait](http://byron.github.io/google-apis-rs/google_groupssettings1/trait.Delegate.html) 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](http://byron.github.io/google-apis-rs/google-groupssettings1/trait.RequestValue.html) and -[decodable](http://byron.github.io/google-apis-rs/google-groupssettings1/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses +All structures provided by this library are made to be [enocodable](http://byron.github.io/google-apis-rs/google_groupssettings1/trait.RequestValue.html) and +[decodable](http://byron.github.io/google-apis-rs/google_groupssettings1/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses are valid. -Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google-groupssettings1/trait.Part.html) which are identifiable by name, which will be sent to +Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google_groupssettings1/trait.Part.html) 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](http://byron.github.io/google-apis-rs/google-groupssettings1/trait.CallBuilder.html), you are able to prepare an action call by repeatedly calling it's methods. +Using [method builders](http://byron.github.io/google-apis-rs/google_groupssettings1/trait.CallBuilder.html), 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][wiki-pod] are handed by copy * strings are passed as `&str` -* [request values](http://byron.github.io/google-apis-rs/google-groupssettings1/trait.RequestValue.html) are borrowed +* [request values](http://byron.github.io/google-apis-rs/google_groupssettings1/trait.RequestValue.html) are borrowed Arguments will always be copied or cloned into the builder, to make them independent of their original life times. diff --git a/gen/identitytoolkit3/README.md b/gen/identitytoolkit3/README.md index 3b6463a414..b534ac61f1 100644 --- a/gen/identitytoolkit3/README.md +++ b/gen/identitytoolkit3/README.md @@ -11,10 +11,10 @@ Everything else about the *Identity Toolkit* *v3* API can be found at the [official documentation site](https://developers.google.com/identity-toolkit/v3/). # Features -Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google-identitytoolkit3/struct.IdentityToolkit.html) ... +Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google_identitytoolkit3/struct.IdentityToolkit.html) ... -* [relyingparty](http://byron.github.io/google-apis-rs/google-identitytoolkit3/struct.Relyingparty.html) - * [*create auth uri*](http://byron.github.io/google-apis-rs/google-identitytoolkit3/struct.RelyingpartyCreateAuthUriCall.html), [*delete account*](http://byron.github.io/google-apis-rs/google-identitytoolkit3/struct.RelyingpartyDeleteAccountCall.html), [*download account*](http://byron.github.io/google-apis-rs/google-identitytoolkit3/struct.RelyingpartyDownloadAccountCall.html), [*get account info*](http://byron.github.io/google-apis-rs/google-identitytoolkit3/struct.RelyingpartyGetAccountInfoCall.html), [*get oob confirmation code*](http://byron.github.io/google-apis-rs/google-identitytoolkit3/struct.RelyingpartyGetOobConfirmationCodeCall.html), [*get public keys*](http://byron.github.io/google-apis-rs/google-identitytoolkit3/struct.RelyingpartyGetPublicKeyCall.html), [*reset password*](http://byron.github.io/google-apis-rs/google-identitytoolkit3/struct.RelyingpartyResetPasswordCall.html), [*set account info*](http://byron.github.io/google-apis-rs/google-identitytoolkit3/struct.RelyingpartySetAccountInfoCall.html), [*upload account*](http://byron.github.io/google-apis-rs/google-identitytoolkit3/struct.RelyingpartyUploadAccountCall.html), [*verify assertion*](http://byron.github.io/google-apis-rs/google-identitytoolkit3/struct.RelyingpartyVerifyAssertionCall.html) and [*verify password*](http://byron.github.io/google-apis-rs/google-identitytoolkit3/struct.RelyingpartyVerifyPasswordCall.html) +* [relyingparty](http://byron.github.io/google-apis-rs/google_identitytoolkit3/struct.Relyingparty.html) + * [*create auth uri*](http://byron.github.io/google-apis-rs/google_identitytoolkit3/struct.RelyingpartyCreateAuthUriCall.html), [*delete account*](http://byron.github.io/google-apis-rs/google_identitytoolkit3/struct.RelyingpartyDeleteAccountCall.html), [*download account*](http://byron.github.io/google-apis-rs/google_identitytoolkit3/struct.RelyingpartyDownloadAccountCall.html), [*get account info*](http://byron.github.io/google-apis-rs/google_identitytoolkit3/struct.RelyingpartyGetAccountInfoCall.html), [*get oob confirmation code*](http://byron.github.io/google-apis-rs/google_identitytoolkit3/struct.RelyingpartyGetOobConfirmationCodeCall.html), [*get public keys*](http://byron.github.io/google-apis-rs/google_identitytoolkit3/struct.RelyingpartyGetPublicKeyCall.html), [*reset password*](http://byron.github.io/google-apis-rs/google_identitytoolkit3/struct.RelyingpartyResetPasswordCall.html), [*set account info*](http://byron.github.io/google-apis-rs/google_identitytoolkit3/struct.RelyingpartySetAccountInfoCall.html), [*upload account*](http://byron.github.io/google-apis-rs/google_identitytoolkit3/struct.RelyingpartyUploadAccountCall.html), [*verify assertion*](http://byron.github.io/google-apis-rs/google_identitytoolkit3/struct.RelyingpartyVerifyAssertionCall.html) and [*verify password*](http://byron.github.io/google-apis-rs/google_identitytoolkit3/struct.RelyingpartyVerifyPasswordCall.html) @@ -23,17 +23,17 @@ Handle the following *Resources* with ease from the central [hub](http://byron.g The API is structured into the following primary items: -* **[Hub](http://byron.github.io/google-apis-rs/google-identitytoolkit3/struct.IdentityToolkit.html)** +* **[Hub](http://byron.github.io/google-apis-rs/google_identitytoolkit3/struct.IdentityToolkit.html)** * a central object to maintain state and allow accessing all *Activities* - * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google-identitytoolkit3/trait.MethodsBuilder.html) which in turn - allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google-identitytoolkit3/trait.CallBuilder.html) -* **[Resources](http://byron.github.io/google-apis-rs/google-identitytoolkit3/trait.Resource.html)** + * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google_identitytoolkit3/trait.MethodsBuilder.html) which in turn + allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google_identitytoolkit3/trait.CallBuilder.html) +* **[Resources](http://byron.github.io/google-apis-rs/google_identitytoolkit3/trait.Resource.html)** * primary types that you can apply *Activities* to * a collection of properties and *Parts* - * **[Parts](http://byron.github.io/google-apis-rs/google-identitytoolkit3/trait.Part.html)** + * **[Parts](http://byron.github.io/google-apis-rs/google_identitytoolkit3/trait.Part.html)** * a collection of properties * never directly used in *Activities* -* **[Activities](http://byron.github.io/google-apis-rs/google-identitytoolkit3/trait.CallBuilder.html)** +* **[Activities](http://byron.github.io/google-apis-rs/google_identitytoolkit3/trait.CallBuilder.html)** * operations to apply to *Resources* All *structures* are marked with applicable traits to further categorize them and ease browsing. @@ -118,17 +118,17 @@ match result { ``` ## Handling Errors -All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google-identitytoolkit3/enum.Result.html) enumeration as return value of +All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google_identitytoolkit3/enum.Result.html) enumeration as return value of the doit() methods, or handed as possibly intermediate results to either the -[Hub Delegate](http://byron.github.io/google-apis-rs/google-identitytoolkit3/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google-identitytoolkit3/../yup-oauth2/trait.AuthenticatorDelegate.html). +[Hub Delegate](http://byron.github.io/google-apis-rs/google_identitytoolkit3/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google_identitytoolkit3/../yup-oauth2/trait.AuthenticatorDelegate.html). 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](http://byron.github.io/google-apis-rs/google-identitytoolkit3/enum.Result.html), should be +If a method supports downloads, the response body, which is part of the [Result](http://byron.github.io/google-apis-rs/google_identitytoolkit3/enum.Result.html), should be read by you to obtain the media. -If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google-identitytoolkit3/trait.ResponseResult.html), it will return that by default. +If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google_identitytoolkit3/trait.ResponseResult.html), 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")`. @@ -138,29 +138,29 @@ Methods supporting uploads can do so using up to 2 different protocols: ## Customization and Callbacks -You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google-identitytoolkit3/trait.Delegate.html) to the -[Method Builder](http://byron.github.io/google-apis-rs/google-identitytoolkit3/trait.CallBuilder.html) before making the final `doit()` call. +You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google_identitytoolkit3/trait.Delegate.html) to the +[Method Builder](http://byron.github.io/google-apis-rs/google_identitytoolkit3/trait.CallBuilder.html) 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](http://byron.github.io/google-apis-rs/google-identitytoolkit3/trait.Delegate.html) is default-implemented, allowing you to customize it with minimal effort. +The [delegate trait](http://byron.github.io/google-apis-rs/google_identitytoolkit3/trait.Delegate.html) 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](http://byron.github.io/google-apis-rs/google-identitytoolkit3/trait.RequestValue.html) and -[decodable](http://byron.github.io/google-apis-rs/google-identitytoolkit3/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses +All structures provided by this library are made to be [enocodable](http://byron.github.io/google-apis-rs/google_identitytoolkit3/trait.RequestValue.html) and +[decodable](http://byron.github.io/google-apis-rs/google_identitytoolkit3/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses are valid. -Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google-identitytoolkit3/trait.Part.html) which are identifiable by name, which will be sent to +Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google_identitytoolkit3/trait.Part.html) 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](http://byron.github.io/google-apis-rs/google-identitytoolkit3/trait.CallBuilder.html), you are able to prepare an action call by repeatedly calling it's methods. +Using [method builders](http://byron.github.io/google-apis-rs/google_identitytoolkit3/trait.CallBuilder.html), 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][wiki-pod] are handed by copy * strings are passed as `&str` -* [request values](http://byron.github.io/google-apis-rs/google-identitytoolkit3/trait.RequestValue.html) are borrowed +* [request values](http://byron.github.io/google-apis-rs/google_identitytoolkit3/trait.RequestValue.html) are borrowed Arguments will always be copied or cloned into the builder, to make them independent of their original life times. diff --git a/gen/licensing1/README.md b/gen/licensing1/README.md index 17e17b1a61..38d3e492a5 100644 --- a/gen/licensing1/README.md +++ b/gen/licensing1/README.md @@ -11,10 +11,10 @@ Everything else about the *licensing* *v1* API can be found at the [official documentation site](https://developers.google.com/google-apps/licensing/). # Features -Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google-licensing1/struct.Licensing.html) ... +Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google_licensing1/struct.Licensing.html) ... -* [license assignments](http://byron.github.io/google-apis-rs/google-licensing1/struct.LicenseAssignment.html) - * [*delete*](http://byron.github.io/google-apis-rs/google-licensing1/struct.LicenseAssignmentDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google-licensing1/struct.LicenseAssignmentGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google-licensing1/struct.LicenseAssignmentInsertCall.html), [*list for product*](http://byron.github.io/google-apis-rs/google-licensing1/struct.LicenseAssignmentListForProductCall.html), [*list for product and sku*](http://byron.github.io/google-apis-rs/google-licensing1/struct.LicenseAssignmentListForProductAndSkuCall.html), [*patch*](http://byron.github.io/google-apis-rs/google-licensing1/struct.LicenseAssignmentPatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google-licensing1/struct.LicenseAssignmentUpdateCall.html) +* [license assignments](http://byron.github.io/google-apis-rs/google_licensing1/struct.LicenseAssignment.html) + * [*delete*](http://byron.github.io/google-apis-rs/google_licensing1/struct.LicenseAssignmentDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google_licensing1/struct.LicenseAssignmentGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google_licensing1/struct.LicenseAssignmentInsertCall.html), [*list for product*](http://byron.github.io/google-apis-rs/google_licensing1/struct.LicenseAssignmentListForProductCall.html), [*list for product and sku*](http://byron.github.io/google-apis-rs/google_licensing1/struct.LicenseAssignmentListForProductAndSkuCall.html), [*patch*](http://byron.github.io/google-apis-rs/google_licensing1/struct.LicenseAssignmentPatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google_licensing1/struct.LicenseAssignmentUpdateCall.html) @@ -23,17 +23,17 @@ Handle the following *Resources* with ease from the central [hub](http://byron.g The API is structured into the following primary items: -* **[Hub](http://byron.github.io/google-apis-rs/google-licensing1/struct.Licensing.html)** +* **[Hub](http://byron.github.io/google-apis-rs/google_licensing1/struct.Licensing.html)** * a central object to maintain state and allow accessing all *Activities* - * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google-licensing1/trait.MethodsBuilder.html) which in turn - allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google-licensing1/trait.CallBuilder.html) -* **[Resources](http://byron.github.io/google-apis-rs/google-licensing1/trait.Resource.html)** + * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google_licensing1/trait.MethodsBuilder.html) which in turn + allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google_licensing1/trait.CallBuilder.html) +* **[Resources](http://byron.github.io/google-apis-rs/google_licensing1/trait.Resource.html)** * primary types that you can apply *Activities* to * a collection of properties and *Parts* - * **[Parts](http://byron.github.io/google-apis-rs/google-licensing1/trait.Part.html)** + * **[Parts](http://byron.github.io/google-apis-rs/google_licensing1/trait.Part.html)** * a collection of properties * never directly used in *Activities* -* **[Activities](http://byron.github.io/google-apis-rs/google-licensing1/trait.CallBuilder.html)** +* **[Activities](http://byron.github.io/google-apis-rs/google_licensing1/trait.CallBuilder.html)** * operations to apply to *Resources* All *structures* are marked with applicable traits to further categorize them and ease browsing. @@ -120,17 +120,17 @@ match result { ``` ## Handling Errors -All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google-licensing1/enum.Result.html) enumeration as return value of +All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google_licensing1/enum.Result.html) enumeration as return value of the doit() methods, or handed as possibly intermediate results to either the -[Hub Delegate](http://byron.github.io/google-apis-rs/google-licensing1/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google-licensing1/../yup-oauth2/trait.AuthenticatorDelegate.html). +[Hub Delegate](http://byron.github.io/google-apis-rs/google_licensing1/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google_licensing1/../yup-oauth2/trait.AuthenticatorDelegate.html). 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](http://byron.github.io/google-apis-rs/google-licensing1/enum.Result.html), should be +If a method supports downloads, the response body, which is part of the [Result](http://byron.github.io/google-apis-rs/google_licensing1/enum.Result.html), should be read by you to obtain the media. -If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google-licensing1/trait.ResponseResult.html), it will return that by default. +If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google_licensing1/trait.ResponseResult.html), 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")`. @@ -140,29 +140,29 @@ Methods supporting uploads can do so using up to 2 different protocols: ## Customization and Callbacks -You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google-licensing1/trait.Delegate.html) to the -[Method Builder](http://byron.github.io/google-apis-rs/google-licensing1/trait.CallBuilder.html) before making the final `doit()` call. +You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google_licensing1/trait.Delegate.html) to the +[Method Builder](http://byron.github.io/google-apis-rs/google_licensing1/trait.CallBuilder.html) 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](http://byron.github.io/google-apis-rs/google-licensing1/trait.Delegate.html) is default-implemented, allowing you to customize it with minimal effort. +The [delegate trait](http://byron.github.io/google-apis-rs/google_licensing1/trait.Delegate.html) 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](http://byron.github.io/google-apis-rs/google-licensing1/trait.RequestValue.html) and -[decodable](http://byron.github.io/google-apis-rs/google-licensing1/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses +All structures provided by this library are made to be [enocodable](http://byron.github.io/google-apis-rs/google_licensing1/trait.RequestValue.html) and +[decodable](http://byron.github.io/google-apis-rs/google_licensing1/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses are valid. -Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google-licensing1/trait.Part.html) which are identifiable by name, which will be sent to +Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google_licensing1/trait.Part.html) 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](http://byron.github.io/google-apis-rs/google-licensing1/trait.CallBuilder.html), you are able to prepare an action call by repeatedly calling it's methods. +Using [method builders](http://byron.github.io/google-apis-rs/google_licensing1/trait.CallBuilder.html), 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][wiki-pod] are handed by copy * strings are passed as `&str` -* [request values](http://byron.github.io/google-apis-rs/google-licensing1/trait.RequestValue.html) are borrowed +* [request values](http://byron.github.io/google-apis-rs/google_licensing1/trait.RequestValue.html) are borrowed Arguments will always be copied or cloned into the builder, to make them independent of their original life times. diff --git a/gen/logging1_beta3/README.md b/gen/logging1_beta3/README.md index 5bd7d146f8..b7b3e8f786 100644 --- a/gen/logging1_beta3/README.md +++ b/gen/logging1_beta3/README.md @@ -8,10 +8,10 @@ The `google-logging1_beta3` library allows access to all features of the *Google This documentation was generated from *logging* crate version *0.1.5+20150326*, where *20150326* is the exact revision of the *logging:v1beta3* schema built by the [mako](http://www.makotemplates.org/) code generator *v0.1.5*. # Features -Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google-logging1_beta3/struct.Logging.html) ... +Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google_logging1_beta3/struct.Logging.html) ... * projects - * [*log services indexes list*](http://byron.github.io/google-apis-rs/google-logging1_beta3/struct.ProjectLogServiceIndexeListCall.html), [*log services list*](http://byron.github.io/google-apis-rs/google-logging1_beta3/struct.ProjectLogServiceListCall.html), [*log services sinks create*](http://byron.github.io/google-apis-rs/google-logging1_beta3/struct.ProjectLogServiceSinkCreateCall.html), [*log services sinks delete*](http://byron.github.io/google-apis-rs/google-logging1_beta3/struct.ProjectLogServiceSinkDeleteCall.html), [*log services sinks get*](http://byron.github.io/google-apis-rs/google-logging1_beta3/struct.ProjectLogServiceSinkGetCall.html), [*log services sinks list*](http://byron.github.io/google-apis-rs/google-logging1_beta3/struct.ProjectLogServiceSinkListCall.html), [*log services sinks update*](http://byron.github.io/google-apis-rs/google-logging1_beta3/struct.ProjectLogServiceSinkUpdateCall.html), [*logs delete*](http://byron.github.io/google-apis-rs/google-logging1_beta3/struct.ProjectLogDeleteCall.html), [*logs entries write*](http://byron.github.io/google-apis-rs/google-logging1_beta3/struct.ProjectLogEntryWriteCall.html), [*logs list*](http://byron.github.io/google-apis-rs/google-logging1_beta3/struct.ProjectLogListCall.html), [*logs sinks create*](http://byron.github.io/google-apis-rs/google-logging1_beta3/struct.ProjectLogSinkCreateCall.html), [*logs sinks delete*](http://byron.github.io/google-apis-rs/google-logging1_beta3/struct.ProjectLogSinkDeleteCall.html), [*logs sinks get*](http://byron.github.io/google-apis-rs/google-logging1_beta3/struct.ProjectLogSinkGetCall.html), [*logs sinks list*](http://byron.github.io/google-apis-rs/google-logging1_beta3/struct.ProjectLogSinkListCall.html) and [*logs sinks update*](http://byron.github.io/google-apis-rs/google-logging1_beta3/struct.ProjectLogSinkUpdateCall.html) + * [*log services indexes list*](http://byron.github.io/google-apis-rs/google_logging1_beta3/struct.ProjectLogServiceIndexeListCall.html), [*log services list*](http://byron.github.io/google-apis-rs/google_logging1_beta3/struct.ProjectLogServiceListCall.html), [*log services sinks create*](http://byron.github.io/google-apis-rs/google_logging1_beta3/struct.ProjectLogServiceSinkCreateCall.html), [*log services sinks delete*](http://byron.github.io/google-apis-rs/google_logging1_beta3/struct.ProjectLogServiceSinkDeleteCall.html), [*log services sinks get*](http://byron.github.io/google-apis-rs/google_logging1_beta3/struct.ProjectLogServiceSinkGetCall.html), [*log services sinks list*](http://byron.github.io/google-apis-rs/google_logging1_beta3/struct.ProjectLogServiceSinkListCall.html), [*log services sinks update*](http://byron.github.io/google-apis-rs/google_logging1_beta3/struct.ProjectLogServiceSinkUpdateCall.html), [*logs delete*](http://byron.github.io/google-apis-rs/google_logging1_beta3/struct.ProjectLogDeleteCall.html), [*logs entries write*](http://byron.github.io/google-apis-rs/google_logging1_beta3/struct.ProjectLogEntryWriteCall.html), [*logs list*](http://byron.github.io/google-apis-rs/google_logging1_beta3/struct.ProjectLogListCall.html), [*logs sinks create*](http://byron.github.io/google-apis-rs/google_logging1_beta3/struct.ProjectLogSinkCreateCall.html), [*logs sinks delete*](http://byron.github.io/google-apis-rs/google_logging1_beta3/struct.ProjectLogSinkDeleteCall.html), [*logs sinks get*](http://byron.github.io/google-apis-rs/google_logging1_beta3/struct.ProjectLogSinkGetCall.html), [*logs sinks list*](http://byron.github.io/google-apis-rs/google_logging1_beta3/struct.ProjectLogSinkListCall.html) and [*logs sinks update*](http://byron.github.io/google-apis-rs/google_logging1_beta3/struct.ProjectLogSinkUpdateCall.html) @@ -20,17 +20,17 @@ Handle the following *Resources* with ease from the central [hub](http://byron.g The API is structured into the following primary items: -* **[Hub](http://byron.github.io/google-apis-rs/google-logging1_beta3/struct.Logging.html)** +* **[Hub](http://byron.github.io/google-apis-rs/google_logging1_beta3/struct.Logging.html)** * a central object to maintain state and allow accessing all *Activities* - * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google-logging1_beta3/trait.MethodsBuilder.html) which in turn - allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google-logging1_beta3/trait.CallBuilder.html) -* **[Resources](http://byron.github.io/google-apis-rs/google-logging1_beta3/trait.Resource.html)** + * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google_logging1_beta3/trait.MethodsBuilder.html) which in turn + allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google_logging1_beta3/trait.CallBuilder.html) +* **[Resources](http://byron.github.io/google-apis-rs/google_logging1_beta3/trait.Resource.html)** * primary types that you can apply *Activities* to * a collection of properties and *Parts* - * **[Parts](http://byron.github.io/google-apis-rs/google-logging1_beta3/trait.Part.html)** + * **[Parts](http://byron.github.io/google-apis-rs/google_logging1_beta3/trait.Part.html)** * a collection of properties * never directly used in *Activities* -* **[Activities](http://byron.github.io/google-apis-rs/google-logging1_beta3/trait.CallBuilder.html)** +* **[Activities](http://byron.github.io/google-apis-rs/google_logging1_beta3/trait.CallBuilder.html)** * operations to apply to *Resources* All *structures* are marked with applicable traits to further categorize them and ease browsing. @@ -120,17 +120,17 @@ match result { ``` ## Handling Errors -All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google-logging1_beta3/enum.Result.html) enumeration as return value of +All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google_logging1_beta3/enum.Result.html) enumeration as return value of the doit() methods, or handed as possibly intermediate results to either the -[Hub Delegate](http://byron.github.io/google-apis-rs/google-logging1_beta3/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google-logging1_beta3/../yup-oauth2/trait.AuthenticatorDelegate.html). +[Hub Delegate](http://byron.github.io/google-apis-rs/google_logging1_beta3/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google_logging1_beta3/../yup-oauth2/trait.AuthenticatorDelegate.html). 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](http://byron.github.io/google-apis-rs/google-logging1_beta3/enum.Result.html), should be +If a method supports downloads, the response body, which is part of the [Result](http://byron.github.io/google-apis-rs/google_logging1_beta3/enum.Result.html), should be read by you to obtain the media. -If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google-logging1_beta3/trait.ResponseResult.html), it will return that by default. +If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google_logging1_beta3/trait.ResponseResult.html), 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")`. @@ -140,29 +140,29 @@ Methods supporting uploads can do so using up to 2 different protocols: ## Customization and Callbacks -You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google-logging1_beta3/trait.Delegate.html) to the -[Method Builder](http://byron.github.io/google-apis-rs/google-logging1_beta3/trait.CallBuilder.html) before making the final `doit()` call. +You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google_logging1_beta3/trait.Delegate.html) to the +[Method Builder](http://byron.github.io/google-apis-rs/google_logging1_beta3/trait.CallBuilder.html) 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](http://byron.github.io/google-apis-rs/google-logging1_beta3/trait.Delegate.html) is default-implemented, allowing you to customize it with minimal effort. +The [delegate trait](http://byron.github.io/google-apis-rs/google_logging1_beta3/trait.Delegate.html) 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](http://byron.github.io/google-apis-rs/google-logging1_beta3/trait.RequestValue.html) and -[decodable](http://byron.github.io/google-apis-rs/google-logging1_beta3/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses +All structures provided by this library are made to be [enocodable](http://byron.github.io/google-apis-rs/google_logging1_beta3/trait.RequestValue.html) and +[decodable](http://byron.github.io/google-apis-rs/google_logging1_beta3/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses are valid. -Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google-logging1_beta3/trait.Part.html) which are identifiable by name, which will be sent to +Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google_logging1_beta3/trait.Part.html) 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](http://byron.github.io/google-apis-rs/google-logging1_beta3/trait.CallBuilder.html), you are able to prepare an action call by repeatedly calling it's methods. +Using [method builders](http://byron.github.io/google-apis-rs/google_logging1_beta3/trait.CallBuilder.html), 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][wiki-pod] are handed by copy * strings are passed as `&str` -* [request values](http://byron.github.io/google-apis-rs/google-logging1_beta3/trait.RequestValue.html) are borrowed +* [request values](http://byron.github.io/google-apis-rs/google_logging1_beta3/trait.RequestValue.html) are borrowed Arguments will always be copied or cloned into the builder, to make them independent of their original life times. diff --git a/gen/manager1_beta2/README.md b/gen/manager1_beta2/README.md index 820ac25e9d..e5b4b45612 100644 --- a/gen/manager1_beta2/README.md +++ b/gen/manager1_beta2/README.md @@ -11,12 +11,12 @@ Everything else about the *manager* *v1_beta2* API can be found at the [official documentation site](https://developers.google.com/deployment-manager/). # Features -Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google-manager1_beta2/struct.Manager.html) ... +Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google_manager1_beta2/struct.Manager.html) ... -* [deployments](http://byron.github.io/google-apis-rs/google-manager1_beta2/struct.Deployment.html) - * [*delete*](http://byron.github.io/google-apis-rs/google-manager1_beta2/struct.DeploymentDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google-manager1_beta2/struct.DeploymentGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google-manager1_beta2/struct.DeploymentInsertCall.html) and [*list*](http://byron.github.io/google-apis-rs/google-manager1_beta2/struct.DeploymentListCall.html) -* [templates](http://byron.github.io/google-apis-rs/google-manager1_beta2/struct.Template.html) - * [*delete*](http://byron.github.io/google-apis-rs/google-manager1_beta2/struct.TemplateDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google-manager1_beta2/struct.TemplateGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google-manager1_beta2/struct.TemplateInsertCall.html) and [*list*](http://byron.github.io/google-apis-rs/google-manager1_beta2/struct.TemplateListCall.html) +* [deployments](http://byron.github.io/google-apis-rs/google_manager1_beta2/struct.Deployment.html) + * [*delete*](http://byron.github.io/google-apis-rs/google_manager1_beta2/struct.DeploymentDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google_manager1_beta2/struct.DeploymentGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google_manager1_beta2/struct.DeploymentInsertCall.html) and [*list*](http://byron.github.io/google-apis-rs/google_manager1_beta2/struct.DeploymentListCall.html) +* [templates](http://byron.github.io/google-apis-rs/google_manager1_beta2/struct.Template.html) + * [*delete*](http://byron.github.io/google-apis-rs/google_manager1_beta2/struct.TemplateDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google_manager1_beta2/struct.TemplateGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google_manager1_beta2/struct.TemplateInsertCall.html) and [*list*](http://byron.github.io/google-apis-rs/google_manager1_beta2/struct.TemplateListCall.html) @@ -25,17 +25,17 @@ Handle the following *Resources* with ease from the central [hub](http://byron.g The API is structured into the following primary items: -* **[Hub](http://byron.github.io/google-apis-rs/google-manager1_beta2/struct.Manager.html)** +* **[Hub](http://byron.github.io/google-apis-rs/google_manager1_beta2/struct.Manager.html)** * a central object to maintain state and allow accessing all *Activities* - * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google-manager1_beta2/trait.MethodsBuilder.html) which in turn - allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google-manager1_beta2/trait.CallBuilder.html) -* **[Resources](http://byron.github.io/google-apis-rs/google-manager1_beta2/trait.Resource.html)** + * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google_manager1_beta2/trait.MethodsBuilder.html) which in turn + allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google_manager1_beta2/trait.CallBuilder.html) +* **[Resources](http://byron.github.io/google-apis-rs/google_manager1_beta2/trait.Resource.html)** * primary types that you can apply *Activities* to * a collection of properties and *Parts* - * **[Parts](http://byron.github.io/google-apis-rs/google-manager1_beta2/trait.Part.html)** + * **[Parts](http://byron.github.io/google-apis-rs/google_manager1_beta2/trait.Part.html)** * a collection of properties * never directly used in *Activities* -* **[Activities](http://byron.github.io/google-apis-rs/google-manager1_beta2/trait.CallBuilder.html)** +* **[Activities](http://byron.github.io/google-apis-rs/google_manager1_beta2/trait.CallBuilder.html)** * operations to apply to *Resources* All *structures* are marked with applicable traits to further categorize them and ease browsing. @@ -119,17 +119,17 @@ match result { ``` ## Handling Errors -All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google-manager1_beta2/enum.Result.html) enumeration as return value of +All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google_manager1_beta2/enum.Result.html) enumeration as return value of the doit() methods, or handed as possibly intermediate results to either the -[Hub Delegate](http://byron.github.io/google-apis-rs/google-manager1_beta2/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google-manager1_beta2/../yup-oauth2/trait.AuthenticatorDelegate.html). +[Hub Delegate](http://byron.github.io/google-apis-rs/google_manager1_beta2/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google_manager1_beta2/../yup-oauth2/trait.AuthenticatorDelegate.html). 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](http://byron.github.io/google-apis-rs/google-manager1_beta2/enum.Result.html), should be +If a method supports downloads, the response body, which is part of the [Result](http://byron.github.io/google-apis-rs/google_manager1_beta2/enum.Result.html), should be read by you to obtain the media. -If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google-manager1_beta2/trait.ResponseResult.html), it will return that by default. +If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google_manager1_beta2/trait.ResponseResult.html), 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")`. @@ -139,29 +139,29 @@ Methods supporting uploads can do so using up to 2 different protocols: ## Customization and Callbacks -You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google-manager1_beta2/trait.Delegate.html) to the -[Method Builder](http://byron.github.io/google-apis-rs/google-manager1_beta2/trait.CallBuilder.html) before making the final `doit()` call. +You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google_manager1_beta2/trait.Delegate.html) to the +[Method Builder](http://byron.github.io/google-apis-rs/google_manager1_beta2/trait.CallBuilder.html) 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](http://byron.github.io/google-apis-rs/google-manager1_beta2/trait.Delegate.html) is default-implemented, allowing you to customize it with minimal effort. +The [delegate trait](http://byron.github.io/google-apis-rs/google_manager1_beta2/trait.Delegate.html) 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](http://byron.github.io/google-apis-rs/google-manager1_beta2/trait.RequestValue.html) and -[decodable](http://byron.github.io/google-apis-rs/google-manager1_beta2/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses +All structures provided by this library are made to be [enocodable](http://byron.github.io/google-apis-rs/google_manager1_beta2/trait.RequestValue.html) and +[decodable](http://byron.github.io/google-apis-rs/google_manager1_beta2/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses are valid. -Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google-manager1_beta2/trait.Part.html) which are identifiable by name, which will be sent to +Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google_manager1_beta2/trait.Part.html) 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](http://byron.github.io/google-apis-rs/google-manager1_beta2/trait.CallBuilder.html), you are able to prepare an action call by repeatedly calling it's methods. +Using [method builders](http://byron.github.io/google-apis-rs/google_manager1_beta2/trait.CallBuilder.html), 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][wiki-pod] are handed by copy * strings are passed as `&str` -* [request values](http://byron.github.io/google-apis-rs/google-manager1_beta2/trait.RequestValue.html) are borrowed +* [request values](http://byron.github.io/google-apis-rs/google_manager1_beta2/trait.RequestValue.html) are borrowed Arguments will always be copied or cloned into the builder, to make them independent of their original life times. diff --git a/gen/mapsengine1/README.md b/gen/mapsengine1/README.md index 08d61d50b1..41a6ca0f6c 100644 --- a/gen/mapsengine1/README.md +++ b/gen/mapsengine1/README.md @@ -11,33 +11,33 @@ Everything else about the *Maps Engine* *v1* API can be found at the [official documentation site](https://developers.google.com/maps-engine/). # Features -Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google-mapsengine1/struct.MapsEngine.html) ... +Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google_mapsengine1/struct.MapsEngine.html) ... -* [assets](http://byron.github.io/google-apis-rs/google-mapsengine1/struct.Asset.html) - * [*get*](http://byron.github.io/google-apis-rs/google-mapsengine1/struct.AssetGetCall.html), [*list*](http://byron.github.io/google-apis-rs/google-mapsengine1/struct.AssetListCall.html), [*parents list*](http://byron.github.io/google-apis-rs/google-mapsengine1/struct.AssetParentListCall.html) and [*permissions list*](http://byron.github.io/google-apis-rs/google-mapsengine1/struct.AssetPermissionListCall.html) -* [layers](http://byron.github.io/google-apis-rs/google-mapsengine1/struct.Layer.html) - * [*cancel processing*](http://byron.github.io/google-apis-rs/google-mapsengine1/struct.LayerCancelProcessingCall.html), [*create*](http://byron.github.io/google-apis-rs/google-mapsengine1/struct.LayerCreateCall.html), [*delete*](http://byron.github.io/google-apis-rs/google-mapsengine1/struct.LayerDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google-mapsengine1/struct.LayerGetCall.html), [*get published*](http://byron.github.io/google-apis-rs/google-mapsengine1/struct.LayerGetPublishedCall.html), [*list*](http://byron.github.io/google-apis-rs/google-mapsengine1/struct.LayerListCall.html), [*list published*](http://byron.github.io/google-apis-rs/google-mapsengine1/struct.LayerListPublishedCall.html), [*parents list*](http://byron.github.io/google-apis-rs/google-mapsengine1/struct.LayerParentListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google-mapsengine1/struct.LayerPatchCall.html), [*permissions batch delete*](http://byron.github.io/google-apis-rs/google-mapsengine1/struct.LayerPermissionBatchDeleteCall.html), [*permissions batch update*](http://byron.github.io/google-apis-rs/google-mapsengine1/struct.LayerPermissionBatchUpdateCall.html), [*permissions list*](http://byron.github.io/google-apis-rs/google-mapsengine1/struct.LayerPermissionListCall.html), [*process*](http://byron.github.io/google-apis-rs/google-mapsengine1/struct.LayerProcesCall.html), [*publish*](http://byron.github.io/google-apis-rs/google-mapsengine1/struct.LayerPublishCall.html) and [*unpublish*](http://byron.github.io/google-apis-rs/google-mapsengine1/struct.LayerUnpublishCall.html) -* [maps](http://byron.github.io/google-apis-rs/google-mapsengine1/struct.Map.html) - * [*create*](http://byron.github.io/google-apis-rs/google-mapsengine1/struct.MapCreateCall.html), [*delete*](http://byron.github.io/google-apis-rs/google-mapsengine1/struct.MapDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google-mapsengine1/struct.MapGetCall.html), [*get published*](http://byron.github.io/google-apis-rs/google-mapsengine1/struct.MapGetPublishedCall.html), [*list*](http://byron.github.io/google-apis-rs/google-mapsengine1/struct.MapListCall.html), [*list published*](http://byron.github.io/google-apis-rs/google-mapsengine1/struct.MapListPublishedCall.html), [*patch*](http://byron.github.io/google-apis-rs/google-mapsengine1/struct.MapPatchCall.html), [*permissions batch delete*](http://byron.github.io/google-apis-rs/google-mapsengine1/struct.MapPermissionBatchDeleteCall.html), [*permissions batch update*](http://byron.github.io/google-apis-rs/google-mapsengine1/struct.MapPermissionBatchUpdateCall.html), [*permissions list*](http://byron.github.io/google-apis-rs/google-mapsengine1/struct.MapPermissionListCall.html), [*publish*](http://byron.github.io/google-apis-rs/google-mapsengine1/struct.MapPublishCall.html) and [*unpublish*](http://byron.github.io/google-apis-rs/google-mapsengine1/struct.MapUnpublishCall.html) -* [projects](http://byron.github.io/google-apis-rs/google-mapsengine1/struct.Project.html) - * [*icons create*](http://byron.github.io/google-apis-rs/google-mapsengine1/struct.ProjectIconCreateCall.html), [*icons get*](http://byron.github.io/google-apis-rs/google-mapsengine1/struct.ProjectIconGetCall.html), [*icons list*](http://byron.github.io/google-apis-rs/google-mapsengine1/struct.ProjectIconListCall.html) and [*list*](http://byron.github.io/google-apis-rs/google-mapsengine1/struct.ProjectListCall.html) -* [raster collections](http://byron.github.io/google-apis-rs/google-mapsengine1/struct.RasterCollection.html) - * [*cancel processing*](http://byron.github.io/google-apis-rs/google-mapsengine1/struct.RasterCollectionCancelProcessingCall.html), [*create*](http://byron.github.io/google-apis-rs/google-mapsengine1/struct.RasterCollectionCreateCall.html), [*delete*](http://byron.github.io/google-apis-rs/google-mapsengine1/struct.RasterCollectionDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google-mapsengine1/struct.RasterCollectionGetCall.html), [*list*](http://byron.github.io/google-apis-rs/google-mapsengine1/struct.RasterCollectionListCall.html), [*parents list*](http://byron.github.io/google-apis-rs/google-mapsengine1/struct.RasterCollectionParentListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google-mapsengine1/struct.RasterCollectionPatchCall.html), [*permissions batch delete*](http://byron.github.io/google-apis-rs/google-mapsengine1/struct.RasterCollectionPermissionBatchDeleteCall.html), [*permissions batch update*](http://byron.github.io/google-apis-rs/google-mapsengine1/struct.RasterCollectionPermissionBatchUpdateCall.html), [*permissions list*](http://byron.github.io/google-apis-rs/google-mapsengine1/struct.RasterCollectionPermissionListCall.html), [*process*](http://byron.github.io/google-apis-rs/google-mapsengine1/struct.RasterCollectionProcesCall.html), [*rasters batch delete*](http://byron.github.io/google-apis-rs/google-mapsengine1/struct.RasterCollectionRasterBatchDeleteCall.html), [*rasters batch insert*](http://byron.github.io/google-apis-rs/google-mapsengine1/struct.RasterCollectionRasterBatchInsertCall.html) and [*rasters list*](http://byron.github.io/google-apis-rs/google-mapsengine1/struct.RasterCollectionRasterListCall.html) -* [rasters](http://byron.github.io/google-apis-rs/google-mapsengine1/struct.Raster.html) - * [*delete*](http://byron.github.io/google-apis-rs/google-mapsengine1/struct.RasterDeleteCall.html), [*files insert*](http://byron.github.io/google-apis-rs/google-mapsengine1/struct.RasterFileInsertCall.html), [*get*](http://byron.github.io/google-apis-rs/google-mapsengine1/struct.RasterGetCall.html), [*list*](http://byron.github.io/google-apis-rs/google-mapsengine1/struct.RasterListCall.html), [*parents list*](http://byron.github.io/google-apis-rs/google-mapsengine1/struct.RasterParentListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google-mapsengine1/struct.RasterPatchCall.html), [*permissions batch delete*](http://byron.github.io/google-apis-rs/google-mapsengine1/struct.RasterPermissionBatchDeleteCall.html), [*permissions batch update*](http://byron.github.io/google-apis-rs/google-mapsengine1/struct.RasterPermissionBatchUpdateCall.html), [*permissions list*](http://byron.github.io/google-apis-rs/google-mapsengine1/struct.RasterPermissionListCall.html), [*process*](http://byron.github.io/google-apis-rs/google-mapsengine1/struct.RasterProcesCall.html) and [*upload*](http://byron.github.io/google-apis-rs/google-mapsengine1/struct.RasterUploadCall.html) -* [tables](http://byron.github.io/google-apis-rs/google-mapsengine1/struct.Table.html) - * [*create*](http://byron.github.io/google-apis-rs/google-mapsengine1/struct.TableCreateCall.html), [*delete*](http://byron.github.io/google-apis-rs/google-mapsengine1/struct.TableDeleteCall.html), [*features batch delete*](http://byron.github.io/google-apis-rs/google-mapsengine1/struct.TableFeatureBatchDeleteCall.html), [*features batch insert*](http://byron.github.io/google-apis-rs/google-mapsengine1/struct.TableFeatureBatchInsertCall.html), [*features batch patch*](http://byron.github.io/google-apis-rs/google-mapsengine1/struct.TableFeatureBatchPatchCall.html), [*features get*](http://byron.github.io/google-apis-rs/google-mapsengine1/struct.TableFeatureGetCall.html), [*features list*](http://byron.github.io/google-apis-rs/google-mapsengine1/struct.TableFeatureListCall.html), [*files insert*](http://byron.github.io/google-apis-rs/google-mapsengine1/struct.TableFileInsertCall.html), [*get*](http://byron.github.io/google-apis-rs/google-mapsengine1/struct.TableGetCall.html), [*list*](http://byron.github.io/google-apis-rs/google-mapsengine1/struct.TableListCall.html), [*parents list*](http://byron.github.io/google-apis-rs/google-mapsengine1/struct.TableParentListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google-mapsengine1/struct.TablePatchCall.html), [*permissions batch delete*](http://byron.github.io/google-apis-rs/google-mapsengine1/struct.TablePermissionBatchDeleteCall.html), [*permissions batch update*](http://byron.github.io/google-apis-rs/google-mapsengine1/struct.TablePermissionBatchUpdateCall.html), [*permissions list*](http://byron.github.io/google-apis-rs/google-mapsengine1/struct.TablePermissionListCall.html), [*process*](http://byron.github.io/google-apis-rs/google-mapsengine1/struct.TableProcesCall.html) and [*upload*](http://byron.github.io/google-apis-rs/google-mapsengine1/struct.TableUploadCall.html) +* [assets](http://byron.github.io/google-apis-rs/google_mapsengine1/struct.Asset.html) + * [*get*](http://byron.github.io/google-apis-rs/google_mapsengine1/struct.AssetGetCall.html), [*list*](http://byron.github.io/google-apis-rs/google_mapsengine1/struct.AssetListCall.html), [*parents list*](http://byron.github.io/google-apis-rs/google_mapsengine1/struct.AssetParentListCall.html) and [*permissions list*](http://byron.github.io/google-apis-rs/google_mapsengine1/struct.AssetPermissionListCall.html) +* [layers](http://byron.github.io/google-apis-rs/google_mapsengine1/struct.Layer.html) + * [*cancel processing*](http://byron.github.io/google-apis-rs/google_mapsengine1/struct.LayerCancelProcessingCall.html), [*create*](http://byron.github.io/google-apis-rs/google_mapsengine1/struct.LayerCreateCall.html), [*delete*](http://byron.github.io/google-apis-rs/google_mapsengine1/struct.LayerDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google_mapsengine1/struct.LayerGetCall.html), [*get published*](http://byron.github.io/google-apis-rs/google_mapsengine1/struct.LayerGetPublishedCall.html), [*list*](http://byron.github.io/google-apis-rs/google_mapsengine1/struct.LayerListCall.html), [*list published*](http://byron.github.io/google-apis-rs/google_mapsengine1/struct.LayerListPublishedCall.html), [*parents list*](http://byron.github.io/google-apis-rs/google_mapsengine1/struct.LayerParentListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google_mapsengine1/struct.LayerPatchCall.html), [*permissions batch delete*](http://byron.github.io/google-apis-rs/google_mapsengine1/struct.LayerPermissionBatchDeleteCall.html), [*permissions batch update*](http://byron.github.io/google-apis-rs/google_mapsengine1/struct.LayerPermissionBatchUpdateCall.html), [*permissions list*](http://byron.github.io/google-apis-rs/google_mapsengine1/struct.LayerPermissionListCall.html), [*process*](http://byron.github.io/google-apis-rs/google_mapsengine1/struct.LayerProcesCall.html), [*publish*](http://byron.github.io/google-apis-rs/google_mapsengine1/struct.LayerPublishCall.html) and [*unpublish*](http://byron.github.io/google-apis-rs/google_mapsengine1/struct.LayerUnpublishCall.html) +* [maps](http://byron.github.io/google-apis-rs/google_mapsengine1/struct.Map.html) + * [*create*](http://byron.github.io/google-apis-rs/google_mapsengine1/struct.MapCreateCall.html), [*delete*](http://byron.github.io/google-apis-rs/google_mapsengine1/struct.MapDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google_mapsengine1/struct.MapGetCall.html), [*get published*](http://byron.github.io/google-apis-rs/google_mapsengine1/struct.MapGetPublishedCall.html), [*list*](http://byron.github.io/google-apis-rs/google_mapsengine1/struct.MapListCall.html), [*list published*](http://byron.github.io/google-apis-rs/google_mapsengine1/struct.MapListPublishedCall.html), [*patch*](http://byron.github.io/google-apis-rs/google_mapsengine1/struct.MapPatchCall.html), [*permissions batch delete*](http://byron.github.io/google-apis-rs/google_mapsengine1/struct.MapPermissionBatchDeleteCall.html), [*permissions batch update*](http://byron.github.io/google-apis-rs/google_mapsengine1/struct.MapPermissionBatchUpdateCall.html), [*permissions list*](http://byron.github.io/google-apis-rs/google_mapsengine1/struct.MapPermissionListCall.html), [*publish*](http://byron.github.io/google-apis-rs/google_mapsengine1/struct.MapPublishCall.html) and [*unpublish*](http://byron.github.io/google-apis-rs/google_mapsengine1/struct.MapUnpublishCall.html) +* [projects](http://byron.github.io/google-apis-rs/google_mapsengine1/struct.Project.html) + * [*icons create*](http://byron.github.io/google-apis-rs/google_mapsengine1/struct.ProjectIconCreateCall.html), [*icons get*](http://byron.github.io/google-apis-rs/google_mapsengine1/struct.ProjectIconGetCall.html), [*icons list*](http://byron.github.io/google-apis-rs/google_mapsengine1/struct.ProjectIconListCall.html) and [*list*](http://byron.github.io/google-apis-rs/google_mapsengine1/struct.ProjectListCall.html) +* [raster collections](http://byron.github.io/google-apis-rs/google_mapsengine1/struct.RasterCollection.html) + * [*cancel processing*](http://byron.github.io/google-apis-rs/google_mapsengine1/struct.RasterCollectionCancelProcessingCall.html), [*create*](http://byron.github.io/google-apis-rs/google_mapsengine1/struct.RasterCollectionCreateCall.html), [*delete*](http://byron.github.io/google-apis-rs/google_mapsengine1/struct.RasterCollectionDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google_mapsengine1/struct.RasterCollectionGetCall.html), [*list*](http://byron.github.io/google-apis-rs/google_mapsengine1/struct.RasterCollectionListCall.html), [*parents list*](http://byron.github.io/google-apis-rs/google_mapsengine1/struct.RasterCollectionParentListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google_mapsengine1/struct.RasterCollectionPatchCall.html), [*permissions batch delete*](http://byron.github.io/google-apis-rs/google_mapsengine1/struct.RasterCollectionPermissionBatchDeleteCall.html), [*permissions batch update*](http://byron.github.io/google-apis-rs/google_mapsengine1/struct.RasterCollectionPermissionBatchUpdateCall.html), [*permissions list*](http://byron.github.io/google-apis-rs/google_mapsengine1/struct.RasterCollectionPermissionListCall.html), [*process*](http://byron.github.io/google-apis-rs/google_mapsengine1/struct.RasterCollectionProcesCall.html), [*rasters batch delete*](http://byron.github.io/google-apis-rs/google_mapsengine1/struct.RasterCollectionRasterBatchDeleteCall.html), [*rasters batch insert*](http://byron.github.io/google-apis-rs/google_mapsengine1/struct.RasterCollectionRasterBatchInsertCall.html) and [*rasters list*](http://byron.github.io/google-apis-rs/google_mapsengine1/struct.RasterCollectionRasterListCall.html) +* [rasters](http://byron.github.io/google-apis-rs/google_mapsengine1/struct.Raster.html) + * [*delete*](http://byron.github.io/google-apis-rs/google_mapsengine1/struct.RasterDeleteCall.html), [*files insert*](http://byron.github.io/google-apis-rs/google_mapsengine1/struct.RasterFileInsertCall.html), [*get*](http://byron.github.io/google-apis-rs/google_mapsengine1/struct.RasterGetCall.html), [*list*](http://byron.github.io/google-apis-rs/google_mapsengine1/struct.RasterListCall.html), [*parents list*](http://byron.github.io/google-apis-rs/google_mapsengine1/struct.RasterParentListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google_mapsengine1/struct.RasterPatchCall.html), [*permissions batch delete*](http://byron.github.io/google-apis-rs/google_mapsengine1/struct.RasterPermissionBatchDeleteCall.html), [*permissions batch update*](http://byron.github.io/google-apis-rs/google_mapsengine1/struct.RasterPermissionBatchUpdateCall.html), [*permissions list*](http://byron.github.io/google-apis-rs/google_mapsengine1/struct.RasterPermissionListCall.html), [*process*](http://byron.github.io/google-apis-rs/google_mapsengine1/struct.RasterProcesCall.html) and [*upload*](http://byron.github.io/google-apis-rs/google_mapsengine1/struct.RasterUploadCall.html) +* [tables](http://byron.github.io/google-apis-rs/google_mapsengine1/struct.Table.html) + * [*create*](http://byron.github.io/google-apis-rs/google_mapsengine1/struct.TableCreateCall.html), [*delete*](http://byron.github.io/google-apis-rs/google_mapsengine1/struct.TableDeleteCall.html), [*features batch delete*](http://byron.github.io/google-apis-rs/google_mapsengine1/struct.TableFeatureBatchDeleteCall.html), [*features batch insert*](http://byron.github.io/google-apis-rs/google_mapsengine1/struct.TableFeatureBatchInsertCall.html), [*features batch patch*](http://byron.github.io/google-apis-rs/google_mapsengine1/struct.TableFeatureBatchPatchCall.html), [*features get*](http://byron.github.io/google-apis-rs/google_mapsengine1/struct.TableFeatureGetCall.html), [*features list*](http://byron.github.io/google-apis-rs/google_mapsengine1/struct.TableFeatureListCall.html), [*files insert*](http://byron.github.io/google-apis-rs/google_mapsengine1/struct.TableFileInsertCall.html), [*get*](http://byron.github.io/google-apis-rs/google_mapsengine1/struct.TableGetCall.html), [*list*](http://byron.github.io/google-apis-rs/google_mapsengine1/struct.TableListCall.html), [*parents list*](http://byron.github.io/google-apis-rs/google_mapsengine1/struct.TableParentListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google_mapsengine1/struct.TablePatchCall.html), [*permissions batch delete*](http://byron.github.io/google-apis-rs/google_mapsengine1/struct.TablePermissionBatchDeleteCall.html), [*permissions batch update*](http://byron.github.io/google-apis-rs/google_mapsengine1/struct.TablePermissionBatchUpdateCall.html), [*permissions list*](http://byron.github.io/google-apis-rs/google_mapsengine1/struct.TablePermissionListCall.html), [*process*](http://byron.github.io/google-apis-rs/google_mapsengine1/struct.TableProcesCall.html) and [*upload*](http://byron.github.io/google-apis-rs/google_mapsengine1/struct.TableUploadCall.html) Upload supported by ... -* [*icons create projects*](http://byron.github.io/google-apis-rs/google-mapsengine1/struct.ProjectIconCreateCall.html) -* [*files insert tables*](http://byron.github.io/google-apis-rs/google-mapsengine1/struct.TableFileInsertCall.html) -* [*files insert rasters*](http://byron.github.io/google-apis-rs/google-mapsengine1/struct.RasterFileInsertCall.html) +* [*icons create projects*](http://byron.github.io/google-apis-rs/google_mapsengine1/struct.ProjectIconCreateCall.html) +* [*files insert tables*](http://byron.github.io/google-apis-rs/google_mapsengine1/struct.TableFileInsertCall.html) +* [*files insert rasters*](http://byron.github.io/google-apis-rs/google_mapsengine1/struct.RasterFileInsertCall.html) Download supported by ... -* [*icons get projects*](http://byron.github.io/google-apis-rs/google-mapsengine1/struct.ProjectIconGetCall.html) +* [*icons get projects*](http://byron.github.io/google-apis-rs/google_mapsengine1/struct.ProjectIconGetCall.html) @@ -45,17 +45,17 @@ Download supported by ... The API is structured into the following primary items: -* **[Hub](http://byron.github.io/google-apis-rs/google-mapsengine1/struct.MapsEngine.html)** +* **[Hub](http://byron.github.io/google-apis-rs/google_mapsengine1/struct.MapsEngine.html)** * a central object to maintain state and allow accessing all *Activities* - * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google-mapsengine1/trait.MethodsBuilder.html) which in turn - allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google-mapsengine1/trait.CallBuilder.html) -* **[Resources](http://byron.github.io/google-apis-rs/google-mapsengine1/trait.Resource.html)** + * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google_mapsengine1/trait.MethodsBuilder.html) which in turn + allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google_mapsengine1/trait.CallBuilder.html) +* **[Resources](http://byron.github.io/google-apis-rs/google_mapsengine1/trait.Resource.html)** * primary types that you can apply *Activities* to * a collection of properties and *Parts* - * **[Parts](http://byron.github.io/google-apis-rs/google-mapsengine1/trait.Part.html)** + * **[Parts](http://byron.github.io/google-apis-rs/google_mapsengine1/trait.Part.html)** * a collection of properties * never directly used in *Activities* -* **[Activities](http://byron.github.io/google-apis-rs/google-mapsengine1/trait.CallBuilder.html)** +* **[Activities](http://byron.github.io/google-apis-rs/google_mapsengine1/trait.CallBuilder.html)** * operations to apply to *Resources* All *structures* are marked with applicable traits to further categorize them and ease browsing. @@ -163,17 +163,17 @@ match result { ``` ## Handling Errors -All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google-mapsengine1/enum.Result.html) enumeration as return value of +All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google_mapsengine1/enum.Result.html) enumeration as return value of the doit() methods, or handed as possibly intermediate results to either the -[Hub Delegate](http://byron.github.io/google-apis-rs/google-mapsengine1/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google-mapsengine1/../yup-oauth2/trait.AuthenticatorDelegate.html). +[Hub Delegate](http://byron.github.io/google-apis-rs/google_mapsengine1/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google_mapsengine1/../yup-oauth2/trait.AuthenticatorDelegate.html). 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](http://byron.github.io/google-apis-rs/google-mapsengine1/enum.Result.html), should be +If a method supports downloads, the response body, which is part of the [Result](http://byron.github.io/google-apis-rs/google_mapsengine1/enum.Result.html), should be read by you to obtain the media. -If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google-mapsengine1/trait.ResponseResult.html), it will return that by default. +If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google_mapsengine1/trait.ResponseResult.html), 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")`. @@ -183,29 +183,29 @@ Methods supporting uploads can do so using up to 2 different protocols: ## Customization and Callbacks -You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google-mapsengine1/trait.Delegate.html) to the -[Method Builder](http://byron.github.io/google-apis-rs/google-mapsengine1/trait.CallBuilder.html) before making the final `doit()` call. +You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google_mapsengine1/trait.Delegate.html) to the +[Method Builder](http://byron.github.io/google-apis-rs/google_mapsengine1/trait.CallBuilder.html) 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](http://byron.github.io/google-apis-rs/google-mapsengine1/trait.Delegate.html) is default-implemented, allowing you to customize it with minimal effort. +The [delegate trait](http://byron.github.io/google-apis-rs/google_mapsengine1/trait.Delegate.html) 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](http://byron.github.io/google-apis-rs/google-mapsengine1/trait.RequestValue.html) and -[decodable](http://byron.github.io/google-apis-rs/google-mapsengine1/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses +All structures provided by this library are made to be [enocodable](http://byron.github.io/google-apis-rs/google_mapsengine1/trait.RequestValue.html) and +[decodable](http://byron.github.io/google-apis-rs/google_mapsengine1/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses are valid. -Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google-mapsengine1/trait.Part.html) which are identifiable by name, which will be sent to +Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google_mapsengine1/trait.Part.html) 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](http://byron.github.io/google-apis-rs/google-mapsengine1/trait.CallBuilder.html), you are able to prepare an action call by repeatedly calling it's methods. +Using [method builders](http://byron.github.io/google-apis-rs/google_mapsengine1/trait.CallBuilder.html), 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][wiki-pod] are handed by copy * strings are passed as `&str` -* [request values](http://byron.github.io/google-apis-rs/google-mapsengine1/trait.RequestValue.html) are borrowed +* [request values](http://byron.github.io/google-apis-rs/google_mapsengine1/trait.RequestValue.html) are borrowed Arguments will always be copied or cloned into the builder, to make them independent of their original life times. diff --git a/gen/mirror1/README.md b/gen/mirror1/README.md index 4912b169c1..8c5179212c 100644 --- a/gen/mirror1/README.md +++ b/gen/mirror1/README.md @@ -11,31 +11,31 @@ Everything else about the *mirror* *v1* API can be found at the [official documentation site](https://developers.google.com/glass). # Features -Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google-mirror1/struct.Mirror.html) ... +Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google_mirror1/struct.Mirror.html) ... -* [accounts](http://byron.github.io/google-apis-rs/google-mirror1/struct.Account.html) - * [*insert*](http://byron.github.io/google-apis-rs/google-mirror1/struct.AccountInsertCall.html) -* [contacts](http://byron.github.io/google-apis-rs/google-mirror1/struct.Contact.html) - * [*delete*](http://byron.github.io/google-apis-rs/google-mirror1/struct.ContactDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google-mirror1/struct.ContactGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google-mirror1/struct.ContactInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google-mirror1/struct.ContactListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google-mirror1/struct.ContactPatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google-mirror1/struct.ContactUpdateCall.html) -* [locations](http://byron.github.io/google-apis-rs/google-mirror1/struct.Location.html) - * [*get*](http://byron.github.io/google-apis-rs/google-mirror1/struct.LocationGetCall.html) and [*list*](http://byron.github.io/google-apis-rs/google-mirror1/struct.LocationListCall.html) -* [settings](http://byron.github.io/google-apis-rs/google-mirror1/struct.Setting.html) - * [*get*](http://byron.github.io/google-apis-rs/google-mirror1/struct.SettingGetCall.html) -* [subscriptions](http://byron.github.io/google-apis-rs/google-mirror1/struct.Subscription.html) - * [*delete*](http://byron.github.io/google-apis-rs/google-mirror1/struct.SubscriptionDeleteCall.html), [*insert*](http://byron.github.io/google-apis-rs/google-mirror1/struct.SubscriptionInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google-mirror1/struct.SubscriptionListCall.html) and [*update*](http://byron.github.io/google-apis-rs/google-mirror1/struct.SubscriptionUpdateCall.html) +* [accounts](http://byron.github.io/google-apis-rs/google_mirror1/struct.Account.html) + * [*insert*](http://byron.github.io/google-apis-rs/google_mirror1/struct.AccountInsertCall.html) +* [contacts](http://byron.github.io/google-apis-rs/google_mirror1/struct.Contact.html) + * [*delete*](http://byron.github.io/google-apis-rs/google_mirror1/struct.ContactDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google_mirror1/struct.ContactGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google_mirror1/struct.ContactInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google_mirror1/struct.ContactListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google_mirror1/struct.ContactPatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google_mirror1/struct.ContactUpdateCall.html) +* [locations](http://byron.github.io/google-apis-rs/google_mirror1/struct.Location.html) + * [*get*](http://byron.github.io/google-apis-rs/google_mirror1/struct.LocationGetCall.html) and [*list*](http://byron.github.io/google-apis-rs/google_mirror1/struct.LocationListCall.html) +* [settings](http://byron.github.io/google-apis-rs/google_mirror1/struct.Setting.html) + * [*get*](http://byron.github.io/google-apis-rs/google_mirror1/struct.SettingGetCall.html) +* [subscriptions](http://byron.github.io/google-apis-rs/google_mirror1/struct.Subscription.html) + * [*delete*](http://byron.github.io/google-apis-rs/google_mirror1/struct.SubscriptionDeleteCall.html), [*insert*](http://byron.github.io/google-apis-rs/google_mirror1/struct.SubscriptionInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google_mirror1/struct.SubscriptionListCall.html) and [*update*](http://byron.github.io/google-apis-rs/google_mirror1/struct.SubscriptionUpdateCall.html) * timeline - * [*attachments delete*](http://byron.github.io/google-apis-rs/google-mirror1/struct.TimelineAttachmentDeleteCall.html), [*attachments get*](http://byron.github.io/google-apis-rs/google-mirror1/struct.TimelineAttachmentGetCall.html), [*attachments insert*](http://byron.github.io/google-apis-rs/google-mirror1/struct.TimelineAttachmentInsertCall.html), [*attachments list*](http://byron.github.io/google-apis-rs/google-mirror1/struct.TimelineAttachmentListCall.html), [*delete*](http://byron.github.io/google-apis-rs/google-mirror1/struct.TimelineDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google-mirror1/struct.TimelineGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google-mirror1/struct.TimelineInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google-mirror1/struct.TimelineListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google-mirror1/struct.TimelinePatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google-mirror1/struct.TimelineUpdateCall.html) + * [*attachments delete*](http://byron.github.io/google-apis-rs/google_mirror1/struct.TimelineAttachmentDeleteCall.html), [*attachments get*](http://byron.github.io/google-apis-rs/google_mirror1/struct.TimelineAttachmentGetCall.html), [*attachments insert*](http://byron.github.io/google-apis-rs/google_mirror1/struct.TimelineAttachmentInsertCall.html), [*attachments list*](http://byron.github.io/google-apis-rs/google_mirror1/struct.TimelineAttachmentListCall.html), [*delete*](http://byron.github.io/google-apis-rs/google_mirror1/struct.TimelineDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google_mirror1/struct.TimelineGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google_mirror1/struct.TimelineInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google_mirror1/struct.TimelineListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google_mirror1/struct.TimelinePatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google_mirror1/struct.TimelineUpdateCall.html) Upload supported by ... -* [*update timeline*](http://byron.github.io/google-apis-rs/google-mirror1/struct.TimelineUpdateCall.html) -* [*insert timeline*](http://byron.github.io/google-apis-rs/google-mirror1/struct.TimelineInsertCall.html) -* [*attachments insert timeline*](http://byron.github.io/google-apis-rs/google-mirror1/struct.TimelineAttachmentInsertCall.html) +* [*update timeline*](http://byron.github.io/google-apis-rs/google_mirror1/struct.TimelineUpdateCall.html) +* [*insert timeline*](http://byron.github.io/google-apis-rs/google_mirror1/struct.TimelineInsertCall.html) +* [*attachments insert timeline*](http://byron.github.io/google-apis-rs/google_mirror1/struct.TimelineAttachmentInsertCall.html) Download supported by ... -* [*attachments get timeline*](http://byron.github.io/google-apis-rs/google-mirror1/struct.TimelineAttachmentGetCall.html) +* [*attachments get timeline*](http://byron.github.io/google-apis-rs/google_mirror1/struct.TimelineAttachmentGetCall.html) @@ -43,17 +43,17 @@ Download supported by ... The API is structured into the following primary items: -* **[Hub](http://byron.github.io/google-apis-rs/google-mirror1/struct.Mirror.html)** +* **[Hub](http://byron.github.io/google-apis-rs/google_mirror1/struct.Mirror.html)** * a central object to maintain state and allow accessing all *Activities* - * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google-mirror1/trait.MethodsBuilder.html) which in turn - allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google-mirror1/trait.CallBuilder.html) -* **[Resources](http://byron.github.io/google-apis-rs/google-mirror1/trait.Resource.html)** + * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google_mirror1/trait.MethodsBuilder.html) which in turn + allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google_mirror1/trait.CallBuilder.html) +* **[Resources](http://byron.github.io/google-apis-rs/google_mirror1/trait.Resource.html)** * primary types that you can apply *Activities* to * a collection of properties and *Parts* - * **[Parts](http://byron.github.io/google-apis-rs/google-mirror1/trait.Part.html)** + * **[Parts](http://byron.github.io/google-apis-rs/google_mirror1/trait.Part.html)** * a collection of properties * never directly used in *Activities* -* **[Activities](http://byron.github.io/google-apis-rs/google-mirror1/trait.CallBuilder.html)** +* **[Activities](http://byron.github.io/google-apis-rs/google_mirror1/trait.CallBuilder.html)** * operations to apply to *Resources* All *structures* are marked with applicable traits to further categorize them and ease browsing. @@ -143,17 +143,17 @@ match result { ``` ## Handling Errors -All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google-mirror1/enum.Result.html) enumeration as return value of +All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google_mirror1/enum.Result.html) enumeration as return value of the doit() methods, or handed as possibly intermediate results to either the -[Hub Delegate](http://byron.github.io/google-apis-rs/google-mirror1/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google-mirror1/../yup-oauth2/trait.AuthenticatorDelegate.html). +[Hub Delegate](http://byron.github.io/google-apis-rs/google_mirror1/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google_mirror1/../yup-oauth2/trait.AuthenticatorDelegate.html). 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](http://byron.github.io/google-apis-rs/google-mirror1/enum.Result.html), should be +If a method supports downloads, the response body, which is part of the [Result](http://byron.github.io/google-apis-rs/google_mirror1/enum.Result.html), should be read by you to obtain the media. -If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google-mirror1/trait.ResponseResult.html), it will return that by default. +If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google_mirror1/trait.ResponseResult.html), 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")`. @@ -163,29 +163,29 @@ Methods supporting uploads can do so using up to 2 different protocols: ## Customization and Callbacks -You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google-mirror1/trait.Delegate.html) to the -[Method Builder](http://byron.github.io/google-apis-rs/google-mirror1/trait.CallBuilder.html) before making the final `doit()` call. +You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google_mirror1/trait.Delegate.html) to the +[Method Builder](http://byron.github.io/google-apis-rs/google_mirror1/trait.CallBuilder.html) 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](http://byron.github.io/google-apis-rs/google-mirror1/trait.Delegate.html) is default-implemented, allowing you to customize it with minimal effort. +The [delegate trait](http://byron.github.io/google-apis-rs/google_mirror1/trait.Delegate.html) 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](http://byron.github.io/google-apis-rs/google-mirror1/trait.RequestValue.html) and -[decodable](http://byron.github.io/google-apis-rs/google-mirror1/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses +All structures provided by this library are made to be [enocodable](http://byron.github.io/google-apis-rs/google_mirror1/trait.RequestValue.html) and +[decodable](http://byron.github.io/google-apis-rs/google_mirror1/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses are valid. -Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google-mirror1/trait.Part.html) which are identifiable by name, which will be sent to +Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google_mirror1/trait.Part.html) 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](http://byron.github.io/google-apis-rs/google-mirror1/trait.CallBuilder.html), you are able to prepare an action call by repeatedly calling it's methods. +Using [method builders](http://byron.github.io/google-apis-rs/google_mirror1/trait.CallBuilder.html), 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][wiki-pod] are handed by copy * strings are passed as `&str` -* [request values](http://byron.github.io/google-apis-rs/google-mirror1/trait.RequestValue.html) are borrowed +* [request values](http://byron.github.io/google-apis-rs/google_mirror1/trait.RequestValue.html) are borrowed Arguments will always be copied or cloned into the builder, to make them independent of their original life times. diff --git a/gen/oauth2_v2/README.md b/gen/oauth2_v2/README.md index cf0d85869f..2d9b2074d5 100644 --- a/gen/oauth2_v2/README.md +++ b/gen/oauth2_v2/README.md @@ -11,15 +11,15 @@ Everything else about the *oauth2* *v2* API can be found at the [official documentation site](https://developers.google.com/accounts/docs/OAuth2). # Features -Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google-oauth2_v2/struct.Oauth2.html) ... +Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google_oauth2_v2/struct.Oauth2.html) ... * userinfo - * [*get*](http://byron.github.io/google-apis-rs/google-oauth2_v2/struct.UserinfoGetCall.html) and [*v2 me get*](http://byron.github.io/google-apis-rs/google-oauth2_v2/struct.UserinfoV2MeGetCall.html) + * [*get*](http://byron.github.io/google-apis-rs/google_oauth2_v2/struct.UserinfoGetCall.html) and [*v2 me get*](http://byron.github.io/google-apis-rs/google_oauth2_v2/struct.UserinfoV2MeGetCall.html) Other activities are ... -* [get cert for open id connect](http://byron.github.io/google-apis-rs/google-oauth2_v2/struct.MethodGetCertForOpenIdConnectCall.html) -* [tokeninfo](http://byron.github.io/google-apis-rs/google-oauth2_v2/struct.MethodTokeninfoCall.html) +* [get cert for open id connect](http://byron.github.io/google-apis-rs/google_oauth2_v2/struct.MethodGetCertForOpenIdConnectCall.html) +* [tokeninfo](http://byron.github.io/google-apis-rs/google_oauth2_v2/struct.MethodTokeninfoCall.html) @@ -27,17 +27,17 @@ Other activities are ... The API is structured into the following primary items: -* **[Hub](http://byron.github.io/google-apis-rs/google-oauth2_v2/struct.Oauth2.html)** +* **[Hub](http://byron.github.io/google-apis-rs/google_oauth2_v2/struct.Oauth2.html)** * a central object to maintain state and allow accessing all *Activities* - * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google-oauth2_v2/trait.MethodsBuilder.html) which in turn - allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google-oauth2_v2/trait.CallBuilder.html) -* **[Resources](http://byron.github.io/google-apis-rs/google-oauth2_v2/trait.Resource.html)** + * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google_oauth2_v2/trait.MethodsBuilder.html) which in turn + allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google_oauth2_v2/trait.CallBuilder.html) +* **[Resources](http://byron.github.io/google-apis-rs/google_oauth2_v2/trait.Resource.html)** * primary types that you can apply *Activities* to * a collection of properties and *Parts* - * **[Parts](http://byron.github.io/google-apis-rs/google-oauth2_v2/trait.Part.html)** + * **[Parts](http://byron.github.io/google-apis-rs/google_oauth2_v2/trait.Part.html)** * a collection of properties * never directly used in *Activities* -* **[Activities](http://byron.github.io/google-apis-rs/google-oauth2_v2/trait.CallBuilder.html)** +* **[Activities](http://byron.github.io/google-apis-rs/google_oauth2_v2/trait.CallBuilder.html)** * operations to apply to *Resources* All *structures* are marked with applicable traits to further categorize them and ease browsing. @@ -117,17 +117,17 @@ match result { ``` ## Handling Errors -All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google-oauth2_v2/enum.Result.html) enumeration as return value of +All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google_oauth2_v2/enum.Result.html) enumeration as return value of the doit() methods, or handed as possibly intermediate results to either the -[Hub Delegate](http://byron.github.io/google-apis-rs/google-oauth2_v2/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google-oauth2_v2/../yup-oauth2/trait.AuthenticatorDelegate.html). +[Hub Delegate](http://byron.github.io/google-apis-rs/google_oauth2_v2/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google_oauth2_v2/../yup-oauth2/trait.AuthenticatorDelegate.html). 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](http://byron.github.io/google-apis-rs/google-oauth2_v2/enum.Result.html), should be +If a method supports downloads, the response body, which is part of the [Result](http://byron.github.io/google-apis-rs/google_oauth2_v2/enum.Result.html), should be read by you to obtain the media. -If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google-oauth2_v2/trait.ResponseResult.html), it will return that by default. +If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google_oauth2_v2/trait.ResponseResult.html), 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")`. @@ -137,29 +137,29 @@ Methods supporting uploads can do so using up to 2 different protocols: ## Customization and Callbacks -You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google-oauth2_v2/trait.Delegate.html) to the -[Method Builder](http://byron.github.io/google-apis-rs/google-oauth2_v2/trait.CallBuilder.html) before making the final `doit()` call. +You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google_oauth2_v2/trait.Delegate.html) to the +[Method Builder](http://byron.github.io/google-apis-rs/google_oauth2_v2/trait.CallBuilder.html) 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](http://byron.github.io/google-apis-rs/google-oauth2_v2/trait.Delegate.html) is default-implemented, allowing you to customize it with minimal effort. +The [delegate trait](http://byron.github.io/google-apis-rs/google_oauth2_v2/trait.Delegate.html) 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](http://byron.github.io/google-apis-rs/google-oauth2_v2/trait.RequestValue.html) and -[decodable](http://byron.github.io/google-apis-rs/google-oauth2_v2/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses +All structures provided by this library are made to be [enocodable](http://byron.github.io/google-apis-rs/google_oauth2_v2/trait.RequestValue.html) and +[decodable](http://byron.github.io/google-apis-rs/google_oauth2_v2/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses are valid. -Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google-oauth2_v2/trait.Part.html) which are identifiable by name, which will be sent to +Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google_oauth2_v2/trait.Part.html) 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](http://byron.github.io/google-apis-rs/google-oauth2_v2/trait.CallBuilder.html), you are able to prepare an action call by repeatedly calling it's methods. +Using [method builders](http://byron.github.io/google-apis-rs/google_oauth2_v2/trait.CallBuilder.html), 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][wiki-pod] are handed by copy * strings are passed as `&str` -* [request values](http://byron.github.io/google-apis-rs/google-oauth2_v2/trait.RequestValue.html) are borrowed +* [request values](http://byron.github.io/google-apis-rs/google_oauth2_v2/trait.RequestValue.html) are borrowed Arguments will always be copied or cloned into the builder, to make them independent of their original life times. diff --git a/gen/pagespeedonline2/README.md b/gen/pagespeedonline2/README.md index e34989cd10..e8c566dc18 100644 --- a/gen/pagespeedonline2/README.md +++ b/gen/pagespeedonline2/README.md @@ -11,10 +11,10 @@ Everything else about the *pagespeedonline* *v2* API can be found at the [official documentation site](https://developers.google.com/speed/docs/insights/v2/getting-started). # Features -Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google-pagespeedonline2/struct.Pagespeedonline.html) ... +Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google_pagespeedonline2/struct.Pagespeedonline.html) ... * pagespeedapi - * [*runpagespeed*](http://byron.github.io/google-apis-rs/google-pagespeedonline2/struct.PagespeedapiRunpagespeedCall.html) + * [*runpagespeed*](http://byron.github.io/google-apis-rs/google_pagespeedonline2/struct.PagespeedapiRunpagespeedCall.html) @@ -23,17 +23,17 @@ Handle the following *Resources* with ease from the central [hub](http://byron.g The API is structured into the following primary items: -* **[Hub](http://byron.github.io/google-apis-rs/google-pagespeedonline2/struct.Pagespeedonline.html)** +* **[Hub](http://byron.github.io/google-apis-rs/google_pagespeedonline2/struct.Pagespeedonline.html)** * a central object to maintain state and allow accessing all *Activities* - * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google-pagespeedonline2/trait.MethodsBuilder.html) which in turn - allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google-pagespeedonline2/trait.CallBuilder.html) -* **[Resources](http://byron.github.io/google-apis-rs/google-pagespeedonline2/trait.Resource.html)** + * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google_pagespeedonline2/trait.MethodsBuilder.html) which in turn + allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google_pagespeedonline2/trait.CallBuilder.html) +* **[Resources](http://byron.github.io/google-apis-rs/google_pagespeedonline2/trait.Resource.html)** * primary types that you can apply *Activities* to * a collection of properties and *Parts* - * **[Parts](http://byron.github.io/google-apis-rs/google-pagespeedonline2/trait.Part.html)** + * **[Parts](http://byron.github.io/google-apis-rs/google_pagespeedonline2/trait.Part.html)** * a collection of properties * never directly used in *Activities* -* **[Activities](http://byron.github.io/google-apis-rs/google-pagespeedonline2/trait.CallBuilder.html)** +* **[Activities](http://byron.github.io/google-apis-rs/google_pagespeedonline2/trait.CallBuilder.html)** * operations to apply to *Resources* All *structures* are marked with applicable traits to further categorize them and ease browsing. @@ -117,17 +117,17 @@ match result { ``` ## Handling Errors -All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google-pagespeedonline2/enum.Result.html) enumeration as return value of +All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google_pagespeedonline2/enum.Result.html) enumeration as return value of the doit() methods, or handed as possibly intermediate results to either the -[Hub Delegate](http://byron.github.io/google-apis-rs/google-pagespeedonline2/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google-pagespeedonline2/../yup-oauth2/trait.AuthenticatorDelegate.html). +[Hub Delegate](http://byron.github.io/google-apis-rs/google_pagespeedonline2/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google_pagespeedonline2/../yup-oauth2/trait.AuthenticatorDelegate.html). 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](http://byron.github.io/google-apis-rs/google-pagespeedonline2/enum.Result.html), should be +If a method supports downloads, the response body, which is part of the [Result](http://byron.github.io/google-apis-rs/google_pagespeedonline2/enum.Result.html), should be read by you to obtain the media. -If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google-pagespeedonline2/trait.ResponseResult.html), it will return that by default. +If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google_pagespeedonline2/trait.ResponseResult.html), 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")`. @@ -137,29 +137,29 @@ Methods supporting uploads can do so using up to 2 different protocols: ## Customization and Callbacks -You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google-pagespeedonline2/trait.Delegate.html) to the -[Method Builder](http://byron.github.io/google-apis-rs/google-pagespeedonline2/trait.CallBuilder.html) before making the final `doit()` call. +You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google_pagespeedonline2/trait.Delegate.html) to the +[Method Builder](http://byron.github.io/google-apis-rs/google_pagespeedonline2/trait.CallBuilder.html) 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](http://byron.github.io/google-apis-rs/google-pagespeedonline2/trait.Delegate.html) is default-implemented, allowing you to customize it with minimal effort. +The [delegate trait](http://byron.github.io/google-apis-rs/google_pagespeedonline2/trait.Delegate.html) 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](http://byron.github.io/google-apis-rs/google-pagespeedonline2/trait.RequestValue.html) and -[decodable](http://byron.github.io/google-apis-rs/google-pagespeedonline2/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses +All structures provided by this library are made to be [enocodable](http://byron.github.io/google-apis-rs/google_pagespeedonline2/trait.RequestValue.html) and +[decodable](http://byron.github.io/google-apis-rs/google_pagespeedonline2/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses are valid. -Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google-pagespeedonline2/trait.Part.html) which are identifiable by name, which will be sent to +Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google_pagespeedonline2/trait.Part.html) 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](http://byron.github.io/google-apis-rs/google-pagespeedonline2/trait.CallBuilder.html), you are able to prepare an action call by repeatedly calling it's methods. +Using [method builders](http://byron.github.io/google-apis-rs/google_pagespeedonline2/trait.CallBuilder.html), 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][wiki-pod] are handed by copy * strings are passed as `&str` -* [request values](http://byron.github.io/google-apis-rs/google-pagespeedonline2/trait.RequestValue.html) are borrowed +* [request values](http://byron.github.io/google-apis-rs/google_pagespeedonline2/trait.RequestValue.html) are borrowed Arguments will always be copied or cloned into the builder, to make them independent of their original life times. diff --git a/gen/plus1/README.md b/gen/plus1/README.md index dd9a3e9e71..39924807c5 100644 --- a/gen/plus1/README.md +++ b/gen/plus1/README.md @@ -11,16 +11,16 @@ Everything else about the *plus* *v1* API can be found at the [official documentation site](https://developers.google.com/+/api/). # Features -Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google-plus1/struct.Plus.html) ... +Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google_plus1/struct.Plus.html) ... -* [activities](http://byron.github.io/google-apis-rs/google-plus1/struct.Activity.html) - * [*get*](http://byron.github.io/google-apis-rs/google-plus1/struct.ActivityGetCall.html), [*list*](http://byron.github.io/google-apis-rs/google-plus1/struct.ActivityListCall.html) and [*search*](http://byron.github.io/google-apis-rs/google-plus1/struct.ActivitySearchCall.html) -* [comments](http://byron.github.io/google-apis-rs/google-plus1/struct.Comment.html) - * [*get*](http://byron.github.io/google-apis-rs/google-plus1/struct.CommentGetCall.html) and [*list*](http://byron.github.io/google-apis-rs/google-plus1/struct.CommentListCall.html) -* [moments](http://byron.github.io/google-apis-rs/google-plus1/struct.Moment.html) - * [*insert*](http://byron.github.io/google-apis-rs/google-plus1/struct.MomentInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google-plus1/struct.MomentListCall.html) and [*remove*](http://byron.github.io/google-apis-rs/google-plus1/struct.MomentRemoveCall.html) +* [activities](http://byron.github.io/google-apis-rs/google_plus1/struct.Activity.html) + * [*get*](http://byron.github.io/google-apis-rs/google_plus1/struct.ActivityGetCall.html), [*list*](http://byron.github.io/google-apis-rs/google_plus1/struct.ActivityListCall.html) and [*search*](http://byron.github.io/google-apis-rs/google_plus1/struct.ActivitySearchCall.html) +* [comments](http://byron.github.io/google-apis-rs/google_plus1/struct.Comment.html) + * [*get*](http://byron.github.io/google-apis-rs/google_plus1/struct.CommentGetCall.html) and [*list*](http://byron.github.io/google-apis-rs/google_plus1/struct.CommentListCall.html) +* [moments](http://byron.github.io/google-apis-rs/google_plus1/struct.Moment.html) + * [*insert*](http://byron.github.io/google-apis-rs/google_plus1/struct.MomentInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google_plus1/struct.MomentListCall.html) and [*remove*](http://byron.github.io/google-apis-rs/google_plus1/struct.MomentRemoveCall.html) * people - * [*get*](http://byron.github.io/google-apis-rs/google-plus1/struct.PeopleGetCall.html), [*list*](http://byron.github.io/google-apis-rs/google-plus1/struct.PeopleListCall.html), [*list by activity*](http://byron.github.io/google-apis-rs/google-plus1/struct.PeopleListByActivityCall.html) and [*search*](http://byron.github.io/google-apis-rs/google-plus1/struct.PeopleSearchCall.html) + * [*get*](http://byron.github.io/google-apis-rs/google_plus1/struct.PeopleGetCall.html), [*list*](http://byron.github.io/google-apis-rs/google_plus1/struct.PeopleListCall.html), [*list by activity*](http://byron.github.io/google-apis-rs/google_plus1/struct.PeopleListByActivityCall.html) and [*search*](http://byron.github.io/google-apis-rs/google_plus1/struct.PeopleSearchCall.html) @@ -29,17 +29,17 @@ Handle the following *Resources* with ease from the central [hub](http://byron.g The API is structured into the following primary items: -* **[Hub](http://byron.github.io/google-apis-rs/google-plus1/struct.Plus.html)** +* **[Hub](http://byron.github.io/google-apis-rs/google_plus1/struct.Plus.html)** * a central object to maintain state and allow accessing all *Activities* - * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google-plus1/trait.MethodsBuilder.html) which in turn - allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google-plus1/trait.CallBuilder.html) -* **[Resources](http://byron.github.io/google-apis-rs/google-plus1/trait.Resource.html)** + * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google_plus1/trait.MethodsBuilder.html) which in turn + allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google_plus1/trait.CallBuilder.html) +* **[Resources](http://byron.github.io/google-apis-rs/google_plus1/trait.Resource.html)** * primary types that you can apply *Activities* to * a collection of properties and *Parts* - * **[Parts](http://byron.github.io/google-apis-rs/google-plus1/trait.Part.html)** + * **[Parts](http://byron.github.io/google-apis-rs/google_plus1/trait.Part.html)** * a collection of properties * never directly used in *Activities* -* **[Activities](http://byron.github.io/google-apis-rs/google-plus1/trait.CallBuilder.html)** +* **[Activities](http://byron.github.io/google-apis-rs/google_plus1/trait.CallBuilder.html)** * operations to apply to *Resources* All *structures* are marked with applicable traits to further categorize them and ease browsing. @@ -123,17 +123,17 @@ match result { ``` ## Handling Errors -All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google-plus1/enum.Result.html) enumeration as return value of +All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google_plus1/enum.Result.html) enumeration as return value of the doit() methods, or handed as possibly intermediate results to either the -[Hub Delegate](http://byron.github.io/google-apis-rs/google-plus1/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google-plus1/../yup-oauth2/trait.AuthenticatorDelegate.html). +[Hub Delegate](http://byron.github.io/google-apis-rs/google_plus1/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google_plus1/../yup-oauth2/trait.AuthenticatorDelegate.html). 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](http://byron.github.io/google-apis-rs/google-plus1/enum.Result.html), should be +If a method supports downloads, the response body, which is part of the [Result](http://byron.github.io/google-apis-rs/google_plus1/enum.Result.html), should be read by you to obtain the media. -If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google-plus1/trait.ResponseResult.html), it will return that by default. +If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google_plus1/trait.ResponseResult.html), 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")`. @@ -143,29 +143,29 @@ Methods supporting uploads can do so using up to 2 different protocols: ## Customization and Callbacks -You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google-plus1/trait.Delegate.html) to the -[Method Builder](http://byron.github.io/google-apis-rs/google-plus1/trait.CallBuilder.html) before making the final `doit()` call. +You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google_plus1/trait.Delegate.html) to the +[Method Builder](http://byron.github.io/google-apis-rs/google_plus1/trait.CallBuilder.html) 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](http://byron.github.io/google-apis-rs/google-plus1/trait.Delegate.html) is default-implemented, allowing you to customize it with minimal effort. +The [delegate trait](http://byron.github.io/google-apis-rs/google_plus1/trait.Delegate.html) 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](http://byron.github.io/google-apis-rs/google-plus1/trait.RequestValue.html) and -[decodable](http://byron.github.io/google-apis-rs/google-plus1/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses +All structures provided by this library are made to be [enocodable](http://byron.github.io/google-apis-rs/google_plus1/trait.RequestValue.html) and +[decodable](http://byron.github.io/google-apis-rs/google_plus1/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses are valid. -Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google-plus1/trait.Part.html) which are identifiable by name, which will be sent to +Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google_plus1/trait.Part.html) 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](http://byron.github.io/google-apis-rs/google-plus1/trait.CallBuilder.html), you are able to prepare an action call by repeatedly calling it's methods. +Using [method builders](http://byron.github.io/google-apis-rs/google_plus1/trait.CallBuilder.html), 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][wiki-pod] are handed by copy * strings are passed as `&str` -* [request values](http://byron.github.io/google-apis-rs/google-plus1/trait.RequestValue.html) are borrowed +* [request values](http://byron.github.io/google-apis-rs/google_plus1/trait.RequestValue.html) are borrowed Arguments will always be copied or cloned into the builder, to make them independent of their original life times. diff --git a/gen/plusdomains1/README.md b/gen/plusdomains1/README.md index d3d842214d..86b13e5ac1 100644 --- a/gen/plusdomains1/README.md +++ b/gen/plusdomains1/README.md @@ -11,25 +11,25 @@ Everything else about the *plusDomains* *v1* API can be found at the [official documentation site](https://developers.google.com/+/domains/). # Features -Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google-plusdomains1/struct.PlusDomains.html) ... +Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google_plusdomains1/struct.PlusDomains.html) ... -* [activities](http://byron.github.io/google-apis-rs/google-plusdomains1/struct.Activity.html) - * [*get*](http://byron.github.io/google-apis-rs/google-plusdomains1/struct.ActivityGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google-plusdomains1/struct.ActivityInsertCall.html) and [*list*](http://byron.github.io/google-apis-rs/google-plusdomains1/struct.ActivityListCall.html) -* [audiences](http://byron.github.io/google-apis-rs/google-plusdomains1/struct.Audience.html) - * [*list*](http://byron.github.io/google-apis-rs/google-plusdomains1/struct.AudienceListCall.html) -* [circles](http://byron.github.io/google-apis-rs/google-plusdomains1/struct.Circle.html) - * [*add people*](http://byron.github.io/google-apis-rs/google-plusdomains1/struct.CircleAddPeopleCall.html), [*get*](http://byron.github.io/google-apis-rs/google-plusdomains1/struct.CircleGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google-plusdomains1/struct.CircleInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google-plusdomains1/struct.CircleListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google-plusdomains1/struct.CirclePatchCall.html), [*remove*](http://byron.github.io/google-apis-rs/google-plusdomains1/struct.CircleRemoveCall.html), [*remove people*](http://byron.github.io/google-apis-rs/google-plusdomains1/struct.CircleRemovePeopleCall.html) and [*update*](http://byron.github.io/google-apis-rs/google-plusdomains1/struct.CircleUpdateCall.html) -* [comments](http://byron.github.io/google-apis-rs/google-plusdomains1/struct.Comment.html) - * [*get*](http://byron.github.io/google-apis-rs/google-plusdomains1/struct.CommentGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google-plusdomains1/struct.CommentInsertCall.html) and [*list*](http://byron.github.io/google-apis-rs/google-plusdomains1/struct.CommentListCall.html) -* [media](http://byron.github.io/google-apis-rs/google-plusdomains1/struct.Media.html) - * [*insert*](http://byron.github.io/google-apis-rs/google-plusdomains1/struct.MediaInsertCall.html) +* [activities](http://byron.github.io/google-apis-rs/google_plusdomains1/struct.Activity.html) + * [*get*](http://byron.github.io/google-apis-rs/google_plusdomains1/struct.ActivityGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google_plusdomains1/struct.ActivityInsertCall.html) and [*list*](http://byron.github.io/google-apis-rs/google_plusdomains1/struct.ActivityListCall.html) +* [audiences](http://byron.github.io/google-apis-rs/google_plusdomains1/struct.Audience.html) + * [*list*](http://byron.github.io/google-apis-rs/google_plusdomains1/struct.AudienceListCall.html) +* [circles](http://byron.github.io/google-apis-rs/google_plusdomains1/struct.Circle.html) + * [*add people*](http://byron.github.io/google-apis-rs/google_plusdomains1/struct.CircleAddPeopleCall.html), [*get*](http://byron.github.io/google-apis-rs/google_plusdomains1/struct.CircleGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google_plusdomains1/struct.CircleInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google_plusdomains1/struct.CircleListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google_plusdomains1/struct.CirclePatchCall.html), [*remove*](http://byron.github.io/google-apis-rs/google_plusdomains1/struct.CircleRemoveCall.html), [*remove people*](http://byron.github.io/google-apis-rs/google_plusdomains1/struct.CircleRemovePeopleCall.html) and [*update*](http://byron.github.io/google-apis-rs/google_plusdomains1/struct.CircleUpdateCall.html) +* [comments](http://byron.github.io/google-apis-rs/google_plusdomains1/struct.Comment.html) + * [*get*](http://byron.github.io/google-apis-rs/google_plusdomains1/struct.CommentGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google_plusdomains1/struct.CommentInsertCall.html) and [*list*](http://byron.github.io/google-apis-rs/google_plusdomains1/struct.CommentListCall.html) +* [media](http://byron.github.io/google-apis-rs/google_plusdomains1/struct.Media.html) + * [*insert*](http://byron.github.io/google-apis-rs/google_plusdomains1/struct.MediaInsertCall.html) * people - * [*get*](http://byron.github.io/google-apis-rs/google-plusdomains1/struct.PeopleGetCall.html), [*list*](http://byron.github.io/google-apis-rs/google-plusdomains1/struct.PeopleListCall.html), [*list by activity*](http://byron.github.io/google-apis-rs/google-plusdomains1/struct.PeopleListByActivityCall.html) and [*list by circle*](http://byron.github.io/google-apis-rs/google-plusdomains1/struct.PeopleListByCircleCall.html) + * [*get*](http://byron.github.io/google-apis-rs/google_plusdomains1/struct.PeopleGetCall.html), [*list*](http://byron.github.io/google-apis-rs/google_plusdomains1/struct.PeopleListCall.html), [*list by activity*](http://byron.github.io/google-apis-rs/google_plusdomains1/struct.PeopleListByActivityCall.html) and [*list by circle*](http://byron.github.io/google-apis-rs/google_plusdomains1/struct.PeopleListByCircleCall.html) Upload supported by ... -* [*insert media*](http://byron.github.io/google-apis-rs/google-plusdomains1/struct.MediaInsertCall.html) +* [*insert media*](http://byron.github.io/google-apis-rs/google_plusdomains1/struct.MediaInsertCall.html) @@ -37,17 +37,17 @@ Upload supported by ... The API is structured into the following primary items: -* **[Hub](http://byron.github.io/google-apis-rs/google-plusdomains1/struct.PlusDomains.html)** +* **[Hub](http://byron.github.io/google-apis-rs/google_plusdomains1/struct.PlusDomains.html)** * a central object to maintain state and allow accessing all *Activities* - * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google-plusdomains1/trait.MethodsBuilder.html) which in turn - allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google-plusdomains1/trait.CallBuilder.html) -* **[Resources](http://byron.github.io/google-apis-rs/google-plusdomains1/trait.Resource.html)** + * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google_plusdomains1/trait.MethodsBuilder.html) which in turn + allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google_plusdomains1/trait.CallBuilder.html) +* **[Resources](http://byron.github.io/google-apis-rs/google_plusdomains1/trait.Resource.html)** * primary types that you can apply *Activities* to * a collection of properties and *Parts* - * **[Parts](http://byron.github.io/google-apis-rs/google-plusdomains1/trait.Part.html)** + * **[Parts](http://byron.github.io/google-apis-rs/google_plusdomains1/trait.Part.html)** * a collection of properties * never directly used in *Activities* -* **[Activities](http://byron.github.io/google-apis-rs/google-plusdomains1/trait.CallBuilder.html)** +* **[Activities](http://byron.github.io/google-apis-rs/google_plusdomains1/trait.CallBuilder.html)** * operations to apply to *Resources* All *structures* are marked with applicable traits to further categorize them and ease browsing. @@ -135,17 +135,17 @@ match result { ``` ## Handling Errors -All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google-plusdomains1/enum.Result.html) enumeration as return value of +All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google_plusdomains1/enum.Result.html) enumeration as return value of the doit() methods, or handed as possibly intermediate results to either the -[Hub Delegate](http://byron.github.io/google-apis-rs/google-plusdomains1/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google-plusdomains1/../yup-oauth2/trait.AuthenticatorDelegate.html). +[Hub Delegate](http://byron.github.io/google-apis-rs/google_plusdomains1/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google_plusdomains1/../yup-oauth2/trait.AuthenticatorDelegate.html). 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](http://byron.github.io/google-apis-rs/google-plusdomains1/enum.Result.html), should be +If a method supports downloads, the response body, which is part of the [Result](http://byron.github.io/google-apis-rs/google_plusdomains1/enum.Result.html), should be read by you to obtain the media. -If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google-plusdomains1/trait.ResponseResult.html), it will return that by default. +If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google_plusdomains1/trait.ResponseResult.html), 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")`. @@ -155,29 +155,29 @@ Methods supporting uploads can do so using up to 2 different protocols: ## Customization and Callbacks -You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google-plusdomains1/trait.Delegate.html) to the -[Method Builder](http://byron.github.io/google-apis-rs/google-plusdomains1/trait.CallBuilder.html) before making the final `doit()` call. +You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google_plusdomains1/trait.Delegate.html) to the +[Method Builder](http://byron.github.io/google-apis-rs/google_plusdomains1/trait.CallBuilder.html) 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](http://byron.github.io/google-apis-rs/google-plusdomains1/trait.Delegate.html) is default-implemented, allowing you to customize it with minimal effort. +The [delegate trait](http://byron.github.io/google-apis-rs/google_plusdomains1/trait.Delegate.html) 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](http://byron.github.io/google-apis-rs/google-plusdomains1/trait.RequestValue.html) and -[decodable](http://byron.github.io/google-apis-rs/google-plusdomains1/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses +All structures provided by this library are made to be [enocodable](http://byron.github.io/google-apis-rs/google_plusdomains1/trait.RequestValue.html) and +[decodable](http://byron.github.io/google-apis-rs/google_plusdomains1/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses are valid. -Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google-plusdomains1/trait.Part.html) which are identifiable by name, which will be sent to +Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google_plusdomains1/trait.Part.html) 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](http://byron.github.io/google-apis-rs/google-plusdomains1/trait.CallBuilder.html), you are able to prepare an action call by repeatedly calling it's methods. +Using [method builders](http://byron.github.io/google-apis-rs/google_plusdomains1/trait.CallBuilder.html), 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][wiki-pod] are handed by copy * strings are passed as `&str` -* [request values](http://byron.github.io/google-apis-rs/google-plusdomains1/trait.RequestValue.html) are borrowed +* [request values](http://byron.github.io/google-apis-rs/google_plusdomains1/trait.RequestValue.html) are borrowed Arguments will always be copied or cloned into the builder, to make them independent of their original life times. diff --git a/gen/prediction1d6/README.md b/gen/prediction1d6/README.md index 90be40d16f..62eb5c31ef 100644 --- a/gen/prediction1d6/README.md +++ b/gen/prediction1d6/README.md @@ -11,12 +11,12 @@ Everything else about the *prediction* *v1d6* API can be found at the [official documentation site](https://developers.google.com/prediction/docs/developer-guide). # Features -Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google-prediction1d6/struct.Prediction.html) ... +Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google_prediction1d6/struct.Prediction.html) ... * hostedmodels - * [*predict*](http://byron.github.io/google-apis-rs/google-prediction1d6/struct.HostedmodelPredictCall.html) + * [*predict*](http://byron.github.io/google-apis-rs/google_prediction1d6/struct.HostedmodelPredictCall.html) * trainedmodels - * [*analyze*](http://byron.github.io/google-apis-rs/google-prediction1d6/struct.TrainedmodelAnalyzeCall.html), [*delete*](http://byron.github.io/google-apis-rs/google-prediction1d6/struct.TrainedmodelDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google-prediction1d6/struct.TrainedmodelGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google-prediction1d6/struct.TrainedmodelInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google-prediction1d6/struct.TrainedmodelListCall.html), [*predict*](http://byron.github.io/google-apis-rs/google-prediction1d6/struct.TrainedmodelPredictCall.html) and [*update*](http://byron.github.io/google-apis-rs/google-prediction1d6/struct.TrainedmodelUpdateCall.html) + * [*analyze*](http://byron.github.io/google-apis-rs/google_prediction1d6/struct.TrainedmodelAnalyzeCall.html), [*delete*](http://byron.github.io/google-apis-rs/google_prediction1d6/struct.TrainedmodelDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google_prediction1d6/struct.TrainedmodelGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google_prediction1d6/struct.TrainedmodelInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google_prediction1d6/struct.TrainedmodelListCall.html), [*predict*](http://byron.github.io/google-apis-rs/google_prediction1d6/struct.TrainedmodelPredictCall.html) and [*update*](http://byron.github.io/google-apis-rs/google_prediction1d6/struct.TrainedmodelUpdateCall.html) @@ -25,17 +25,17 @@ Handle the following *Resources* with ease from the central [hub](http://byron.g The API is structured into the following primary items: -* **[Hub](http://byron.github.io/google-apis-rs/google-prediction1d6/struct.Prediction.html)** +* **[Hub](http://byron.github.io/google-apis-rs/google_prediction1d6/struct.Prediction.html)** * a central object to maintain state and allow accessing all *Activities* - * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google-prediction1d6/trait.MethodsBuilder.html) which in turn - allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google-prediction1d6/trait.CallBuilder.html) -* **[Resources](http://byron.github.io/google-apis-rs/google-prediction1d6/trait.Resource.html)** + * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google_prediction1d6/trait.MethodsBuilder.html) which in turn + allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google_prediction1d6/trait.CallBuilder.html) +* **[Resources](http://byron.github.io/google-apis-rs/google_prediction1d6/trait.Resource.html)** * primary types that you can apply *Activities* to * a collection of properties and *Parts* - * **[Parts](http://byron.github.io/google-apis-rs/google-prediction1d6/trait.Part.html)** + * **[Parts](http://byron.github.io/google-apis-rs/google_prediction1d6/trait.Part.html)** * a collection of properties * never directly used in *Activities* -* **[Activities](http://byron.github.io/google-apis-rs/google-prediction1d6/trait.CallBuilder.html)** +* **[Activities](http://byron.github.io/google-apis-rs/google_prediction1d6/trait.CallBuilder.html)** * operations to apply to *Resources* All *structures* are marked with applicable traits to further categorize them and ease browsing. @@ -122,17 +122,17 @@ match result { ``` ## Handling Errors -All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google-prediction1d6/enum.Result.html) enumeration as return value of +All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google_prediction1d6/enum.Result.html) enumeration as return value of the doit() methods, or handed as possibly intermediate results to either the -[Hub Delegate](http://byron.github.io/google-apis-rs/google-prediction1d6/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google-prediction1d6/../yup-oauth2/trait.AuthenticatorDelegate.html). +[Hub Delegate](http://byron.github.io/google-apis-rs/google_prediction1d6/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google_prediction1d6/../yup-oauth2/trait.AuthenticatorDelegate.html). 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](http://byron.github.io/google-apis-rs/google-prediction1d6/enum.Result.html), should be +If a method supports downloads, the response body, which is part of the [Result](http://byron.github.io/google-apis-rs/google_prediction1d6/enum.Result.html), should be read by you to obtain the media. -If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google-prediction1d6/trait.ResponseResult.html), it will return that by default. +If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google_prediction1d6/trait.ResponseResult.html), 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")`. @@ -142,29 +142,29 @@ Methods supporting uploads can do so using up to 2 different protocols: ## Customization and Callbacks -You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google-prediction1d6/trait.Delegate.html) to the -[Method Builder](http://byron.github.io/google-apis-rs/google-prediction1d6/trait.CallBuilder.html) before making the final `doit()` call. +You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google_prediction1d6/trait.Delegate.html) to the +[Method Builder](http://byron.github.io/google-apis-rs/google_prediction1d6/trait.CallBuilder.html) 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](http://byron.github.io/google-apis-rs/google-prediction1d6/trait.Delegate.html) is default-implemented, allowing you to customize it with minimal effort. +The [delegate trait](http://byron.github.io/google-apis-rs/google_prediction1d6/trait.Delegate.html) 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](http://byron.github.io/google-apis-rs/google-prediction1d6/trait.RequestValue.html) and -[decodable](http://byron.github.io/google-apis-rs/google-prediction1d6/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses +All structures provided by this library are made to be [enocodable](http://byron.github.io/google-apis-rs/google_prediction1d6/trait.RequestValue.html) and +[decodable](http://byron.github.io/google-apis-rs/google_prediction1d6/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses are valid. -Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google-prediction1d6/trait.Part.html) which are identifiable by name, which will be sent to +Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google_prediction1d6/trait.Part.html) 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](http://byron.github.io/google-apis-rs/google-prediction1d6/trait.CallBuilder.html), you are able to prepare an action call by repeatedly calling it's methods. +Using [method builders](http://byron.github.io/google-apis-rs/google_prediction1d6/trait.CallBuilder.html), 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][wiki-pod] are handed by copy * strings are passed as `&str` -* [request values](http://byron.github.io/google-apis-rs/google-prediction1d6/trait.RequestValue.html) are borrowed +* [request values](http://byron.github.io/google-apis-rs/google_prediction1d6/trait.RequestValue.html) are borrowed Arguments will always be copied or cloned into the builder, to make them independent of their original life times. diff --git a/gen/pubsub1_beta2/README.md b/gen/pubsub1_beta2/README.md index e306fc8175..720ed88be8 100644 --- a/gen/pubsub1_beta2/README.md +++ b/gen/pubsub1_beta2/README.md @@ -8,10 +8,10 @@ The `google-pubsub1_beta2` library allows access to all features of the *Google This documentation was generated from *pubsub* crate version *0.1.5+20150326*, where *20150326* is the exact revision of the *pubsub:v1beta2* schema built by the [mako](http://www.makotemplates.org/) code generator *v0.1.5*. # Features -Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google-pubsub1_beta2/struct.Pubsub.html) ... +Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google_pubsub1_beta2/struct.Pubsub.html) ... * projects - * [*subscriptions acknowledge*](http://byron.github.io/google-apis-rs/google-pubsub1_beta2/struct.ProjectSubscriptionAcknowledgeCall.html), [*subscriptions create*](http://byron.github.io/google-apis-rs/google-pubsub1_beta2/struct.ProjectSubscriptionCreateCall.html), [*subscriptions delete*](http://byron.github.io/google-apis-rs/google-pubsub1_beta2/struct.ProjectSubscriptionDeleteCall.html), [*subscriptions get*](http://byron.github.io/google-apis-rs/google-pubsub1_beta2/struct.ProjectSubscriptionGetCall.html), [*subscriptions list*](http://byron.github.io/google-apis-rs/google-pubsub1_beta2/struct.ProjectSubscriptionListCall.html), [*subscriptions modify ack deadline*](http://byron.github.io/google-apis-rs/google-pubsub1_beta2/struct.ProjectSubscriptionModifyAckDeadlineCall.html), [*subscriptions modify push config*](http://byron.github.io/google-apis-rs/google-pubsub1_beta2/struct.ProjectSubscriptionModifyPushConfigCall.html), [*subscriptions pull*](http://byron.github.io/google-apis-rs/google-pubsub1_beta2/struct.ProjectSubscriptionPullCall.html), [*topics create*](http://byron.github.io/google-apis-rs/google-pubsub1_beta2/struct.ProjectTopicCreateCall.html), [*topics delete*](http://byron.github.io/google-apis-rs/google-pubsub1_beta2/struct.ProjectTopicDeleteCall.html), [*topics get*](http://byron.github.io/google-apis-rs/google-pubsub1_beta2/struct.ProjectTopicGetCall.html), [*topics list*](http://byron.github.io/google-apis-rs/google-pubsub1_beta2/struct.ProjectTopicListCall.html), [*topics publish*](http://byron.github.io/google-apis-rs/google-pubsub1_beta2/struct.ProjectTopicPublishCall.html) and [*topics subscriptions list*](http://byron.github.io/google-apis-rs/google-pubsub1_beta2/struct.ProjectTopicSubscriptionListCall.html) + * [*subscriptions acknowledge*](http://byron.github.io/google-apis-rs/google_pubsub1_beta2/struct.ProjectSubscriptionAcknowledgeCall.html), [*subscriptions create*](http://byron.github.io/google-apis-rs/google_pubsub1_beta2/struct.ProjectSubscriptionCreateCall.html), [*subscriptions delete*](http://byron.github.io/google-apis-rs/google_pubsub1_beta2/struct.ProjectSubscriptionDeleteCall.html), [*subscriptions get*](http://byron.github.io/google-apis-rs/google_pubsub1_beta2/struct.ProjectSubscriptionGetCall.html), [*subscriptions list*](http://byron.github.io/google-apis-rs/google_pubsub1_beta2/struct.ProjectSubscriptionListCall.html), [*subscriptions modify ack deadline*](http://byron.github.io/google-apis-rs/google_pubsub1_beta2/struct.ProjectSubscriptionModifyAckDeadlineCall.html), [*subscriptions modify push config*](http://byron.github.io/google-apis-rs/google_pubsub1_beta2/struct.ProjectSubscriptionModifyPushConfigCall.html), [*subscriptions pull*](http://byron.github.io/google-apis-rs/google_pubsub1_beta2/struct.ProjectSubscriptionPullCall.html), [*topics create*](http://byron.github.io/google-apis-rs/google_pubsub1_beta2/struct.ProjectTopicCreateCall.html), [*topics delete*](http://byron.github.io/google-apis-rs/google_pubsub1_beta2/struct.ProjectTopicDeleteCall.html), [*topics get*](http://byron.github.io/google-apis-rs/google_pubsub1_beta2/struct.ProjectTopicGetCall.html), [*topics list*](http://byron.github.io/google-apis-rs/google_pubsub1_beta2/struct.ProjectTopicListCall.html), [*topics publish*](http://byron.github.io/google-apis-rs/google_pubsub1_beta2/struct.ProjectTopicPublishCall.html) and [*topics subscriptions list*](http://byron.github.io/google-apis-rs/google_pubsub1_beta2/struct.ProjectTopicSubscriptionListCall.html) @@ -20,17 +20,17 @@ Handle the following *Resources* with ease from the central [hub](http://byron.g The API is structured into the following primary items: -* **[Hub](http://byron.github.io/google-apis-rs/google-pubsub1_beta2/struct.Pubsub.html)** +* **[Hub](http://byron.github.io/google-apis-rs/google_pubsub1_beta2/struct.Pubsub.html)** * a central object to maintain state and allow accessing all *Activities* - * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google-pubsub1_beta2/trait.MethodsBuilder.html) which in turn - allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google-pubsub1_beta2/trait.CallBuilder.html) -* **[Resources](http://byron.github.io/google-apis-rs/google-pubsub1_beta2/trait.Resource.html)** + * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google_pubsub1_beta2/trait.MethodsBuilder.html) which in turn + allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google_pubsub1_beta2/trait.CallBuilder.html) +* **[Resources](http://byron.github.io/google-apis-rs/google_pubsub1_beta2/trait.Resource.html)** * primary types that you can apply *Activities* to * a collection of properties and *Parts* - * **[Parts](http://byron.github.io/google-apis-rs/google-pubsub1_beta2/trait.Part.html)** + * **[Parts](http://byron.github.io/google-apis-rs/google_pubsub1_beta2/trait.Part.html)** * a collection of properties * never directly used in *Activities* -* **[Activities](http://byron.github.io/google-apis-rs/google-pubsub1_beta2/trait.CallBuilder.html)** +* **[Activities](http://byron.github.io/google-apis-rs/google_pubsub1_beta2/trait.CallBuilder.html)** * operations to apply to *Resources* All *structures* are marked with applicable traits to further categorize them and ease browsing. @@ -119,17 +119,17 @@ match result { ``` ## Handling Errors -All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google-pubsub1_beta2/enum.Result.html) enumeration as return value of +All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google_pubsub1_beta2/enum.Result.html) enumeration as return value of the doit() methods, or handed as possibly intermediate results to either the -[Hub Delegate](http://byron.github.io/google-apis-rs/google-pubsub1_beta2/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google-pubsub1_beta2/../yup-oauth2/trait.AuthenticatorDelegate.html). +[Hub Delegate](http://byron.github.io/google-apis-rs/google_pubsub1_beta2/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google_pubsub1_beta2/../yup-oauth2/trait.AuthenticatorDelegate.html). 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](http://byron.github.io/google-apis-rs/google-pubsub1_beta2/enum.Result.html), should be +If a method supports downloads, the response body, which is part of the [Result](http://byron.github.io/google-apis-rs/google_pubsub1_beta2/enum.Result.html), should be read by you to obtain the media. -If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google-pubsub1_beta2/trait.ResponseResult.html), it will return that by default. +If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google_pubsub1_beta2/trait.ResponseResult.html), 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")`. @@ -139,29 +139,29 @@ Methods supporting uploads can do so using up to 2 different protocols: ## Customization and Callbacks -You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google-pubsub1_beta2/trait.Delegate.html) to the -[Method Builder](http://byron.github.io/google-apis-rs/google-pubsub1_beta2/trait.CallBuilder.html) before making the final `doit()` call. +You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google_pubsub1_beta2/trait.Delegate.html) to the +[Method Builder](http://byron.github.io/google-apis-rs/google_pubsub1_beta2/trait.CallBuilder.html) 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](http://byron.github.io/google-apis-rs/google-pubsub1_beta2/trait.Delegate.html) is default-implemented, allowing you to customize it with minimal effort. +The [delegate trait](http://byron.github.io/google-apis-rs/google_pubsub1_beta2/trait.Delegate.html) 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](http://byron.github.io/google-apis-rs/google-pubsub1_beta2/trait.RequestValue.html) and -[decodable](http://byron.github.io/google-apis-rs/google-pubsub1_beta2/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses +All structures provided by this library are made to be [enocodable](http://byron.github.io/google-apis-rs/google_pubsub1_beta2/trait.RequestValue.html) and +[decodable](http://byron.github.io/google-apis-rs/google_pubsub1_beta2/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses are valid. -Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google-pubsub1_beta2/trait.Part.html) which are identifiable by name, which will be sent to +Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google_pubsub1_beta2/trait.Part.html) 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](http://byron.github.io/google-apis-rs/google-pubsub1_beta2/trait.CallBuilder.html), you are able to prepare an action call by repeatedly calling it's methods. +Using [method builders](http://byron.github.io/google-apis-rs/google_pubsub1_beta2/trait.CallBuilder.html), 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][wiki-pod] are handed by copy * strings are passed as `&str` -* [request values](http://byron.github.io/google-apis-rs/google-pubsub1_beta2/trait.RequestValue.html) are borrowed +* [request values](http://byron.github.io/google-apis-rs/google_pubsub1_beta2/trait.RequestValue.html) are borrowed Arguments will always be copied or cloned into the builder, to make them independent of their original life times. diff --git a/gen/qpxexpress1/README.md b/gen/qpxexpress1/README.md index d796918cb3..006072e18f 100644 --- a/gen/qpxexpress1/README.md +++ b/gen/qpxexpress1/README.md @@ -11,10 +11,10 @@ Everything else about the *QPX Express* *v1* API can be found at the [official documentation site](http://developers.google.com/qpx-express). # Features -Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google-qpxexpress1/struct.QPXExpress.html) ... +Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google_qpxexpress1/struct.QPXExpress.html) ... * trips - * [*search*](http://byron.github.io/google-apis-rs/google-qpxexpress1/struct.TripSearchCall.html) + * [*search*](http://byron.github.io/google-apis-rs/google_qpxexpress1/struct.TripSearchCall.html) @@ -23,17 +23,17 @@ Handle the following *Resources* with ease from the central [hub](http://byron.g The API is structured into the following primary items: -* **[Hub](http://byron.github.io/google-apis-rs/google-qpxexpress1/struct.QPXExpress.html)** +* **[Hub](http://byron.github.io/google-apis-rs/google_qpxexpress1/struct.QPXExpress.html)** * a central object to maintain state and allow accessing all *Activities* - * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google-qpxexpress1/trait.MethodsBuilder.html) which in turn - allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google-qpxexpress1/trait.CallBuilder.html) -* **[Resources](http://byron.github.io/google-apis-rs/google-qpxexpress1/trait.Resource.html)** + * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google_qpxexpress1/trait.MethodsBuilder.html) which in turn + allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google_qpxexpress1/trait.CallBuilder.html) +* **[Resources](http://byron.github.io/google-apis-rs/google_qpxexpress1/trait.Resource.html)** * primary types that you can apply *Activities* to * a collection of properties and *Parts* - * **[Parts](http://byron.github.io/google-apis-rs/google-qpxexpress1/trait.Part.html)** + * **[Parts](http://byron.github.io/google-apis-rs/google_qpxexpress1/trait.Part.html)** * a collection of properties * never directly used in *Activities* -* **[Activities](http://byron.github.io/google-apis-rs/google-qpxexpress1/trait.CallBuilder.html)** +* **[Activities](http://byron.github.io/google-apis-rs/google_qpxexpress1/trait.CallBuilder.html)** * operations to apply to *Resources* All *structures* are marked with applicable traits to further categorize them and ease browsing. @@ -118,17 +118,17 @@ match result { ``` ## Handling Errors -All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google-qpxexpress1/enum.Result.html) enumeration as return value of +All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google_qpxexpress1/enum.Result.html) enumeration as return value of the doit() methods, or handed as possibly intermediate results to either the -[Hub Delegate](http://byron.github.io/google-apis-rs/google-qpxexpress1/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google-qpxexpress1/../yup-oauth2/trait.AuthenticatorDelegate.html). +[Hub Delegate](http://byron.github.io/google-apis-rs/google_qpxexpress1/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google_qpxexpress1/../yup-oauth2/trait.AuthenticatorDelegate.html). 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](http://byron.github.io/google-apis-rs/google-qpxexpress1/enum.Result.html), should be +If a method supports downloads, the response body, which is part of the [Result](http://byron.github.io/google-apis-rs/google_qpxexpress1/enum.Result.html), should be read by you to obtain the media. -If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google-qpxexpress1/trait.ResponseResult.html), it will return that by default. +If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google_qpxexpress1/trait.ResponseResult.html), 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")`. @@ -138,29 +138,29 @@ Methods supporting uploads can do so using up to 2 different protocols: ## Customization and Callbacks -You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google-qpxexpress1/trait.Delegate.html) to the -[Method Builder](http://byron.github.io/google-apis-rs/google-qpxexpress1/trait.CallBuilder.html) before making the final `doit()` call. +You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google_qpxexpress1/trait.Delegate.html) to the +[Method Builder](http://byron.github.io/google-apis-rs/google_qpxexpress1/trait.CallBuilder.html) 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](http://byron.github.io/google-apis-rs/google-qpxexpress1/trait.Delegate.html) is default-implemented, allowing you to customize it with minimal effort. +The [delegate trait](http://byron.github.io/google-apis-rs/google_qpxexpress1/trait.Delegate.html) 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](http://byron.github.io/google-apis-rs/google-qpxexpress1/trait.RequestValue.html) and -[decodable](http://byron.github.io/google-apis-rs/google-qpxexpress1/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses +All structures provided by this library are made to be [enocodable](http://byron.github.io/google-apis-rs/google_qpxexpress1/trait.RequestValue.html) and +[decodable](http://byron.github.io/google-apis-rs/google_qpxexpress1/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses are valid. -Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google-qpxexpress1/trait.Part.html) which are identifiable by name, which will be sent to +Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google_qpxexpress1/trait.Part.html) 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](http://byron.github.io/google-apis-rs/google-qpxexpress1/trait.CallBuilder.html), you are able to prepare an action call by repeatedly calling it's methods. +Using [method builders](http://byron.github.io/google-apis-rs/google_qpxexpress1/trait.CallBuilder.html), 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][wiki-pod] are handed by copy * strings are passed as `&str` -* [request values](http://byron.github.io/google-apis-rs/google-qpxexpress1/trait.RequestValue.html) are borrowed +* [request values](http://byron.github.io/google-apis-rs/google_qpxexpress1/trait.RequestValue.html) are borrowed Arguments will always be copied or cloned into the builder, to make them independent of their original life times. diff --git a/gen/replicapool1_beta2/README.md b/gen/replicapool1_beta2/README.md index 53a9c726ba..67b949c0d3 100644 --- a/gen/replicapool1_beta2/README.md +++ b/gen/replicapool1_beta2/README.md @@ -11,12 +11,12 @@ Everything else about the *replicapool* *v1_beta2* API can be found at the [official documentation site](https://developers.google.com/compute/docs/instance-groups/manager/v1beta2). # Features -Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google-replicapool1_beta2/struct.Replicapool.html) ... +Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google_replicapool1_beta2/struct.Replicapool.html) ... -* [instance group managers](http://byron.github.io/google-apis-rs/google-replicapool1_beta2/struct.InstanceGroupManager.html) - * [*abandon instances*](http://byron.github.io/google-apis-rs/google-replicapool1_beta2/struct.InstanceGroupManagerAbandonInstanceCall.html), [*delete*](http://byron.github.io/google-apis-rs/google-replicapool1_beta2/struct.InstanceGroupManagerDeleteCall.html), [*delete instances*](http://byron.github.io/google-apis-rs/google-replicapool1_beta2/struct.InstanceGroupManagerDeleteInstanceCall.html), [*get*](http://byron.github.io/google-apis-rs/google-replicapool1_beta2/struct.InstanceGroupManagerGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google-replicapool1_beta2/struct.InstanceGroupManagerInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google-replicapool1_beta2/struct.InstanceGroupManagerListCall.html), [*recreate instances*](http://byron.github.io/google-apis-rs/google-replicapool1_beta2/struct.InstanceGroupManagerRecreateInstanceCall.html), [*resize*](http://byron.github.io/google-apis-rs/google-replicapool1_beta2/struct.InstanceGroupManagerResizeCall.html), [*set instance template*](http://byron.github.io/google-apis-rs/google-replicapool1_beta2/struct.InstanceGroupManagerSetInstanceTemplateCall.html) and [*set target pools*](http://byron.github.io/google-apis-rs/google-replicapool1_beta2/struct.InstanceGroupManagerSetTargetPoolCall.html) +* [instance group managers](http://byron.github.io/google-apis-rs/google_replicapool1_beta2/struct.InstanceGroupManager.html) + * [*abandon instances*](http://byron.github.io/google-apis-rs/google_replicapool1_beta2/struct.InstanceGroupManagerAbandonInstanceCall.html), [*delete*](http://byron.github.io/google-apis-rs/google_replicapool1_beta2/struct.InstanceGroupManagerDeleteCall.html), [*delete instances*](http://byron.github.io/google-apis-rs/google_replicapool1_beta2/struct.InstanceGroupManagerDeleteInstanceCall.html), [*get*](http://byron.github.io/google-apis-rs/google_replicapool1_beta2/struct.InstanceGroupManagerGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google_replicapool1_beta2/struct.InstanceGroupManagerInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google_replicapool1_beta2/struct.InstanceGroupManagerListCall.html), [*recreate instances*](http://byron.github.io/google-apis-rs/google_replicapool1_beta2/struct.InstanceGroupManagerRecreateInstanceCall.html), [*resize*](http://byron.github.io/google-apis-rs/google_replicapool1_beta2/struct.InstanceGroupManagerResizeCall.html), [*set instance template*](http://byron.github.io/google-apis-rs/google_replicapool1_beta2/struct.InstanceGroupManagerSetInstanceTemplateCall.html) and [*set target pools*](http://byron.github.io/google-apis-rs/google_replicapool1_beta2/struct.InstanceGroupManagerSetTargetPoolCall.html) * zone operations - * [*get*](http://byron.github.io/google-apis-rs/google-replicapool1_beta2/struct.ZoneOperationGetCall.html) and [*list*](http://byron.github.io/google-apis-rs/google-replicapool1_beta2/struct.ZoneOperationListCall.html) + * [*get*](http://byron.github.io/google-apis-rs/google_replicapool1_beta2/struct.ZoneOperationGetCall.html) and [*list*](http://byron.github.io/google-apis-rs/google_replicapool1_beta2/struct.ZoneOperationListCall.html) @@ -25,17 +25,17 @@ Handle the following *Resources* with ease from the central [hub](http://byron.g The API is structured into the following primary items: -* **[Hub](http://byron.github.io/google-apis-rs/google-replicapool1_beta2/struct.Replicapool.html)** +* **[Hub](http://byron.github.io/google-apis-rs/google_replicapool1_beta2/struct.Replicapool.html)** * a central object to maintain state and allow accessing all *Activities* - * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google-replicapool1_beta2/trait.MethodsBuilder.html) which in turn - allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google-replicapool1_beta2/trait.CallBuilder.html) -* **[Resources](http://byron.github.io/google-apis-rs/google-replicapool1_beta2/trait.Resource.html)** + * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google_replicapool1_beta2/trait.MethodsBuilder.html) which in turn + allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google_replicapool1_beta2/trait.CallBuilder.html) +* **[Resources](http://byron.github.io/google-apis-rs/google_replicapool1_beta2/trait.Resource.html)** * primary types that you can apply *Activities* to * a collection of properties and *Parts* - * **[Parts](http://byron.github.io/google-apis-rs/google-replicapool1_beta2/trait.Part.html)** + * **[Parts](http://byron.github.io/google-apis-rs/google_replicapool1_beta2/trait.Part.html)** * a collection of properties * never directly used in *Activities* -* **[Activities](http://byron.github.io/google-apis-rs/google-replicapool1_beta2/trait.CallBuilder.html)** +* **[Activities](http://byron.github.io/google-apis-rs/google_replicapool1_beta2/trait.CallBuilder.html)** * operations to apply to *Resources* All *structures* are marked with applicable traits to further categorize them and ease browsing. @@ -126,17 +126,17 @@ match result { ``` ## Handling Errors -All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google-replicapool1_beta2/enum.Result.html) enumeration as return value of +All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google_replicapool1_beta2/enum.Result.html) enumeration as return value of the doit() methods, or handed as possibly intermediate results to either the -[Hub Delegate](http://byron.github.io/google-apis-rs/google-replicapool1_beta2/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google-replicapool1_beta2/../yup-oauth2/trait.AuthenticatorDelegate.html). +[Hub Delegate](http://byron.github.io/google-apis-rs/google_replicapool1_beta2/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google_replicapool1_beta2/../yup-oauth2/trait.AuthenticatorDelegate.html). 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](http://byron.github.io/google-apis-rs/google-replicapool1_beta2/enum.Result.html), should be +If a method supports downloads, the response body, which is part of the [Result](http://byron.github.io/google-apis-rs/google_replicapool1_beta2/enum.Result.html), should be read by you to obtain the media. -If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google-replicapool1_beta2/trait.ResponseResult.html), it will return that by default. +If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google_replicapool1_beta2/trait.ResponseResult.html), 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")`. @@ -146,29 +146,29 @@ Methods supporting uploads can do so using up to 2 different protocols: ## Customization and Callbacks -You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google-replicapool1_beta2/trait.Delegate.html) to the -[Method Builder](http://byron.github.io/google-apis-rs/google-replicapool1_beta2/trait.CallBuilder.html) before making the final `doit()` call. +You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google_replicapool1_beta2/trait.Delegate.html) to the +[Method Builder](http://byron.github.io/google-apis-rs/google_replicapool1_beta2/trait.CallBuilder.html) 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](http://byron.github.io/google-apis-rs/google-replicapool1_beta2/trait.Delegate.html) is default-implemented, allowing you to customize it with minimal effort. +The [delegate trait](http://byron.github.io/google-apis-rs/google_replicapool1_beta2/trait.Delegate.html) 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](http://byron.github.io/google-apis-rs/google-replicapool1_beta2/trait.RequestValue.html) and -[decodable](http://byron.github.io/google-apis-rs/google-replicapool1_beta2/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses +All structures provided by this library are made to be [enocodable](http://byron.github.io/google-apis-rs/google_replicapool1_beta2/trait.RequestValue.html) and +[decodable](http://byron.github.io/google-apis-rs/google_replicapool1_beta2/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses are valid. -Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google-replicapool1_beta2/trait.Part.html) which are identifiable by name, which will be sent to +Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google_replicapool1_beta2/trait.Part.html) 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](http://byron.github.io/google-apis-rs/google-replicapool1_beta2/trait.CallBuilder.html), you are able to prepare an action call by repeatedly calling it's methods. +Using [method builders](http://byron.github.io/google-apis-rs/google_replicapool1_beta2/trait.CallBuilder.html), 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][wiki-pod] are handed by copy * strings are passed as `&str` -* [request values](http://byron.github.io/google-apis-rs/google-replicapool1_beta2/trait.RequestValue.html) are borrowed +* [request values](http://byron.github.io/google-apis-rs/google_replicapool1_beta2/trait.RequestValue.html) are borrowed Arguments will always be copied or cloned into the builder, to make them independent of their original life times. diff --git a/gen/replicapoolupdater1_beta1/README.md b/gen/replicapoolupdater1_beta1/README.md index c8c08e03cc..f131dbe43d 100644 --- a/gen/replicapoolupdater1_beta1/README.md +++ b/gen/replicapoolupdater1_beta1/README.md @@ -11,12 +11,12 @@ Everything else about the *replicapoolupdater* *v1_beta1* API can be found at th [official documentation site](https://cloud.google.com/compute/docs/instance-groups/manager/#applying_rolling_updates_using_the_updater_service). # Features -Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google-replicapoolupdater1_beta1/struct.Replicapoolupdater.html) ... +Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google_replicapoolupdater1_beta1/struct.Replicapoolupdater.html) ... -* [rolling updates](http://byron.github.io/google-apis-rs/google-replicapoolupdater1_beta1/struct.RollingUpdate.html) - * [*cancel*](http://byron.github.io/google-apis-rs/google-replicapoolupdater1_beta1/struct.RollingUpdateCancelCall.html), [*get*](http://byron.github.io/google-apis-rs/google-replicapoolupdater1_beta1/struct.RollingUpdateGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google-replicapoolupdater1_beta1/struct.RollingUpdateInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google-replicapoolupdater1_beta1/struct.RollingUpdateListCall.html), [*list instance updates*](http://byron.github.io/google-apis-rs/google-replicapoolupdater1_beta1/struct.RollingUpdateListInstanceUpdateCall.html), [*pause*](http://byron.github.io/google-apis-rs/google-replicapoolupdater1_beta1/struct.RollingUpdatePauseCall.html), [*resume*](http://byron.github.io/google-apis-rs/google-replicapoolupdater1_beta1/struct.RollingUpdateResumeCall.html) and [*rollback*](http://byron.github.io/google-apis-rs/google-replicapoolupdater1_beta1/struct.RollingUpdateRollbackCall.html) +* [rolling updates](http://byron.github.io/google-apis-rs/google_replicapoolupdater1_beta1/struct.RollingUpdate.html) + * [*cancel*](http://byron.github.io/google-apis-rs/google_replicapoolupdater1_beta1/struct.RollingUpdateCancelCall.html), [*get*](http://byron.github.io/google-apis-rs/google_replicapoolupdater1_beta1/struct.RollingUpdateGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google_replicapoolupdater1_beta1/struct.RollingUpdateInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google_replicapoolupdater1_beta1/struct.RollingUpdateListCall.html), [*list instance updates*](http://byron.github.io/google-apis-rs/google_replicapoolupdater1_beta1/struct.RollingUpdateListInstanceUpdateCall.html), [*pause*](http://byron.github.io/google-apis-rs/google_replicapoolupdater1_beta1/struct.RollingUpdatePauseCall.html), [*resume*](http://byron.github.io/google-apis-rs/google_replicapoolupdater1_beta1/struct.RollingUpdateResumeCall.html) and [*rollback*](http://byron.github.io/google-apis-rs/google_replicapoolupdater1_beta1/struct.RollingUpdateRollbackCall.html) * zone operations - * [*get*](http://byron.github.io/google-apis-rs/google-replicapoolupdater1_beta1/struct.ZoneOperationGetCall.html) + * [*get*](http://byron.github.io/google-apis-rs/google_replicapoolupdater1_beta1/struct.ZoneOperationGetCall.html) @@ -25,17 +25,17 @@ Handle the following *Resources* with ease from the central [hub](http://byron.g The API is structured into the following primary items: -* **[Hub](http://byron.github.io/google-apis-rs/google-replicapoolupdater1_beta1/struct.Replicapoolupdater.html)** +* **[Hub](http://byron.github.io/google-apis-rs/google_replicapoolupdater1_beta1/struct.Replicapoolupdater.html)** * a central object to maintain state and allow accessing all *Activities* - * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google-replicapoolupdater1_beta1/trait.MethodsBuilder.html) which in turn - allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google-replicapoolupdater1_beta1/trait.CallBuilder.html) -* **[Resources](http://byron.github.io/google-apis-rs/google-replicapoolupdater1_beta1/trait.Resource.html)** + * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google_replicapoolupdater1_beta1/trait.MethodsBuilder.html) which in turn + allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google_replicapoolupdater1_beta1/trait.CallBuilder.html) +* **[Resources](http://byron.github.io/google-apis-rs/google_replicapoolupdater1_beta1/trait.Resource.html)** * primary types that you can apply *Activities* to * a collection of properties and *Parts* - * **[Parts](http://byron.github.io/google-apis-rs/google-replicapoolupdater1_beta1/trait.Part.html)** + * **[Parts](http://byron.github.io/google-apis-rs/google_replicapoolupdater1_beta1/trait.Part.html)** * a collection of properties * never directly used in *Activities* -* **[Activities](http://byron.github.io/google-apis-rs/google-replicapoolupdater1_beta1/trait.CallBuilder.html)** +* **[Activities](http://byron.github.io/google-apis-rs/google_replicapoolupdater1_beta1/trait.CallBuilder.html)** * operations to apply to *Resources* All *structures* are marked with applicable traits to further categorize them and ease browsing. @@ -125,17 +125,17 @@ match result { ``` ## Handling Errors -All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google-replicapoolupdater1_beta1/enum.Result.html) enumeration as return value of +All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google_replicapoolupdater1_beta1/enum.Result.html) enumeration as return value of the doit() methods, or handed as possibly intermediate results to either the -[Hub Delegate](http://byron.github.io/google-apis-rs/google-replicapoolupdater1_beta1/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google-replicapoolupdater1_beta1/../yup-oauth2/trait.AuthenticatorDelegate.html). +[Hub Delegate](http://byron.github.io/google-apis-rs/google_replicapoolupdater1_beta1/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google_replicapoolupdater1_beta1/../yup-oauth2/trait.AuthenticatorDelegate.html). 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](http://byron.github.io/google-apis-rs/google-replicapoolupdater1_beta1/enum.Result.html), should be +If a method supports downloads, the response body, which is part of the [Result](http://byron.github.io/google-apis-rs/google_replicapoolupdater1_beta1/enum.Result.html), should be read by you to obtain the media. -If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google-replicapoolupdater1_beta1/trait.ResponseResult.html), it will return that by default. +If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google_replicapoolupdater1_beta1/trait.ResponseResult.html), 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")`. @@ -145,29 +145,29 @@ Methods supporting uploads can do so using up to 2 different protocols: ## Customization and Callbacks -You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google-replicapoolupdater1_beta1/trait.Delegate.html) to the -[Method Builder](http://byron.github.io/google-apis-rs/google-replicapoolupdater1_beta1/trait.CallBuilder.html) before making the final `doit()` call. +You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google_replicapoolupdater1_beta1/trait.Delegate.html) to the +[Method Builder](http://byron.github.io/google-apis-rs/google_replicapoolupdater1_beta1/trait.CallBuilder.html) 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](http://byron.github.io/google-apis-rs/google-replicapoolupdater1_beta1/trait.Delegate.html) is default-implemented, allowing you to customize it with minimal effort. +The [delegate trait](http://byron.github.io/google-apis-rs/google_replicapoolupdater1_beta1/trait.Delegate.html) 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](http://byron.github.io/google-apis-rs/google-replicapoolupdater1_beta1/trait.RequestValue.html) and -[decodable](http://byron.github.io/google-apis-rs/google-replicapoolupdater1_beta1/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses +All structures provided by this library are made to be [enocodable](http://byron.github.io/google-apis-rs/google_replicapoolupdater1_beta1/trait.RequestValue.html) and +[decodable](http://byron.github.io/google-apis-rs/google_replicapoolupdater1_beta1/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses are valid. -Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google-replicapoolupdater1_beta1/trait.Part.html) which are identifiable by name, which will be sent to +Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google_replicapoolupdater1_beta1/trait.Part.html) 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](http://byron.github.io/google-apis-rs/google-replicapoolupdater1_beta1/trait.CallBuilder.html), you are able to prepare an action call by repeatedly calling it's methods. +Using [method builders](http://byron.github.io/google-apis-rs/google_replicapoolupdater1_beta1/trait.CallBuilder.html), 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][wiki-pod] are handed by copy * strings are passed as `&str` -* [request values](http://byron.github.io/google-apis-rs/google-replicapoolupdater1_beta1/trait.RequestValue.html) are borrowed +* [request values](http://byron.github.io/google-apis-rs/google_replicapoolupdater1_beta1/trait.RequestValue.html) are borrowed Arguments will always be copied or cloned into the builder, to make them independent of their original life times. diff --git a/gen/reseller1_sandbox/README.md b/gen/reseller1_sandbox/README.md index a93d3962c1..0b8a55f955 100644 --- a/gen/reseller1_sandbox/README.md +++ b/gen/reseller1_sandbox/README.md @@ -11,12 +11,12 @@ Everything else about the *reseller* *v1_sandbox* API can be found at the [official documentation site](https://developers.google.com/google-apps/reseller/). # Features -Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google-reseller1_sandbox/struct.Reseller.html) ... +Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google_reseller1_sandbox/struct.Reseller.html) ... -* [customers](http://byron.github.io/google-apis-rs/google-reseller1_sandbox/struct.Customer.html) - * [*get*](http://byron.github.io/google-apis-rs/google-reseller1_sandbox/struct.CustomerGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google-reseller1_sandbox/struct.CustomerInsertCall.html), [*patch*](http://byron.github.io/google-apis-rs/google-reseller1_sandbox/struct.CustomerPatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google-reseller1_sandbox/struct.CustomerUpdateCall.html) -* [subscriptions](http://byron.github.io/google-apis-rs/google-reseller1_sandbox/struct.Subscription.html) - * [*activate*](http://byron.github.io/google-apis-rs/google-reseller1_sandbox/struct.SubscriptionActivateCall.html), [*change plan*](http://byron.github.io/google-apis-rs/google-reseller1_sandbox/struct.SubscriptionChangePlanCall.html), [*change renewal settings*](http://byron.github.io/google-apis-rs/google-reseller1_sandbox/struct.SubscriptionChangeRenewalSettingCall.html), [*change seats*](http://byron.github.io/google-apis-rs/google-reseller1_sandbox/struct.SubscriptionChangeSeatCall.html), [*delete*](http://byron.github.io/google-apis-rs/google-reseller1_sandbox/struct.SubscriptionDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google-reseller1_sandbox/struct.SubscriptionGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google-reseller1_sandbox/struct.SubscriptionInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google-reseller1_sandbox/struct.SubscriptionListCall.html), [*start paid service*](http://byron.github.io/google-apis-rs/google-reseller1_sandbox/struct.SubscriptionStartPaidServiceCall.html) and [*suspend*](http://byron.github.io/google-apis-rs/google-reseller1_sandbox/struct.SubscriptionSuspendCall.html) +* [customers](http://byron.github.io/google-apis-rs/google_reseller1_sandbox/struct.Customer.html) + * [*get*](http://byron.github.io/google-apis-rs/google_reseller1_sandbox/struct.CustomerGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google_reseller1_sandbox/struct.CustomerInsertCall.html), [*patch*](http://byron.github.io/google-apis-rs/google_reseller1_sandbox/struct.CustomerPatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google_reseller1_sandbox/struct.CustomerUpdateCall.html) +* [subscriptions](http://byron.github.io/google-apis-rs/google_reseller1_sandbox/struct.Subscription.html) + * [*activate*](http://byron.github.io/google-apis-rs/google_reseller1_sandbox/struct.SubscriptionActivateCall.html), [*change plan*](http://byron.github.io/google-apis-rs/google_reseller1_sandbox/struct.SubscriptionChangePlanCall.html), [*change renewal settings*](http://byron.github.io/google-apis-rs/google_reseller1_sandbox/struct.SubscriptionChangeRenewalSettingCall.html), [*change seats*](http://byron.github.io/google-apis-rs/google_reseller1_sandbox/struct.SubscriptionChangeSeatCall.html), [*delete*](http://byron.github.io/google-apis-rs/google_reseller1_sandbox/struct.SubscriptionDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google_reseller1_sandbox/struct.SubscriptionGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google_reseller1_sandbox/struct.SubscriptionInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google_reseller1_sandbox/struct.SubscriptionListCall.html), [*start paid service*](http://byron.github.io/google-apis-rs/google_reseller1_sandbox/struct.SubscriptionStartPaidServiceCall.html) and [*suspend*](http://byron.github.io/google-apis-rs/google_reseller1_sandbox/struct.SubscriptionSuspendCall.html) @@ -25,17 +25,17 @@ Handle the following *Resources* with ease from the central [hub](http://byron.g The API is structured into the following primary items: -* **[Hub](http://byron.github.io/google-apis-rs/google-reseller1_sandbox/struct.Reseller.html)** +* **[Hub](http://byron.github.io/google-apis-rs/google_reseller1_sandbox/struct.Reseller.html)** * a central object to maintain state and allow accessing all *Activities* - * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google-reseller1_sandbox/trait.MethodsBuilder.html) which in turn - allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google-reseller1_sandbox/trait.CallBuilder.html) -* **[Resources](http://byron.github.io/google-apis-rs/google-reseller1_sandbox/trait.Resource.html)** + * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google_reseller1_sandbox/trait.MethodsBuilder.html) which in turn + allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google_reseller1_sandbox/trait.CallBuilder.html) +* **[Resources](http://byron.github.io/google-apis-rs/google_reseller1_sandbox/trait.Resource.html)** * primary types that you can apply *Activities* to * a collection of properties and *Parts* - * **[Parts](http://byron.github.io/google-apis-rs/google-reseller1_sandbox/trait.Part.html)** + * **[Parts](http://byron.github.io/google-apis-rs/google_reseller1_sandbox/trait.Part.html)** * a collection of properties * never directly used in *Activities* -* **[Activities](http://byron.github.io/google-apis-rs/google-reseller1_sandbox/trait.CallBuilder.html)** +* **[Activities](http://byron.github.io/google-apis-rs/google_reseller1_sandbox/trait.CallBuilder.html)** * operations to apply to *Resources* All *structures* are marked with applicable traits to further categorize them and ease browsing. @@ -128,17 +128,17 @@ match result { ``` ## Handling Errors -All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google-reseller1_sandbox/enum.Result.html) enumeration as return value of +All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google_reseller1_sandbox/enum.Result.html) enumeration as return value of the doit() methods, or handed as possibly intermediate results to either the -[Hub Delegate](http://byron.github.io/google-apis-rs/google-reseller1_sandbox/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google-reseller1_sandbox/../yup-oauth2/trait.AuthenticatorDelegate.html). +[Hub Delegate](http://byron.github.io/google-apis-rs/google_reseller1_sandbox/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google_reseller1_sandbox/../yup-oauth2/trait.AuthenticatorDelegate.html). 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](http://byron.github.io/google-apis-rs/google-reseller1_sandbox/enum.Result.html), should be +If a method supports downloads, the response body, which is part of the [Result](http://byron.github.io/google-apis-rs/google_reseller1_sandbox/enum.Result.html), should be read by you to obtain the media. -If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google-reseller1_sandbox/trait.ResponseResult.html), it will return that by default. +If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google_reseller1_sandbox/trait.ResponseResult.html), 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")`. @@ -148,29 +148,29 @@ Methods supporting uploads can do so using up to 2 different protocols: ## Customization and Callbacks -You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google-reseller1_sandbox/trait.Delegate.html) to the -[Method Builder](http://byron.github.io/google-apis-rs/google-reseller1_sandbox/trait.CallBuilder.html) before making the final `doit()` call. +You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google_reseller1_sandbox/trait.Delegate.html) to the +[Method Builder](http://byron.github.io/google-apis-rs/google_reseller1_sandbox/trait.CallBuilder.html) 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](http://byron.github.io/google-apis-rs/google-reseller1_sandbox/trait.Delegate.html) is default-implemented, allowing you to customize it with minimal effort. +The [delegate trait](http://byron.github.io/google-apis-rs/google_reseller1_sandbox/trait.Delegate.html) 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](http://byron.github.io/google-apis-rs/google-reseller1_sandbox/trait.RequestValue.html) and -[decodable](http://byron.github.io/google-apis-rs/google-reseller1_sandbox/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses +All structures provided by this library are made to be [enocodable](http://byron.github.io/google-apis-rs/google_reseller1_sandbox/trait.RequestValue.html) and +[decodable](http://byron.github.io/google-apis-rs/google_reseller1_sandbox/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses are valid. -Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google-reseller1_sandbox/trait.Part.html) which are identifiable by name, which will be sent to +Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google_reseller1_sandbox/trait.Part.html) 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](http://byron.github.io/google-apis-rs/google-reseller1_sandbox/trait.CallBuilder.html), you are able to prepare an action call by repeatedly calling it's methods. +Using [method builders](http://byron.github.io/google-apis-rs/google_reseller1_sandbox/trait.CallBuilder.html), 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][wiki-pod] are handed by copy * strings are passed as `&str` -* [request values](http://byron.github.io/google-apis-rs/google-reseller1_sandbox/trait.RequestValue.html) are borrowed +* [request values](http://byron.github.io/google-apis-rs/google_reseller1_sandbox/trait.RequestValue.html) are borrowed Arguments will always be copied or cloned into the builder, to make them independent of their original life times. diff --git a/gen/resourceviews1_beta2/README.md b/gen/resourceviews1_beta2/README.md index f95a387f5f..715afed397 100644 --- a/gen/resourceviews1_beta2/README.md +++ b/gen/resourceviews1_beta2/README.md @@ -11,12 +11,12 @@ Everything else about the *resourceviews* *v1_beta2* API can be found at the [official documentation site](https://developers.google.com/compute/). # Features -Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google-resourceviews1_beta2/struct.Resourceviews.html) ... +Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google_resourceviews1_beta2/struct.Resourceviews.html) ... * zone operations - * [*get*](http://byron.github.io/google-apis-rs/google-resourceviews1_beta2/struct.ZoneOperationGetCall.html) and [*list*](http://byron.github.io/google-apis-rs/google-resourceviews1_beta2/struct.ZoneOperationListCall.html) + * [*get*](http://byron.github.io/google-apis-rs/google_resourceviews1_beta2/struct.ZoneOperationGetCall.html) and [*list*](http://byron.github.io/google-apis-rs/google_resourceviews1_beta2/struct.ZoneOperationListCall.html) * zone views - * [*add resources*](http://byron.github.io/google-apis-rs/google-resourceviews1_beta2/struct.ZoneViewAddResourceCall.html), [*delete*](http://byron.github.io/google-apis-rs/google-resourceviews1_beta2/struct.ZoneViewDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google-resourceviews1_beta2/struct.ZoneViewGetCall.html), [*get service*](http://byron.github.io/google-apis-rs/google-resourceviews1_beta2/struct.ZoneViewGetServiceCall.html), [*insert*](http://byron.github.io/google-apis-rs/google-resourceviews1_beta2/struct.ZoneViewInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google-resourceviews1_beta2/struct.ZoneViewListCall.html), [*list resources*](http://byron.github.io/google-apis-rs/google-resourceviews1_beta2/struct.ZoneViewListResourceCall.html), [*remove resources*](http://byron.github.io/google-apis-rs/google-resourceviews1_beta2/struct.ZoneViewRemoveResourceCall.html) and [*set service*](http://byron.github.io/google-apis-rs/google-resourceviews1_beta2/struct.ZoneViewSetServiceCall.html) + * [*add resources*](http://byron.github.io/google-apis-rs/google_resourceviews1_beta2/struct.ZoneViewAddResourceCall.html), [*delete*](http://byron.github.io/google-apis-rs/google_resourceviews1_beta2/struct.ZoneViewDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google_resourceviews1_beta2/struct.ZoneViewGetCall.html), [*get service*](http://byron.github.io/google-apis-rs/google_resourceviews1_beta2/struct.ZoneViewGetServiceCall.html), [*insert*](http://byron.github.io/google-apis-rs/google_resourceviews1_beta2/struct.ZoneViewInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google_resourceviews1_beta2/struct.ZoneViewListCall.html), [*list resources*](http://byron.github.io/google-apis-rs/google_resourceviews1_beta2/struct.ZoneViewListResourceCall.html), [*remove resources*](http://byron.github.io/google-apis-rs/google_resourceviews1_beta2/struct.ZoneViewRemoveResourceCall.html) and [*set service*](http://byron.github.io/google-apis-rs/google_resourceviews1_beta2/struct.ZoneViewSetServiceCall.html) @@ -25,17 +25,17 @@ Handle the following *Resources* with ease from the central [hub](http://byron.g The API is structured into the following primary items: -* **[Hub](http://byron.github.io/google-apis-rs/google-resourceviews1_beta2/struct.Resourceviews.html)** +* **[Hub](http://byron.github.io/google-apis-rs/google_resourceviews1_beta2/struct.Resourceviews.html)** * a central object to maintain state and allow accessing all *Activities* - * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google-resourceviews1_beta2/trait.MethodsBuilder.html) which in turn - allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google-resourceviews1_beta2/trait.CallBuilder.html) -* **[Resources](http://byron.github.io/google-apis-rs/google-resourceviews1_beta2/trait.Resource.html)** + * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google_resourceviews1_beta2/trait.MethodsBuilder.html) which in turn + allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google_resourceviews1_beta2/trait.CallBuilder.html) +* **[Resources](http://byron.github.io/google-apis-rs/google_resourceviews1_beta2/trait.Resource.html)** * primary types that you can apply *Activities* to * a collection of properties and *Parts* - * **[Parts](http://byron.github.io/google-apis-rs/google-resourceviews1_beta2/trait.Part.html)** + * **[Parts](http://byron.github.io/google-apis-rs/google_resourceviews1_beta2/trait.Part.html)** * a collection of properties * never directly used in *Activities* -* **[Activities](http://byron.github.io/google-apis-rs/google-resourceviews1_beta2/trait.CallBuilder.html)** +* **[Activities](http://byron.github.io/google-apis-rs/google_resourceviews1_beta2/trait.CallBuilder.html)** * operations to apply to *Resources* All *structures* are marked with applicable traits to further categorize them and ease browsing. @@ -125,17 +125,17 @@ match result { ``` ## Handling Errors -All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google-resourceviews1_beta2/enum.Result.html) enumeration as return value of +All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google_resourceviews1_beta2/enum.Result.html) enumeration as return value of the doit() methods, or handed as possibly intermediate results to either the -[Hub Delegate](http://byron.github.io/google-apis-rs/google-resourceviews1_beta2/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google-resourceviews1_beta2/../yup-oauth2/trait.AuthenticatorDelegate.html). +[Hub Delegate](http://byron.github.io/google-apis-rs/google_resourceviews1_beta2/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google_resourceviews1_beta2/../yup-oauth2/trait.AuthenticatorDelegate.html). 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](http://byron.github.io/google-apis-rs/google-resourceviews1_beta2/enum.Result.html), should be +If a method supports downloads, the response body, which is part of the [Result](http://byron.github.io/google-apis-rs/google_resourceviews1_beta2/enum.Result.html), should be read by you to obtain the media. -If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google-resourceviews1_beta2/trait.ResponseResult.html), it will return that by default. +If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google_resourceviews1_beta2/trait.ResponseResult.html), 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")`. @@ -145,29 +145,29 @@ Methods supporting uploads can do so using up to 2 different protocols: ## Customization and Callbacks -You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google-resourceviews1_beta2/trait.Delegate.html) to the -[Method Builder](http://byron.github.io/google-apis-rs/google-resourceviews1_beta2/trait.CallBuilder.html) before making the final `doit()` call. +You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google_resourceviews1_beta2/trait.Delegate.html) to the +[Method Builder](http://byron.github.io/google-apis-rs/google_resourceviews1_beta2/trait.CallBuilder.html) 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](http://byron.github.io/google-apis-rs/google-resourceviews1_beta2/trait.Delegate.html) is default-implemented, allowing you to customize it with minimal effort. +The [delegate trait](http://byron.github.io/google-apis-rs/google_resourceviews1_beta2/trait.Delegate.html) 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](http://byron.github.io/google-apis-rs/google-resourceviews1_beta2/trait.RequestValue.html) and -[decodable](http://byron.github.io/google-apis-rs/google-resourceviews1_beta2/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses +All structures provided by this library are made to be [enocodable](http://byron.github.io/google-apis-rs/google_resourceviews1_beta2/trait.RequestValue.html) and +[decodable](http://byron.github.io/google-apis-rs/google_resourceviews1_beta2/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses are valid. -Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google-resourceviews1_beta2/trait.Part.html) which are identifiable by name, which will be sent to +Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google_resourceviews1_beta2/trait.Part.html) 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](http://byron.github.io/google-apis-rs/google-resourceviews1_beta2/trait.CallBuilder.html), you are able to prepare an action call by repeatedly calling it's methods. +Using [method builders](http://byron.github.io/google-apis-rs/google_resourceviews1_beta2/trait.CallBuilder.html), 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][wiki-pod] are handed by copy * strings are passed as `&str` -* [request values](http://byron.github.io/google-apis-rs/google-resourceviews1_beta2/trait.RequestValue.html) are borrowed +* [request values](http://byron.github.io/google-apis-rs/google_resourceviews1_beta2/trait.RequestValue.html) are borrowed Arguments will always be copied or cloned into the builder, to make them independent of their original life times. diff --git a/gen/siteverification1/README.md b/gen/siteverification1/README.md index 778639ffc5..aa25e2608a 100644 --- a/gen/siteverification1/README.md +++ b/gen/siteverification1/README.md @@ -11,10 +11,10 @@ Everything else about the *siteVerification* *v1* API can be found at the [official documentation site](https://developers.google.com/site-verification/). # Features -Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google-siteverification1/struct.SiteVerification.html) ... +Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google_siteverification1/struct.SiteVerification.html) ... * web resource - * [*delete*](http://byron.github.io/google-apis-rs/google-siteverification1/struct.WebResourceDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google-siteverification1/struct.WebResourceGetCall.html), [*get token*](http://byron.github.io/google-apis-rs/google-siteverification1/struct.WebResourceGetTokenCall.html), [*insert*](http://byron.github.io/google-apis-rs/google-siteverification1/struct.WebResourceInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google-siteverification1/struct.WebResourceListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google-siteverification1/struct.WebResourcePatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google-siteverification1/struct.WebResourceUpdateCall.html) + * [*delete*](http://byron.github.io/google-apis-rs/google_siteverification1/struct.WebResourceDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google_siteverification1/struct.WebResourceGetCall.html), [*get token*](http://byron.github.io/google-apis-rs/google_siteverification1/struct.WebResourceGetTokenCall.html), [*insert*](http://byron.github.io/google-apis-rs/google_siteverification1/struct.WebResourceInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google_siteverification1/struct.WebResourceListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google_siteverification1/struct.WebResourcePatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google_siteverification1/struct.WebResourceUpdateCall.html) @@ -23,17 +23,17 @@ Handle the following *Resources* with ease from the central [hub](http://byron.g The API is structured into the following primary items: -* **[Hub](http://byron.github.io/google-apis-rs/google-siteverification1/struct.SiteVerification.html)** +* **[Hub](http://byron.github.io/google-apis-rs/google_siteverification1/struct.SiteVerification.html)** * a central object to maintain state and allow accessing all *Activities* - * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google-siteverification1/trait.MethodsBuilder.html) which in turn - allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google-siteverification1/trait.CallBuilder.html) -* **[Resources](http://byron.github.io/google-apis-rs/google-siteverification1/trait.Resource.html)** + * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google_siteverification1/trait.MethodsBuilder.html) which in turn + allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google_siteverification1/trait.CallBuilder.html) +* **[Resources](http://byron.github.io/google-apis-rs/google_siteverification1/trait.Resource.html)** * primary types that you can apply *Activities* to * a collection of properties and *Parts* - * **[Parts](http://byron.github.io/google-apis-rs/google-siteverification1/trait.Part.html)** + * **[Parts](http://byron.github.io/google-apis-rs/google_siteverification1/trait.Part.html)** * a collection of properties * never directly used in *Activities* -* **[Activities](http://byron.github.io/google-apis-rs/google-siteverification1/trait.CallBuilder.html)** +* **[Activities](http://byron.github.io/google-apis-rs/google_siteverification1/trait.CallBuilder.html)** * operations to apply to *Resources* All *structures* are marked with applicable traits to further categorize them and ease browsing. @@ -121,17 +121,17 @@ match result { ``` ## Handling Errors -All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google-siteverification1/enum.Result.html) enumeration as return value of +All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google_siteverification1/enum.Result.html) enumeration as return value of the doit() methods, or handed as possibly intermediate results to either the -[Hub Delegate](http://byron.github.io/google-apis-rs/google-siteverification1/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google-siteverification1/../yup-oauth2/trait.AuthenticatorDelegate.html). +[Hub Delegate](http://byron.github.io/google-apis-rs/google_siteverification1/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google_siteverification1/../yup-oauth2/trait.AuthenticatorDelegate.html). 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](http://byron.github.io/google-apis-rs/google-siteverification1/enum.Result.html), should be +If a method supports downloads, the response body, which is part of the [Result](http://byron.github.io/google-apis-rs/google_siteverification1/enum.Result.html), should be read by you to obtain the media. -If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google-siteverification1/trait.ResponseResult.html), it will return that by default. +If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google_siteverification1/trait.ResponseResult.html), 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")`. @@ -141,29 +141,29 @@ Methods supporting uploads can do so using up to 2 different protocols: ## Customization and Callbacks -You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google-siteverification1/trait.Delegate.html) to the -[Method Builder](http://byron.github.io/google-apis-rs/google-siteverification1/trait.CallBuilder.html) before making the final `doit()` call. +You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google_siteverification1/trait.Delegate.html) to the +[Method Builder](http://byron.github.io/google-apis-rs/google_siteverification1/trait.CallBuilder.html) 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](http://byron.github.io/google-apis-rs/google-siteverification1/trait.Delegate.html) is default-implemented, allowing you to customize it with minimal effort. +The [delegate trait](http://byron.github.io/google-apis-rs/google_siteverification1/trait.Delegate.html) 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](http://byron.github.io/google-apis-rs/google-siteverification1/trait.RequestValue.html) and -[decodable](http://byron.github.io/google-apis-rs/google-siteverification1/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses +All structures provided by this library are made to be [enocodable](http://byron.github.io/google-apis-rs/google_siteverification1/trait.RequestValue.html) and +[decodable](http://byron.github.io/google-apis-rs/google_siteverification1/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses are valid. -Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google-siteverification1/trait.Part.html) which are identifiable by name, which will be sent to +Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google_siteverification1/trait.Part.html) 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](http://byron.github.io/google-apis-rs/google-siteverification1/trait.CallBuilder.html), you are able to prepare an action call by repeatedly calling it's methods. +Using [method builders](http://byron.github.io/google-apis-rs/google_siteverification1/trait.CallBuilder.html), 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][wiki-pod] are handed by copy * strings are passed as `&str` -* [request values](http://byron.github.io/google-apis-rs/google-siteverification1/trait.RequestValue.html) are borrowed +* [request values](http://byron.github.io/google-apis-rs/google_siteverification1/trait.RequestValue.html) are borrowed Arguments will always be copied or cloned into the builder, to make them independent of their original life times. diff --git a/gen/spectrum1_explorer/README.md b/gen/spectrum1_explorer/README.md index c4e80e3bee..01407970b4 100644 --- a/gen/spectrum1_explorer/README.md +++ b/gen/spectrum1_explorer/README.md @@ -11,10 +11,10 @@ Everything else about the *spectrum* *v1_explorer* API can be found at the [official documentation site](http://developers.google.com/spectrum). # Features -Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google-spectrum1_explorer/struct.Spectrum.html) ... +Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google_spectrum1_explorer/struct.Spectrum.html) ... * paws - * [*get spectrum*](http://byron.github.io/google-apis-rs/google-spectrum1_explorer/struct.PawGetSpectrumCall.html), [*get spectrum batch*](http://byron.github.io/google-apis-rs/google-spectrum1_explorer/struct.PawGetSpectrumBatchCall.html), [*init*](http://byron.github.io/google-apis-rs/google-spectrum1_explorer/struct.PawInitCall.html), [*notify spectrum use*](http://byron.github.io/google-apis-rs/google-spectrum1_explorer/struct.PawNotifySpectrumUseCall.html), [*register*](http://byron.github.io/google-apis-rs/google-spectrum1_explorer/struct.PawRegisterCall.html) and [*verify device*](http://byron.github.io/google-apis-rs/google-spectrum1_explorer/struct.PawVerifyDeviceCall.html) + * [*get spectrum*](http://byron.github.io/google-apis-rs/google_spectrum1_explorer/struct.PawGetSpectrumCall.html), [*get spectrum batch*](http://byron.github.io/google-apis-rs/google_spectrum1_explorer/struct.PawGetSpectrumBatchCall.html), [*init*](http://byron.github.io/google-apis-rs/google_spectrum1_explorer/struct.PawInitCall.html), [*notify spectrum use*](http://byron.github.io/google-apis-rs/google_spectrum1_explorer/struct.PawNotifySpectrumUseCall.html), [*register*](http://byron.github.io/google-apis-rs/google_spectrum1_explorer/struct.PawRegisterCall.html) and [*verify device*](http://byron.github.io/google-apis-rs/google_spectrum1_explorer/struct.PawVerifyDeviceCall.html) @@ -23,17 +23,17 @@ Handle the following *Resources* with ease from the central [hub](http://byron.g The API is structured into the following primary items: -* **[Hub](http://byron.github.io/google-apis-rs/google-spectrum1_explorer/struct.Spectrum.html)** +* **[Hub](http://byron.github.io/google-apis-rs/google_spectrum1_explorer/struct.Spectrum.html)** * a central object to maintain state and allow accessing all *Activities* - * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google-spectrum1_explorer/trait.MethodsBuilder.html) which in turn - allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google-spectrum1_explorer/trait.CallBuilder.html) -* **[Resources](http://byron.github.io/google-apis-rs/google-spectrum1_explorer/trait.Resource.html)** + * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google_spectrum1_explorer/trait.MethodsBuilder.html) which in turn + allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google_spectrum1_explorer/trait.CallBuilder.html) +* **[Resources](http://byron.github.io/google-apis-rs/google_spectrum1_explorer/trait.Resource.html)** * primary types that you can apply *Activities* to * a collection of properties and *Parts* - * **[Parts](http://byron.github.io/google-apis-rs/google-spectrum1_explorer/trait.Part.html)** + * **[Parts](http://byron.github.io/google-apis-rs/google_spectrum1_explorer/trait.Part.html)** * a collection of properties * never directly used in *Activities* -* **[Activities](http://byron.github.io/google-apis-rs/google-spectrum1_explorer/trait.CallBuilder.html)** +* **[Activities](http://byron.github.io/google-apis-rs/google_spectrum1_explorer/trait.CallBuilder.html)** * operations to apply to *Resources* All *structures* are marked with applicable traits to further categorize them and ease browsing. @@ -118,17 +118,17 @@ match result { ``` ## Handling Errors -All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google-spectrum1_explorer/enum.Result.html) enumeration as return value of +All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google_spectrum1_explorer/enum.Result.html) enumeration as return value of the doit() methods, or handed as possibly intermediate results to either the -[Hub Delegate](http://byron.github.io/google-apis-rs/google-spectrum1_explorer/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google-spectrum1_explorer/../yup-oauth2/trait.AuthenticatorDelegate.html). +[Hub Delegate](http://byron.github.io/google-apis-rs/google_spectrum1_explorer/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google_spectrum1_explorer/../yup-oauth2/trait.AuthenticatorDelegate.html). 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](http://byron.github.io/google-apis-rs/google-spectrum1_explorer/enum.Result.html), should be +If a method supports downloads, the response body, which is part of the [Result](http://byron.github.io/google-apis-rs/google_spectrum1_explorer/enum.Result.html), should be read by you to obtain the media. -If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google-spectrum1_explorer/trait.ResponseResult.html), it will return that by default. +If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google_spectrum1_explorer/trait.ResponseResult.html), 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")`. @@ -138,29 +138,29 @@ Methods supporting uploads can do so using up to 2 different protocols: ## Customization and Callbacks -You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google-spectrum1_explorer/trait.Delegate.html) to the -[Method Builder](http://byron.github.io/google-apis-rs/google-spectrum1_explorer/trait.CallBuilder.html) before making the final `doit()` call. +You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google_spectrum1_explorer/trait.Delegate.html) to the +[Method Builder](http://byron.github.io/google-apis-rs/google_spectrum1_explorer/trait.CallBuilder.html) 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](http://byron.github.io/google-apis-rs/google-spectrum1_explorer/trait.Delegate.html) is default-implemented, allowing you to customize it with minimal effort. +The [delegate trait](http://byron.github.io/google-apis-rs/google_spectrum1_explorer/trait.Delegate.html) 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](http://byron.github.io/google-apis-rs/google-spectrum1_explorer/trait.RequestValue.html) and -[decodable](http://byron.github.io/google-apis-rs/google-spectrum1_explorer/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses +All structures provided by this library are made to be [enocodable](http://byron.github.io/google-apis-rs/google_spectrum1_explorer/trait.RequestValue.html) and +[decodable](http://byron.github.io/google-apis-rs/google_spectrum1_explorer/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses are valid. -Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google-spectrum1_explorer/trait.Part.html) which are identifiable by name, which will be sent to +Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google_spectrum1_explorer/trait.Part.html) 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](http://byron.github.io/google-apis-rs/google-spectrum1_explorer/trait.CallBuilder.html), you are able to prepare an action call by repeatedly calling it's methods. +Using [method builders](http://byron.github.io/google-apis-rs/google_spectrum1_explorer/trait.CallBuilder.html), 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][wiki-pod] are handed by copy * strings are passed as `&str` -* [request values](http://byron.github.io/google-apis-rs/google-spectrum1_explorer/trait.RequestValue.html) are borrowed +* [request values](http://byron.github.io/google-apis-rs/google_spectrum1_explorer/trait.RequestValue.html) are borrowed Arguments will always be copied or cloned into the builder, to make them independent of their original life times. diff --git a/gen/sqladmin1_beta4/README.md b/gen/sqladmin1_beta4/README.md index 3a3f0dc8ea..251c93ff4f 100644 --- a/gen/sqladmin1_beta4/README.md +++ b/gen/sqladmin1_beta4/README.md @@ -11,24 +11,24 @@ Everything else about the *SQL Admin* *v1_beta4* API can be found at the [official documentation site](https://developers.google.com/cloud-sql/docs/admin-api/). # Features -Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google-sqladmin1_beta4/struct.SQLAdmin.html) ... +Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google_sqladmin1_beta4/struct.SQLAdmin.html) ... -* [backup runs](http://byron.github.io/google-apis-rs/google-sqladmin1_beta4/struct.BackupRun.html) - * [*get*](http://byron.github.io/google-apis-rs/google-sqladmin1_beta4/struct.BackupRunGetCall.html) and [*list*](http://byron.github.io/google-apis-rs/google-sqladmin1_beta4/struct.BackupRunListCall.html) -* [databases](http://byron.github.io/google-apis-rs/google-sqladmin1_beta4/struct.Database.html) - * [*delete*](http://byron.github.io/google-apis-rs/google-sqladmin1_beta4/struct.DatabaseDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google-sqladmin1_beta4/struct.DatabaseGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google-sqladmin1_beta4/struct.DatabaseInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google-sqladmin1_beta4/struct.DatabaseListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google-sqladmin1_beta4/struct.DatabasePatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google-sqladmin1_beta4/struct.DatabaseUpdateCall.html) -* [flags](http://byron.github.io/google-apis-rs/google-sqladmin1_beta4/struct.Flag.html) - * [*list*](http://byron.github.io/google-apis-rs/google-sqladmin1_beta4/struct.FlagListCall.html) +* [backup runs](http://byron.github.io/google-apis-rs/google_sqladmin1_beta4/struct.BackupRun.html) + * [*get*](http://byron.github.io/google-apis-rs/google_sqladmin1_beta4/struct.BackupRunGetCall.html) and [*list*](http://byron.github.io/google-apis-rs/google_sqladmin1_beta4/struct.BackupRunListCall.html) +* [databases](http://byron.github.io/google-apis-rs/google_sqladmin1_beta4/struct.Database.html) + * [*delete*](http://byron.github.io/google-apis-rs/google_sqladmin1_beta4/struct.DatabaseDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google_sqladmin1_beta4/struct.DatabaseGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google_sqladmin1_beta4/struct.DatabaseInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google_sqladmin1_beta4/struct.DatabaseListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google_sqladmin1_beta4/struct.DatabasePatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google_sqladmin1_beta4/struct.DatabaseUpdateCall.html) +* [flags](http://byron.github.io/google-apis-rs/google_sqladmin1_beta4/struct.Flag.html) + * [*list*](http://byron.github.io/google-apis-rs/google_sqladmin1_beta4/struct.FlagListCall.html) * instances - * [*clone*](http://byron.github.io/google-apis-rs/google-sqladmin1_beta4/struct.InstanceCloneCall.html), [*delete*](http://byron.github.io/google-apis-rs/google-sqladmin1_beta4/struct.InstanceDeleteCall.html), [*export*](http://byron.github.io/google-apis-rs/google-sqladmin1_beta4/struct.InstanceExportCall.html), [*get*](http://byron.github.io/google-apis-rs/google-sqladmin1_beta4/struct.InstanceGetCall.html), [*import*](http://byron.github.io/google-apis-rs/google-sqladmin1_beta4/struct.InstanceImportCall.html), [*insert*](http://byron.github.io/google-apis-rs/google-sqladmin1_beta4/struct.InstanceInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google-sqladmin1_beta4/struct.InstanceListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google-sqladmin1_beta4/struct.InstancePatchCall.html), [*promote replica*](http://byron.github.io/google-apis-rs/google-sqladmin1_beta4/struct.InstancePromoteReplicaCall.html), [*reset ssl config*](http://byron.github.io/google-apis-rs/google-sqladmin1_beta4/struct.InstanceResetSslConfigCall.html), [*restart*](http://byron.github.io/google-apis-rs/google-sqladmin1_beta4/struct.InstanceRestartCall.html), [*restore backup*](http://byron.github.io/google-apis-rs/google-sqladmin1_beta4/struct.InstanceRestoreBackupCall.html), [*start replica*](http://byron.github.io/google-apis-rs/google-sqladmin1_beta4/struct.InstanceStartReplicaCall.html), [*stop replica*](http://byron.github.io/google-apis-rs/google-sqladmin1_beta4/struct.InstanceStopReplicaCall.html) and [*update*](http://byron.github.io/google-apis-rs/google-sqladmin1_beta4/struct.InstanceUpdateCall.html) -* [operations](http://byron.github.io/google-apis-rs/google-sqladmin1_beta4/struct.Operation.html) - * [*get*](http://byron.github.io/google-apis-rs/google-sqladmin1_beta4/struct.OperationGetCall.html) and [*list*](http://byron.github.io/google-apis-rs/google-sqladmin1_beta4/struct.OperationListCall.html) -* [ssl certs](http://byron.github.io/google-apis-rs/google-sqladmin1_beta4/struct.SslCert.html) - * [*delete*](http://byron.github.io/google-apis-rs/google-sqladmin1_beta4/struct.SslCertDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google-sqladmin1_beta4/struct.SslCertGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google-sqladmin1_beta4/struct.SslCertInsertCall.html) and [*list*](http://byron.github.io/google-apis-rs/google-sqladmin1_beta4/struct.SslCertListCall.html) -* [tiers](http://byron.github.io/google-apis-rs/google-sqladmin1_beta4/struct.Tier.html) - * [*list*](http://byron.github.io/google-apis-rs/google-sqladmin1_beta4/struct.TierListCall.html) -* [users](http://byron.github.io/google-apis-rs/google-sqladmin1_beta4/struct.User.html) - * [*delete*](http://byron.github.io/google-apis-rs/google-sqladmin1_beta4/struct.UserDeleteCall.html), [*insert*](http://byron.github.io/google-apis-rs/google-sqladmin1_beta4/struct.UserInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google-sqladmin1_beta4/struct.UserListCall.html) and [*update*](http://byron.github.io/google-apis-rs/google-sqladmin1_beta4/struct.UserUpdateCall.html) + * [*clone*](http://byron.github.io/google-apis-rs/google_sqladmin1_beta4/struct.InstanceCloneCall.html), [*delete*](http://byron.github.io/google-apis-rs/google_sqladmin1_beta4/struct.InstanceDeleteCall.html), [*export*](http://byron.github.io/google-apis-rs/google_sqladmin1_beta4/struct.InstanceExportCall.html), [*get*](http://byron.github.io/google-apis-rs/google_sqladmin1_beta4/struct.InstanceGetCall.html), [*import*](http://byron.github.io/google-apis-rs/google_sqladmin1_beta4/struct.InstanceImportCall.html), [*insert*](http://byron.github.io/google-apis-rs/google_sqladmin1_beta4/struct.InstanceInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google_sqladmin1_beta4/struct.InstanceListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google_sqladmin1_beta4/struct.InstancePatchCall.html), [*promote replica*](http://byron.github.io/google-apis-rs/google_sqladmin1_beta4/struct.InstancePromoteReplicaCall.html), [*reset ssl config*](http://byron.github.io/google-apis-rs/google_sqladmin1_beta4/struct.InstanceResetSslConfigCall.html), [*restart*](http://byron.github.io/google-apis-rs/google_sqladmin1_beta4/struct.InstanceRestartCall.html), [*restore backup*](http://byron.github.io/google-apis-rs/google_sqladmin1_beta4/struct.InstanceRestoreBackupCall.html), [*start replica*](http://byron.github.io/google-apis-rs/google_sqladmin1_beta4/struct.InstanceStartReplicaCall.html), [*stop replica*](http://byron.github.io/google-apis-rs/google_sqladmin1_beta4/struct.InstanceStopReplicaCall.html) and [*update*](http://byron.github.io/google-apis-rs/google_sqladmin1_beta4/struct.InstanceUpdateCall.html) +* [operations](http://byron.github.io/google-apis-rs/google_sqladmin1_beta4/struct.Operation.html) + * [*get*](http://byron.github.io/google-apis-rs/google_sqladmin1_beta4/struct.OperationGetCall.html) and [*list*](http://byron.github.io/google-apis-rs/google_sqladmin1_beta4/struct.OperationListCall.html) +* [ssl certs](http://byron.github.io/google-apis-rs/google_sqladmin1_beta4/struct.SslCert.html) + * [*delete*](http://byron.github.io/google-apis-rs/google_sqladmin1_beta4/struct.SslCertDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google_sqladmin1_beta4/struct.SslCertGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google_sqladmin1_beta4/struct.SslCertInsertCall.html) and [*list*](http://byron.github.io/google-apis-rs/google_sqladmin1_beta4/struct.SslCertListCall.html) +* [tiers](http://byron.github.io/google-apis-rs/google_sqladmin1_beta4/struct.Tier.html) + * [*list*](http://byron.github.io/google-apis-rs/google_sqladmin1_beta4/struct.TierListCall.html) +* [users](http://byron.github.io/google-apis-rs/google_sqladmin1_beta4/struct.User.html) + * [*delete*](http://byron.github.io/google-apis-rs/google_sqladmin1_beta4/struct.UserDeleteCall.html), [*insert*](http://byron.github.io/google-apis-rs/google_sqladmin1_beta4/struct.UserInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google_sqladmin1_beta4/struct.UserListCall.html) and [*update*](http://byron.github.io/google-apis-rs/google_sqladmin1_beta4/struct.UserUpdateCall.html) @@ -37,17 +37,17 @@ Handle the following *Resources* with ease from the central [hub](http://byron.g The API is structured into the following primary items: -* **[Hub](http://byron.github.io/google-apis-rs/google-sqladmin1_beta4/struct.SQLAdmin.html)** +* **[Hub](http://byron.github.io/google-apis-rs/google_sqladmin1_beta4/struct.SQLAdmin.html)** * a central object to maintain state and allow accessing all *Activities* - * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google-sqladmin1_beta4/trait.MethodsBuilder.html) which in turn - allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google-sqladmin1_beta4/trait.CallBuilder.html) -* **[Resources](http://byron.github.io/google-apis-rs/google-sqladmin1_beta4/trait.Resource.html)** + * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google_sqladmin1_beta4/trait.MethodsBuilder.html) which in turn + allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google_sqladmin1_beta4/trait.CallBuilder.html) +* **[Resources](http://byron.github.io/google-apis-rs/google_sqladmin1_beta4/trait.Resource.html)** * primary types that you can apply *Activities* to * a collection of properties and *Parts* - * **[Parts](http://byron.github.io/google-apis-rs/google-sqladmin1_beta4/trait.Part.html)** + * **[Parts](http://byron.github.io/google-apis-rs/google_sqladmin1_beta4/trait.Part.html)** * a collection of properties * never directly used in *Activities* -* **[Activities](http://byron.github.io/google-apis-rs/google-sqladmin1_beta4/trait.CallBuilder.html)** +* **[Activities](http://byron.github.io/google-apis-rs/google_sqladmin1_beta4/trait.CallBuilder.html)** * operations to apply to *Resources* All *structures* are marked with applicable traits to further categorize them and ease browsing. @@ -154,17 +154,17 @@ match result { ``` ## Handling Errors -All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google-sqladmin1_beta4/enum.Result.html) enumeration as return value of +All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google_sqladmin1_beta4/enum.Result.html) enumeration as return value of the doit() methods, or handed as possibly intermediate results to either the -[Hub Delegate](http://byron.github.io/google-apis-rs/google-sqladmin1_beta4/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google-sqladmin1_beta4/../yup-oauth2/trait.AuthenticatorDelegate.html). +[Hub Delegate](http://byron.github.io/google-apis-rs/google_sqladmin1_beta4/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google_sqladmin1_beta4/../yup-oauth2/trait.AuthenticatorDelegate.html). 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](http://byron.github.io/google-apis-rs/google-sqladmin1_beta4/enum.Result.html), should be +If a method supports downloads, the response body, which is part of the [Result](http://byron.github.io/google-apis-rs/google_sqladmin1_beta4/enum.Result.html), should be read by you to obtain the media. -If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google-sqladmin1_beta4/trait.ResponseResult.html), it will return that by default. +If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google_sqladmin1_beta4/trait.ResponseResult.html), 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")`. @@ -174,29 +174,29 @@ Methods supporting uploads can do so using up to 2 different protocols: ## Customization and Callbacks -You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google-sqladmin1_beta4/trait.Delegate.html) to the -[Method Builder](http://byron.github.io/google-apis-rs/google-sqladmin1_beta4/trait.CallBuilder.html) before making the final `doit()` call. +You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google_sqladmin1_beta4/trait.Delegate.html) to the +[Method Builder](http://byron.github.io/google-apis-rs/google_sqladmin1_beta4/trait.CallBuilder.html) 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](http://byron.github.io/google-apis-rs/google-sqladmin1_beta4/trait.Delegate.html) is default-implemented, allowing you to customize it with minimal effort. +The [delegate trait](http://byron.github.io/google-apis-rs/google_sqladmin1_beta4/trait.Delegate.html) 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](http://byron.github.io/google-apis-rs/google-sqladmin1_beta4/trait.RequestValue.html) and -[decodable](http://byron.github.io/google-apis-rs/google-sqladmin1_beta4/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses +All structures provided by this library are made to be [enocodable](http://byron.github.io/google-apis-rs/google_sqladmin1_beta4/trait.RequestValue.html) and +[decodable](http://byron.github.io/google-apis-rs/google_sqladmin1_beta4/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses are valid. -Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google-sqladmin1_beta4/trait.Part.html) which are identifiable by name, which will be sent to +Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google_sqladmin1_beta4/trait.Part.html) 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](http://byron.github.io/google-apis-rs/google-sqladmin1_beta4/trait.CallBuilder.html), you are able to prepare an action call by repeatedly calling it's methods. +Using [method builders](http://byron.github.io/google-apis-rs/google_sqladmin1_beta4/trait.CallBuilder.html), 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][wiki-pod] are handed by copy * strings are passed as `&str` -* [request values](http://byron.github.io/google-apis-rs/google-sqladmin1_beta4/trait.RequestValue.html) are borrowed +* [request values](http://byron.github.io/google-apis-rs/google_sqladmin1_beta4/trait.RequestValue.html) are borrowed Arguments will always be copied or cloned into the builder, to make them independent of their original life times. diff --git a/gen/storage1/README.md b/gen/storage1/README.md index 12ab36177f..56c1d77b47 100644 --- a/gen/storage1/README.md +++ b/gen/storage1/README.md @@ -11,38 +11,38 @@ Everything else about the *storage* *v1* API can be found at the [official documentation site](https://developers.google.com/storage/docs/json_api/). # Features -Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google-storage1/struct.Storage.html) ... +Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google_storage1/struct.Storage.html) ... -* [bucket access controls](http://byron.github.io/google-apis-rs/google-storage1/struct.BucketAccessControl.html) - * [*delete*](http://byron.github.io/google-apis-rs/google-storage1/struct.BucketAccessControlDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google-storage1/struct.BucketAccessControlGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google-storage1/struct.BucketAccessControlInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google-storage1/struct.BucketAccessControlListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google-storage1/struct.BucketAccessControlPatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google-storage1/struct.BucketAccessControlUpdateCall.html) -* [buckets](http://byron.github.io/google-apis-rs/google-storage1/struct.Bucket.html) - * [*delete*](http://byron.github.io/google-apis-rs/google-storage1/struct.BucketDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google-storage1/struct.BucketGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google-storage1/struct.BucketInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google-storage1/struct.BucketListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google-storage1/struct.BucketPatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google-storage1/struct.BucketUpdateCall.html) -* [channels](http://byron.github.io/google-apis-rs/google-storage1/struct.Channel.html) - * [*stop*](http://byron.github.io/google-apis-rs/google-storage1/struct.ChannelStopCall.html) +* [bucket access controls](http://byron.github.io/google-apis-rs/google_storage1/struct.BucketAccessControl.html) + * [*delete*](http://byron.github.io/google-apis-rs/google_storage1/struct.BucketAccessControlDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google_storage1/struct.BucketAccessControlGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google_storage1/struct.BucketAccessControlInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google_storage1/struct.BucketAccessControlListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google_storage1/struct.BucketAccessControlPatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google_storage1/struct.BucketAccessControlUpdateCall.html) +* [buckets](http://byron.github.io/google-apis-rs/google_storage1/struct.Bucket.html) + * [*delete*](http://byron.github.io/google-apis-rs/google_storage1/struct.BucketDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google_storage1/struct.BucketGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google_storage1/struct.BucketInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google_storage1/struct.BucketListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google_storage1/struct.BucketPatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google_storage1/struct.BucketUpdateCall.html) +* [channels](http://byron.github.io/google-apis-rs/google_storage1/struct.Channel.html) + * [*stop*](http://byron.github.io/google-apis-rs/google_storage1/struct.ChannelStopCall.html) * default object access controls - * [*delete*](http://byron.github.io/google-apis-rs/google-storage1/struct.DefaultObjectAccessControlDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google-storage1/struct.DefaultObjectAccessControlGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google-storage1/struct.DefaultObjectAccessControlInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google-storage1/struct.DefaultObjectAccessControlListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google-storage1/struct.DefaultObjectAccessControlPatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google-storage1/struct.DefaultObjectAccessControlUpdateCall.html) -* [object access controls](http://byron.github.io/google-apis-rs/google-storage1/struct.ObjectAccessControl.html) - * [*delete*](http://byron.github.io/google-apis-rs/google-storage1/struct.ObjectAccessControlDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google-storage1/struct.ObjectAccessControlGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google-storage1/struct.ObjectAccessControlInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google-storage1/struct.ObjectAccessControlListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google-storage1/struct.ObjectAccessControlPatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google-storage1/struct.ObjectAccessControlUpdateCall.html) -* [objects](http://byron.github.io/google-apis-rs/google-storage1/struct.Object.html) - * [*compose*](http://byron.github.io/google-apis-rs/google-storage1/struct.ObjectComposeCall.html), [*copy*](http://byron.github.io/google-apis-rs/google-storage1/struct.ObjectCopyCall.html), [*delete*](http://byron.github.io/google-apis-rs/google-storage1/struct.ObjectDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google-storage1/struct.ObjectGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google-storage1/struct.ObjectInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google-storage1/struct.ObjectListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google-storage1/struct.ObjectPatchCall.html), [*update*](http://byron.github.io/google-apis-rs/google-storage1/struct.ObjectUpdateCall.html) and [*watch all*](http://byron.github.io/google-apis-rs/google-storage1/struct.ObjectWatchAllCall.html) + * [*delete*](http://byron.github.io/google-apis-rs/google_storage1/struct.DefaultObjectAccessControlDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google_storage1/struct.DefaultObjectAccessControlGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google_storage1/struct.DefaultObjectAccessControlInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google_storage1/struct.DefaultObjectAccessControlListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google_storage1/struct.DefaultObjectAccessControlPatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google_storage1/struct.DefaultObjectAccessControlUpdateCall.html) +* [object access controls](http://byron.github.io/google-apis-rs/google_storage1/struct.ObjectAccessControl.html) + * [*delete*](http://byron.github.io/google-apis-rs/google_storage1/struct.ObjectAccessControlDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google_storage1/struct.ObjectAccessControlGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google_storage1/struct.ObjectAccessControlInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google_storage1/struct.ObjectAccessControlListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google_storage1/struct.ObjectAccessControlPatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google_storage1/struct.ObjectAccessControlUpdateCall.html) +* [objects](http://byron.github.io/google-apis-rs/google_storage1/struct.Object.html) + * [*compose*](http://byron.github.io/google-apis-rs/google_storage1/struct.ObjectComposeCall.html), [*copy*](http://byron.github.io/google-apis-rs/google_storage1/struct.ObjectCopyCall.html), [*delete*](http://byron.github.io/google-apis-rs/google_storage1/struct.ObjectDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google_storage1/struct.ObjectGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google_storage1/struct.ObjectInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google_storage1/struct.ObjectListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google_storage1/struct.ObjectPatchCall.html), [*update*](http://byron.github.io/google-apis-rs/google_storage1/struct.ObjectUpdateCall.html) and [*watch all*](http://byron.github.io/google-apis-rs/google_storage1/struct.ObjectWatchAllCall.html) Upload supported by ... -* [*insert objects*](http://byron.github.io/google-apis-rs/google-storage1/struct.ObjectInsertCall.html) +* [*insert objects*](http://byron.github.io/google-apis-rs/google_storage1/struct.ObjectInsertCall.html) Download supported by ... -* [*get objects*](http://byron.github.io/google-apis-rs/google-storage1/struct.ObjectGetCall.html) -* [*update objects*](http://byron.github.io/google-apis-rs/google-storage1/struct.ObjectUpdateCall.html) -* [*insert objects*](http://byron.github.io/google-apis-rs/google-storage1/struct.ObjectInsertCall.html) -* [*compose objects*](http://byron.github.io/google-apis-rs/google-storage1/struct.ObjectComposeCall.html) -* [*copy objects*](http://byron.github.io/google-apis-rs/google-storage1/struct.ObjectCopyCall.html) +* [*get objects*](http://byron.github.io/google-apis-rs/google_storage1/struct.ObjectGetCall.html) +* [*update objects*](http://byron.github.io/google-apis-rs/google_storage1/struct.ObjectUpdateCall.html) +* [*insert objects*](http://byron.github.io/google-apis-rs/google_storage1/struct.ObjectInsertCall.html) +* [*compose objects*](http://byron.github.io/google-apis-rs/google_storage1/struct.ObjectComposeCall.html) +* [*copy objects*](http://byron.github.io/google-apis-rs/google_storage1/struct.ObjectCopyCall.html) Subscription supported by ... -* [*watch all objects*](http://byron.github.io/google-apis-rs/google-storage1/struct.ObjectWatchAllCall.html) -* [*list objects*](http://byron.github.io/google-apis-rs/google-storage1/struct.ObjectListCall.html) +* [*watch all objects*](http://byron.github.io/google-apis-rs/google_storage1/struct.ObjectWatchAllCall.html) +* [*list objects*](http://byron.github.io/google-apis-rs/google_storage1/struct.ObjectListCall.html) @@ -50,17 +50,17 @@ Subscription supported by ... The API is structured into the following primary items: -* **[Hub](http://byron.github.io/google-apis-rs/google-storage1/struct.Storage.html)** +* **[Hub](http://byron.github.io/google-apis-rs/google_storage1/struct.Storage.html)** * a central object to maintain state and allow accessing all *Activities* - * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google-storage1/trait.MethodsBuilder.html) which in turn - allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google-storage1/trait.CallBuilder.html) -* **[Resources](http://byron.github.io/google-apis-rs/google-storage1/trait.Resource.html)** + * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google_storage1/trait.MethodsBuilder.html) which in turn + allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google_storage1/trait.CallBuilder.html) +* **[Resources](http://byron.github.io/google-apis-rs/google_storage1/trait.Resource.html)** * primary types that you can apply *Activities* to * a collection of properties and *Parts* - * **[Parts](http://byron.github.io/google-apis-rs/google-storage1/trait.Part.html)** + * **[Parts](http://byron.github.io/google-apis-rs/google_storage1/trait.Part.html)** * a collection of properties * never directly used in *Activities* -* **[Activities](http://byron.github.io/google-apis-rs/google-storage1/trait.CallBuilder.html)** +* **[Activities](http://byron.github.io/google-apis-rs/google_storage1/trait.CallBuilder.html)** * operations to apply to *Resources* All *structures* are marked with applicable traits to further categorize them and ease browsing. @@ -155,17 +155,17 @@ match result { ``` ## Handling Errors -All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google-storage1/enum.Result.html) enumeration as return value of +All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google_storage1/enum.Result.html) enumeration as return value of the doit() methods, or handed as possibly intermediate results to either the -[Hub Delegate](http://byron.github.io/google-apis-rs/google-storage1/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google-storage1/../yup-oauth2/trait.AuthenticatorDelegate.html). +[Hub Delegate](http://byron.github.io/google-apis-rs/google_storage1/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google_storage1/../yup-oauth2/trait.AuthenticatorDelegate.html). 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](http://byron.github.io/google-apis-rs/google-storage1/enum.Result.html), should be +If a method supports downloads, the response body, which is part of the [Result](http://byron.github.io/google-apis-rs/google_storage1/enum.Result.html), should be read by you to obtain the media. -If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google-storage1/trait.ResponseResult.html), it will return that by default. +If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google_storage1/trait.ResponseResult.html), 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")`. @@ -175,29 +175,29 @@ Methods supporting uploads can do so using up to 2 different protocols: ## Customization and Callbacks -You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google-storage1/trait.Delegate.html) to the -[Method Builder](http://byron.github.io/google-apis-rs/google-storage1/trait.CallBuilder.html) before making the final `doit()` call. +You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google_storage1/trait.Delegate.html) to the +[Method Builder](http://byron.github.io/google-apis-rs/google_storage1/trait.CallBuilder.html) 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](http://byron.github.io/google-apis-rs/google-storage1/trait.Delegate.html) is default-implemented, allowing you to customize it with minimal effort. +The [delegate trait](http://byron.github.io/google-apis-rs/google_storage1/trait.Delegate.html) 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](http://byron.github.io/google-apis-rs/google-storage1/trait.RequestValue.html) and -[decodable](http://byron.github.io/google-apis-rs/google-storage1/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses +All structures provided by this library are made to be [enocodable](http://byron.github.io/google-apis-rs/google_storage1/trait.RequestValue.html) and +[decodable](http://byron.github.io/google-apis-rs/google_storage1/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses are valid. -Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google-storage1/trait.Part.html) which are identifiable by name, which will be sent to +Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google_storage1/trait.Part.html) 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](http://byron.github.io/google-apis-rs/google-storage1/trait.CallBuilder.html), you are able to prepare an action call by repeatedly calling it's methods. +Using [method builders](http://byron.github.io/google-apis-rs/google_storage1/trait.CallBuilder.html), 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][wiki-pod] are handed by copy * strings are passed as `&str` -* [request values](http://byron.github.io/google-apis-rs/google-storage1/trait.RequestValue.html) are borrowed +* [request values](http://byron.github.io/google-apis-rs/google_storage1/trait.RequestValue.html) are borrowed Arguments will always be copied or cloned into the builder, to make them independent of their original life times. diff --git a/gen/tagmanager1/README.md b/gen/tagmanager1/README.md index 7a40e6ae90..94d23dbb93 100644 --- a/gen/tagmanager1/README.md +++ b/gen/tagmanager1/README.md @@ -11,10 +11,10 @@ Everything else about the *Tag Manager* *v1* API can be found at the [official documentation site](https://developers.google.com/tag-manager/api/v1/). # Features -Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google-tagmanager1/struct.TagManager.html) ... +Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google_tagmanager1/struct.TagManager.html) ... -* [accounts](http://byron.github.io/google-apis-rs/google-tagmanager1/struct.Account.html) - * [*containers create*](http://byron.github.io/google-apis-rs/google-tagmanager1/struct.AccountContainerCreateCall.html), [*containers delete*](http://byron.github.io/google-apis-rs/google-tagmanager1/struct.AccountContainerDeleteCall.html), [*containers get*](http://byron.github.io/google-apis-rs/google-tagmanager1/struct.AccountContainerGetCall.html), [*containers list*](http://byron.github.io/google-apis-rs/google-tagmanager1/struct.AccountContainerListCall.html), [*containers macros create*](http://byron.github.io/google-apis-rs/google-tagmanager1/struct.AccountContainerMacroCreateCall.html), [*containers macros delete*](http://byron.github.io/google-apis-rs/google-tagmanager1/struct.AccountContainerMacroDeleteCall.html), [*containers macros get*](http://byron.github.io/google-apis-rs/google-tagmanager1/struct.AccountContainerMacroGetCall.html), [*containers macros list*](http://byron.github.io/google-apis-rs/google-tagmanager1/struct.AccountContainerMacroListCall.html), [*containers macros update*](http://byron.github.io/google-apis-rs/google-tagmanager1/struct.AccountContainerMacroUpdateCall.html), [*containers rules create*](http://byron.github.io/google-apis-rs/google-tagmanager1/struct.AccountContainerRuleCreateCall.html), [*containers rules delete*](http://byron.github.io/google-apis-rs/google-tagmanager1/struct.AccountContainerRuleDeleteCall.html), [*containers rules get*](http://byron.github.io/google-apis-rs/google-tagmanager1/struct.AccountContainerRuleGetCall.html), [*containers rules list*](http://byron.github.io/google-apis-rs/google-tagmanager1/struct.AccountContainerRuleListCall.html), [*containers rules update*](http://byron.github.io/google-apis-rs/google-tagmanager1/struct.AccountContainerRuleUpdateCall.html), [*containers tags create*](http://byron.github.io/google-apis-rs/google-tagmanager1/struct.AccountContainerTagCreateCall.html), [*containers tags delete*](http://byron.github.io/google-apis-rs/google-tagmanager1/struct.AccountContainerTagDeleteCall.html), [*containers tags get*](http://byron.github.io/google-apis-rs/google-tagmanager1/struct.AccountContainerTagGetCall.html), [*containers tags list*](http://byron.github.io/google-apis-rs/google-tagmanager1/struct.AccountContainerTagListCall.html), [*containers tags update*](http://byron.github.io/google-apis-rs/google-tagmanager1/struct.AccountContainerTagUpdateCall.html), [*containers triggers create*](http://byron.github.io/google-apis-rs/google-tagmanager1/struct.AccountContainerTriggerCreateCall.html), [*containers triggers delete*](http://byron.github.io/google-apis-rs/google-tagmanager1/struct.AccountContainerTriggerDeleteCall.html), [*containers triggers get*](http://byron.github.io/google-apis-rs/google-tagmanager1/struct.AccountContainerTriggerGetCall.html), [*containers triggers list*](http://byron.github.io/google-apis-rs/google-tagmanager1/struct.AccountContainerTriggerListCall.html), [*containers triggers update*](http://byron.github.io/google-apis-rs/google-tagmanager1/struct.AccountContainerTriggerUpdateCall.html), [*containers update*](http://byron.github.io/google-apis-rs/google-tagmanager1/struct.AccountContainerUpdateCall.html), [*containers variables create*](http://byron.github.io/google-apis-rs/google-tagmanager1/struct.AccountContainerVariableCreateCall.html), [*containers variables delete*](http://byron.github.io/google-apis-rs/google-tagmanager1/struct.AccountContainerVariableDeleteCall.html), [*containers variables get*](http://byron.github.io/google-apis-rs/google-tagmanager1/struct.AccountContainerVariableGetCall.html), [*containers variables list*](http://byron.github.io/google-apis-rs/google-tagmanager1/struct.AccountContainerVariableListCall.html), [*containers variables update*](http://byron.github.io/google-apis-rs/google-tagmanager1/struct.AccountContainerVariableUpdateCall.html), [*containers versions create*](http://byron.github.io/google-apis-rs/google-tagmanager1/struct.AccountContainerVersionCreateCall.html), [*containers versions delete*](http://byron.github.io/google-apis-rs/google-tagmanager1/struct.AccountContainerVersionDeleteCall.html), [*containers versions get*](http://byron.github.io/google-apis-rs/google-tagmanager1/struct.AccountContainerVersionGetCall.html), [*containers versions list*](http://byron.github.io/google-apis-rs/google-tagmanager1/struct.AccountContainerVersionListCall.html), [*containers versions publish*](http://byron.github.io/google-apis-rs/google-tagmanager1/struct.AccountContainerVersionPublishCall.html), [*containers versions restore*](http://byron.github.io/google-apis-rs/google-tagmanager1/struct.AccountContainerVersionRestoreCall.html), [*containers versions undelete*](http://byron.github.io/google-apis-rs/google-tagmanager1/struct.AccountContainerVersionUndeleteCall.html), [*containers versions update*](http://byron.github.io/google-apis-rs/google-tagmanager1/struct.AccountContainerVersionUpdateCall.html), [*get*](http://byron.github.io/google-apis-rs/google-tagmanager1/struct.AccountGetCall.html), [*list*](http://byron.github.io/google-apis-rs/google-tagmanager1/struct.AccountListCall.html), [*permissions create*](http://byron.github.io/google-apis-rs/google-tagmanager1/struct.AccountPermissionCreateCall.html), [*permissions delete*](http://byron.github.io/google-apis-rs/google-tagmanager1/struct.AccountPermissionDeleteCall.html), [*permissions get*](http://byron.github.io/google-apis-rs/google-tagmanager1/struct.AccountPermissionGetCall.html), [*permissions list*](http://byron.github.io/google-apis-rs/google-tagmanager1/struct.AccountPermissionListCall.html), [*permissions update*](http://byron.github.io/google-apis-rs/google-tagmanager1/struct.AccountPermissionUpdateCall.html) and [*update*](http://byron.github.io/google-apis-rs/google-tagmanager1/struct.AccountUpdateCall.html) +* [accounts](http://byron.github.io/google-apis-rs/google_tagmanager1/struct.Account.html) + * [*containers create*](http://byron.github.io/google-apis-rs/google_tagmanager1/struct.AccountContainerCreateCall.html), [*containers delete*](http://byron.github.io/google-apis-rs/google_tagmanager1/struct.AccountContainerDeleteCall.html), [*containers get*](http://byron.github.io/google-apis-rs/google_tagmanager1/struct.AccountContainerGetCall.html), [*containers list*](http://byron.github.io/google-apis-rs/google_tagmanager1/struct.AccountContainerListCall.html), [*containers macros create*](http://byron.github.io/google-apis-rs/google_tagmanager1/struct.AccountContainerMacroCreateCall.html), [*containers macros delete*](http://byron.github.io/google-apis-rs/google_tagmanager1/struct.AccountContainerMacroDeleteCall.html), [*containers macros get*](http://byron.github.io/google-apis-rs/google_tagmanager1/struct.AccountContainerMacroGetCall.html), [*containers macros list*](http://byron.github.io/google-apis-rs/google_tagmanager1/struct.AccountContainerMacroListCall.html), [*containers macros update*](http://byron.github.io/google-apis-rs/google_tagmanager1/struct.AccountContainerMacroUpdateCall.html), [*containers rules create*](http://byron.github.io/google-apis-rs/google_tagmanager1/struct.AccountContainerRuleCreateCall.html), [*containers rules delete*](http://byron.github.io/google-apis-rs/google_tagmanager1/struct.AccountContainerRuleDeleteCall.html), [*containers rules get*](http://byron.github.io/google-apis-rs/google_tagmanager1/struct.AccountContainerRuleGetCall.html), [*containers rules list*](http://byron.github.io/google-apis-rs/google_tagmanager1/struct.AccountContainerRuleListCall.html), [*containers rules update*](http://byron.github.io/google-apis-rs/google_tagmanager1/struct.AccountContainerRuleUpdateCall.html), [*containers tags create*](http://byron.github.io/google-apis-rs/google_tagmanager1/struct.AccountContainerTagCreateCall.html), [*containers tags delete*](http://byron.github.io/google-apis-rs/google_tagmanager1/struct.AccountContainerTagDeleteCall.html), [*containers tags get*](http://byron.github.io/google-apis-rs/google_tagmanager1/struct.AccountContainerTagGetCall.html), [*containers tags list*](http://byron.github.io/google-apis-rs/google_tagmanager1/struct.AccountContainerTagListCall.html), [*containers tags update*](http://byron.github.io/google-apis-rs/google_tagmanager1/struct.AccountContainerTagUpdateCall.html), [*containers triggers create*](http://byron.github.io/google-apis-rs/google_tagmanager1/struct.AccountContainerTriggerCreateCall.html), [*containers triggers delete*](http://byron.github.io/google-apis-rs/google_tagmanager1/struct.AccountContainerTriggerDeleteCall.html), [*containers triggers get*](http://byron.github.io/google-apis-rs/google_tagmanager1/struct.AccountContainerTriggerGetCall.html), [*containers triggers list*](http://byron.github.io/google-apis-rs/google_tagmanager1/struct.AccountContainerTriggerListCall.html), [*containers triggers update*](http://byron.github.io/google-apis-rs/google_tagmanager1/struct.AccountContainerTriggerUpdateCall.html), [*containers update*](http://byron.github.io/google-apis-rs/google_tagmanager1/struct.AccountContainerUpdateCall.html), [*containers variables create*](http://byron.github.io/google-apis-rs/google_tagmanager1/struct.AccountContainerVariableCreateCall.html), [*containers variables delete*](http://byron.github.io/google-apis-rs/google_tagmanager1/struct.AccountContainerVariableDeleteCall.html), [*containers variables get*](http://byron.github.io/google-apis-rs/google_tagmanager1/struct.AccountContainerVariableGetCall.html), [*containers variables list*](http://byron.github.io/google-apis-rs/google_tagmanager1/struct.AccountContainerVariableListCall.html), [*containers variables update*](http://byron.github.io/google-apis-rs/google_tagmanager1/struct.AccountContainerVariableUpdateCall.html), [*containers versions create*](http://byron.github.io/google-apis-rs/google_tagmanager1/struct.AccountContainerVersionCreateCall.html), [*containers versions delete*](http://byron.github.io/google-apis-rs/google_tagmanager1/struct.AccountContainerVersionDeleteCall.html), [*containers versions get*](http://byron.github.io/google-apis-rs/google_tagmanager1/struct.AccountContainerVersionGetCall.html), [*containers versions list*](http://byron.github.io/google-apis-rs/google_tagmanager1/struct.AccountContainerVersionListCall.html), [*containers versions publish*](http://byron.github.io/google-apis-rs/google_tagmanager1/struct.AccountContainerVersionPublishCall.html), [*containers versions restore*](http://byron.github.io/google-apis-rs/google_tagmanager1/struct.AccountContainerVersionRestoreCall.html), [*containers versions undelete*](http://byron.github.io/google-apis-rs/google_tagmanager1/struct.AccountContainerVersionUndeleteCall.html), [*containers versions update*](http://byron.github.io/google-apis-rs/google_tagmanager1/struct.AccountContainerVersionUpdateCall.html), [*get*](http://byron.github.io/google-apis-rs/google_tagmanager1/struct.AccountGetCall.html), [*list*](http://byron.github.io/google-apis-rs/google_tagmanager1/struct.AccountListCall.html), [*permissions create*](http://byron.github.io/google-apis-rs/google_tagmanager1/struct.AccountPermissionCreateCall.html), [*permissions delete*](http://byron.github.io/google-apis-rs/google_tagmanager1/struct.AccountPermissionDeleteCall.html), [*permissions get*](http://byron.github.io/google-apis-rs/google_tagmanager1/struct.AccountPermissionGetCall.html), [*permissions list*](http://byron.github.io/google-apis-rs/google_tagmanager1/struct.AccountPermissionListCall.html), [*permissions update*](http://byron.github.io/google-apis-rs/google_tagmanager1/struct.AccountPermissionUpdateCall.html) and [*update*](http://byron.github.io/google-apis-rs/google_tagmanager1/struct.AccountUpdateCall.html) @@ -23,17 +23,17 @@ Handle the following *Resources* with ease from the central [hub](http://byron.g The API is structured into the following primary items: -* **[Hub](http://byron.github.io/google-apis-rs/google-tagmanager1/struct.TagManager.html)** +* **[Hub](http://byron.github.io/google-apis-rs/google_tagmanager1/struct.TagManager.html)** * a central object to maintain state and allow accessing all *Activities* - * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google-tagmanager1/trait.MethodsBuilder.html) which in turn - allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google-tagmanager1/trait.CallBuilder.html) -* **[Resources](http://byron.github.io/google-apis-rs/google-tagmanager1/trait.Resource.html)** + * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google_tagmanager1/trait.MethodsBuilder.html) which in turn + allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google_tagmanager1/trait.CallBuilder.html) +* **[Resources](http://byron.github.io/google-apis-rs/google_tagmanager1/trait.Resource.html)** * primary types that you can apply *Activities* to * a collection of properties and *Parts* - * **[Parts](http://byron.github.io/google-apis-rs/google-tagmanager1/trait.Part.html)** + * **[Parts](http://byron.github.io/google-apis-rs/google_tagmanager1/trait.Part.html)** * a collection of properties * never directly used in *Activities* -* **[Activities](http://byron.github.io/google-apis-rs/google-tagmanager1/trait.CallBuilder.html)** +* **[Activities](http://byron.github.io/google-apis-rs/google_tagmanager1/trait.CallBuilder.html)** * operations to apply to *Resources* All *structures* are marked with applicable traits to further categorize them and ease browsing. @@ -164,17 +164,17 @@ match result { ``` ## Handling Errors -All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google-tagmanager1/enum.Result.html) enumeration as return value of +All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google_tagmanager1/enum.Result.html) enumeration as return value of the doit() methods, or handed as possibly intermediate results to either the -[Hub Delegate](http://byron.github.io/google-apis-rs/google-tagmanager1/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google-tagmanager1/../yup-oauth2/trait.AuthenticatorDelegate.html). +[Hub Delegate](http://byron.github.io/google-apis-rs/google_tagmanager1/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google_tagmanager1/../yup-oauth2/trait.AuthenticatorDelegate.html). 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](http://byron.github.io/google-apis-rs/google-tagmanager1/enum.Result.html), should be +If a method supports downloads, the response body, which is part of the [Result](http://byron.github.io/google-apis-rs/google_tagmanager1/enum.Result.html), should be read by you to obtain the media. -If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google-tagmanager1/trait.ResponseResult.html), it will return that by default. +If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google_tagmanager1/trait.ResponseResult.html), 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")`. @@ -184,29 +184,29 @@ Methods supporting uploads can do so using up to 2 different protocols: ## Customization and Callbacks -You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google-tagmanager1/trait.Delegate.html) to the -[Method Builder](http://byron.github.io/google-apis-rs/google-tagmanager1/trait.CallBuilder.html) before making the final `doit()` call. +You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google_tagmanager1/trait.Delegate.html) to the +[Method Builder](http://byron.github.io/google-apis-rs/google_tagmanager1/trait.CallBuilder.html) 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](http://byron.github.io/google-apis-rs/google-tagmanager1/trait.Delegate.html) is default-implemented, allowing you to customize it with minimal effort. +The [delegate trait](http://byron.github.io/google-apis-rs/google_tagmanager1/trait.Delegate.html) 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](http://byron.github.io/google-apis-rs/google-tagmanager1/trait.RequestValue.html) and -[decodable](http://byron.github.io/google-apis-rs/google-tagmanager1/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses +All structures provided by this library are made to be [enocodable](http://byron.github.io/google-apis-rs/google_tagmanager1/trait.RequestValue.html) and +[decodable](http://byron.github.io/google-apis-rs/google_tagmanager1/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses are valid. -Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google-tagmanager1/trait.Part.html) which are identifiable by name, which will be sent to +Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google_tagmanager1/trait.Part.html) 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](http://byron.github.io/google-apis-rs/google-tagmanager1/trait.CallBuilder.html), you are able to prepare an action call by repeatedly calling it's methods. +Using [method builders](http://byron.github.io/google-apis-rs/google_tagmanager1/trait.CallBuilder.html), 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][wiki-pod] are handed by copy * strings are passed as `&str` -* [request values](http://byron.github.io/google-apis-rs/google-tagmanager1/trait.RequestValue.html) are borrowed +* [request values](http://byron.github.io/google-apis-rs/google_tagmanager1/trait.RequestValue.html) are borrowed Arguments will always be copied or cloned into the builder, to make them independent of their original life times. diff --git a/gen/taskqueue1_beta2/README.md b/gen/taskqueue1_beta2/README.md index e3e3af9769..3503af17e5 100644 --- a/gen/taskqueue1_beta2/README.md +++ b/gen/taskqueue1_beta2/README.md @@ -11,12 +11,12 @@ Everything else about the *taskqueue* *v1_beta2* API can be found at the [official documentation site](https://developers.google.com/appengine/docs/python/taskqueue/rest). # Features -Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google-taskqueue1_beta2/struct.Taskqueue.html) ... +Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google_taskqueue1_beta2/struct.Taskqueue.html) ... * taskqueues - * [*get*](http://byron.github.io/google-apis-rs/google-taskqueue1_beta2/struct.TaskqueueGetCall.html) -* [tasks](http://byron.github.io/google-apis-rs/google-taskqueue1_beta2/struct.Task.html) - * [*delete*](http://byron.github.io/google-apis-rs/google-taskqueue1_beta2/struct.TaskDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google-taskqueue1_beta2/struct.TaskGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google-taskqueue1_beta2/struct.TaskInsertCall.html), [*lease*](http://byron.github.io/google-apis-rs/google-taskqueue1_beta2/struct.TaskLeaseCall.html), [*list*](http://byron.github.io/google-apis-rs/google-taskqueue1_beta2/struct.TaskListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google-taskqueue1_beta2/struct.TaskPatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google-taskqueue1_beta2/struct.TaskUpdateCall.html) + * [*get*](http://byron.github.io/google-apis-rs/google_taskqueue1_beta2/struct.TaskqueueGetCall.html) +* [tasks](http://byron.github.io/google-apis-rs/google_taskqueue1_beta2/struct.Task.html) + * [*delete*](http://byron.github.io/google-apis-rs/google_taskqueue1_beta2/struct.TaskDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google_taskqueue1_beta2/struct.TaskGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google_taskqueue1_beta2/struct.TaskInsertCall.html), [*lease*](http://byron.github.io/google-apis-rs/google_taskqueue1_beta2/struct.TaskLeaseCall.html), [*list*](http://byron.github.io/google-apis-rs/google_taskqueue1_beta2/struct.TaskListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google_taskqueue1_beta2/struct.TaskPatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google_taskqueue1_beta2/struct.TaskUpdateCall.html) @@ -25,17 +25,17 @@ Handle the following *Resources* with ease from the central [hub](http://byron.g The API is structured into the following primary items: -* **[Hub](http://byron.github.io/google-apis-rs/google-taskqueue1_beta2/struct.Taskqueue.html)** +* **[Hub](http://byron.github.io/google-apis-rs/google_taskqueue1_beta2/struct.Taskqueue.html)** * a central object to maintain state and allow accessing all *Activities* - * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google-taskqueue1_beta2/trait.MethodsBuilder.html) which in turn - allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google-taskqueue1_beta2/trait.CallBuilder.html) -* **[Resources](http://byron.github.io/google-apis-rs/google-taskqueue1_beta2/trait.Resource.html)** + * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google_taskqueue1_beta2/trait.MethodsBuilder.html) which in turn + allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google_taskqueue1_beta2/trait.CallBuilder.html) +* **[Resources](http://byron.github.io/google-apis-rs/google_taskqueue1_beta2/trait.Resource.html)** * primary types that you can apply *Activities* to * a collection of properties and *Parts* - * **[Parts](http://byron.github.io/google-apis-rs/google-taskqueue1_beta2/trait.Part.html)** + * **[Parts](http://byron.github.io/google-apis-rs/google_taskqueue1_beta2/trait.Part.html)** * a collection of properties * never directly used in *Activities* -* **[Activities](http://byron.github.io/google-apis-rs/google-taskqueue1_beta2/trait.CallBuilder.html)** +* **[Activities](http://byron.github.io/google-apis-rs/google_taskqueue1_beta2/trait.CallBuilder.html)** * operations to apply to *Resources* All *structures* are marked with applicable traits to further categorize them and ease browsing. @@ -122,17 +122,17 @@ match result { ``` ## Handling Errors -All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google-taskqueue1_beta2/enum.Result.html) enumeration as return value of +All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google_taskqueue1_beta2/enum.Result.html) enumeration as return value of the doit() methods, or handed as possibly intermediate results to either the -[Hub Delegate](http://byron.github.io/google-apis-rs/google-taskqueue1_beta2/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google-taskqueue1_beta2/../yup-oauth2/trait.AuthenticatorDelegate.html). +[Hub Delegate](http://byron.github.io/google-apis-rs/google_taskqueue1_beta2/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google_taskqueue1_beta2/../yup-oauth2/trait.AuthenticatorDelegate.html). 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](http://byron.github.io/google-apis-rs/google-taskqueue1_beta2/enum.Result.html), should be +If a method supports downloads, the response body, which is part of the [Result](http://byron.github.io/google-apis-rs/google_taskqueue1_beta2/enum.Result.html), should be read by you to obtain the media. -If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google-taskqueue1_beta2/trait.ResponseResult.html), it will return that by default. +If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google_taskqueue1_beta2/trait.ResponseResult.html), 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")`. @@ -142,29 +142,29 @@ Methods supporting uploads can do so using up to 2 different protocols: ## Customization and Callbacks -You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google-taskqueue1_beta2/trait.Delegate.html) to the -[Method Builder](http://byron.github.io/google-apis-rs/google-taskqueue1_beta2/trait.CallBuilder.html) before making the final `doit()` call. +You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google_taskqueue1_beta2/trait.Delegate.html) to the +[Method Builder](http://byron.github.io/google-apis-rs/google_taskqueue1_beta2/trait.CallBuilder.html) 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](http://byron.github.io/google-apis-rs/google-taskqueue1_beta2/trait.Delegate.html) is default-implemented, allowing you to customize it with minimal effort. +The [delegate trait](http://byron.github.io/google-apis-rs/google_taskqueue1_beta2/trait.Delegate.html) 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](http://byron.github.io/google-apis-rs/google-taskqueue1_beta2/trait.RequestValue.html) and -[decodable](http://byron.github.io/google-apis-rs/google-taskqueue1_beta2/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses +All structures provided by this library are made to be [enocodable](http://byron.github.io/google-apis-rs/google_taskqueue1_beta2/trait.RequestValue.html) and +[decodable](http://byron.github.io/google-apis-rs/google_taskqueue1_beta2/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses are valid. -Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google-taskqueue1_beta2/trait.Part.html) which are identifiable by name, which will be sent to +Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google_taskqueue1_beta2/trait.Part.html) 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](http://byron.github.io/google-apis-rs/google-taskqueue1_beta2/trait.CallBuilder.html), you are able to prepare an action call by repeatedly calling it's methods. +Using [method builders](http://byron.github.io/google-apis-rs/google_taskqueue1_beta2/trait.CallBuilder.html), 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][wiki-pod] are handed by copy * strings are passed as `&str` -* [request values](http://byron.github.io/google-apis-rs/google-taskqueue1_beta2/trait.RequestValue.html) are borrowed +* [request values](http://byron.github.io/google-apis-rs/google_taskqueue1_beta2/trait.RequestValue.html) are borrowed Arguments will always be copied or cloned into the builder, to make them independent of their original life times. diff --git a/gen/tasks1/README.md b/gen/tasks1/README.md index 0fdbfb3600..8ed2a52186 100644 --- a/gen/tasks1/README.md +++ b/gen/tasks1/README.md @@ -11,12 +11,12 @@ Everything else about the *tasks* *v1* API can be found at the [official documentation site](https://developers.google.com/google-apps/tasks/firstapp). # Features -Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google-tasks1/struct.TasksHub.html) ... +Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google_tasks1/struct.TasksHub.html) ... * tasklists - * [*delete*](http://byron.github.io/google-apis-rs/google-tasks1/struct.TasklistDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google-tasks1/struct.TasklistGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google-tasks1/struct.TasklistInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google-tasks1/struct.TasklistListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google-tasks1/struct.TasklistPatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google-tasks1/struct.TasklistUpdateCall.html) -* [tasks](http://byron.github.io/google-apis-rs/google-tasks1/struct.Task.html) - * [*clear*](http://byron.github.io/google-apis-rs/google-tasks1/struct.TaskClearCall.html), [*delete*](http://byron.github.io/google-apis-rs/google-tasks1/struct.TaskDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google-tasks1/struct.TaskGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google-tasks1/struct.TaskInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google-tasks1/struct.TaskListCall.html), [*move*](http://byron.github.io/google-apis-rs/google-tasks1/struct.TaskMoveCall.html), [*patch*](http://byron.github.io/google-apis-rs/google-tasks1/struct.TaskPatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google-tasks1/struct.TaskUpdateCall.html) + * [*delete*](http://byron.github.io/google-apis-rs/google_tasks1/struct.TasklistDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google_tasks1/struct.TasklistGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google_tasks1/struct.TasklistInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google_tasks1/struct.TasklistListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google_tasks1/struct.TasklistPatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google_tasks1/struct.TasklistUpdateCall.html) +* [tasks](http://byron.github.io/google-apis-rs/google_tasks1/struct.Task.html) + * [*clear*](http://byron.github.io/google-apis-rs/google_tasks1/struct.TaskClearCall.html), [*delete*](http://byron.github.io/google-apis-rs/google_tasks1/struct.TaskDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google_tasks1/struct.TaskGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google_tasks1/struct.TaskInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google_tasks1/struct.TaskListCall.html), [*move*](http://byron.github.io/google-apis-rs/google_tasks1/struct.TaskMoveCall.html), [*patch*](http://byron.github.io/google-apis-rs/google_tasks1/struct.TaskPatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google_tasks1/struct.TaskUpdateCall.html) @@ -25,17 +25,17 @@ Handle the following *Resources* with ease from the central [hub](http://byron.g The API is structured into the following primary items: -* **[Hub](http://byron.github.io/google-apis-rs/google-tasks1/struct.TasksHub.html)** +* **[Hub](http://byron.github.io/google-apis-rs/google_tasks1/struct.TasksHub.html)** * a central object to maintain state and allow accessing all *Activities* - * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google-tasks1/trait.MethodsBuilder.html) which in turn - allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google-tasks1/trait.CallBuilder.html) -* **[Resources](http://byron.github.io/google-apis-rs/google-tasks1/trait.Resource.html)** + * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google_tasks1/trait.MethodsBuilder.html) which in turn + allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google_tasks1/trait.CallBuilder.html) +* **[Resources](http://byron.github.io/google-apis-rs/google_tasks1/trait.Resource.html)** * primary types that you can apply *Activities* to * a collection of properties and *Parts* - * **[Parts](http://byron.github.io/google-apis-rs/google-tasks1/trait.Part.html)** + * **[Parts](http://byron.github.io/google-apis-rs/google_tasks1/trait.Part.html)** * a collection of properties * never directly used in *Activities* -* **[Activities](http://byron.github.io/google-apis-rs/google-tasks1/trait.CallBuilder.html)** +* **[Activities](http://byron.github.io/google-apis-rs/google_tasks1/trait.CallBuilder.html)** * operations to apply to *Resources* All *structures* are marked with applicable traits to further categorize them and ease browsing. @@ -131,17 +131,17 @@ match result { ``` ## Handling Errors -All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google-tasks1/enum.Result.html) enumeration as return value of +All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google_tasks1/enum.Result.html) enumeration as return value of the doit() methods, or handed as possibly intermediate results to either the -[Hub Delegate](http://byron.github.io/google-apis-rs/google-tasks1/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google-tasks1/../yup-oauth2/trait.AuthenticatorDelegate.html). +[Hub Delegate](http://byron.github.io/google-apis-rs/google_tasks1/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google_tasks1/../yup-oauth2/trait.AuthenticatorDelegate.html). 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](http://byron.github.io/google-apis-rs/google-tasks1/enum.Result.html), should be +If a method supports downloads, the response body, which is part of the [Result](http://byron.github.io/google-apis-rs/google_tasks1/enum.Result.html), should be read by you to obtain the media. -If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google-tasks1/trait.ResponseResult.html), it will return that by default. +If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google_tasks1/trait.ResponseResult.html), 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")`. @@ -151,29 +151,29 @@ Methods supporting uploads can do so using up to 2 different protocols: ## Customization and Callbacks -You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google-tasks1/trait.Delegate.html) to the -[Method Builder](http://byron.github.io/google-apis-rs/google-tasks1/trait.CallBuilder.html) before making the final `doit()` call. +You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google_tasks1/trait.Delegate.html) to the +[Method Builder](http://byron.github.io/google-apis-rs/google_tasks1/trait.CallBuilder.html) 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](http://byron.github.io/google-apis-rs/google-tasks1/trait.Delegate.html) is default-implemented, allowing you to customize it with minimal effort. +The [delegate trait](http://byron.github.io/google-apis-rs/google_tasks1/trait.Delegate.html) 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](http://byron.github.io/google-apis-rs/google-tasks1/trait.RequestValue.html) and -[decodable](http://byron.github.io/google-apis-rs/google-tasks1/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses +All structures provided by this library are made to be [enocodable](http://byron.github.io/google-apis-rs/google_tasks1/trait.RequestValue.html) and +[decodable](http://byron.github.io/google-apis-rs/google_tasks1/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses are valid. -Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google-tasks1/trait.Part.html) which are identifiable by name, which will be sent to +Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google_tasks1/trait.Part.html) 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](http://byron.github.io/google-apis-rs/google-tasks1/trait.CallBuilder.html), you are able to prepare an action call by repeatedly calling it's methods. +Using [method builders](http://byron.github.io/google-apis-rs/google_tasks1/trait.CallBuilder.html), 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][wiki-pod] are handed by copy * strings are passed as `&str` -* [request values](http://byron.github.io/google-apis-rs/google-tasks1/trait.RequestValue.html) are borrowed +* [request values](http://byron.github.io/google-apis-rs/google_tasks1/trait.RequestValue.html) are borrowed Arguments will always be copied or cloned into the builder, to make them independent of their original life times. diff --git a/gen/translate2/README.md b/gen/translate2/README.md index 0970f615e4..36fd2f2ac9 100644 --- a/gen/translate2/README.md +++ b/gen/translate2/README.md @@ -11,14 +11,14 @@ Everything else about the *translate* *v2* API can be found at the [official documentation site](https://developers.google.com/translate/v2/using_rest). # Features -Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google-translate2/struct.Translate.html) ... +Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google_translate2/struct.Translate.html) ... * detections - * [*list*](http://byron.github.io/google-apis-rs/google-translate2/struct.DetectionListCall.html) + * [*list*](http://byron.github.io/google-apis-rs/google_translate2/struct.DetectionListCall.html) * languages - * [*list*](http://byron.github.io/google-apis-rs/google-translate2/struct.LanguageListCall.html) + * [*list*](http://byron.github.io/google-apis-rs/google_translate2/struct.LanguageListCall.html) * translations - * [*list*](http://byron.github.io/google-apis-rs/google-translate2/struct.TranslationListCall.html) + * [*list*](http://byron.github.io/google-apis-rs/google_translate2/struct.TranslationListCall.html) @@ -27,17 +27,17 @@ Handle the following *Resources* with ease from the central [hub](http://byron.g The API is structured into the following primary items: -* **[Hub](http://byron.github.io/google-apis-rs/google-translate2/struct.Translate.html)** +* **[Hub](http://byron.github.io/google-apis-rs/google_translate2/struct.Translate.html)** * a central object to maintain state and allow accessing all *Activities* - * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google-translate2/trait.MethodsBuilder.html) which in turn - allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google-translate2/trait.CallBuilder.html) -* **[Resources](http://byron.github.io/google-apis-rs/google-translate2/trait.Resource.html)** + * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google_translate2/trait.MethodsBuilder.html) which in turn + allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google_translate2/trait.CallBuilder.html) +* **[Resources](http://byron.github.io/google-apis-rs/google_translate2/trait.Resource.html)** * primary types that you can apply *Activities* to * a collection of properties and *Parts* - * **[Parts](http://byron.github.io/google-apis-rs/google-translate2/trait.Part.html)** + * **[Parts](http://byron.github.io/google-apis-rs/google_translate2/trait.Part.html)** * a collection of properties * never directly used in *Activities* -* **[Activities](http://byron.github.io/google-apis-rs/google-translate2/trait.CallBuilder.html)** +* **[Activities](http://byron.github.io/google-apis-rs/google_translate2/trait.CallBuilder.html)** * operations to apply to *Resources* All *structures* are marked with applicable traits to further categorize them and ease browsing. @@ -116,17 +116,17 @@ match result { ``` ## Handling Errors -All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google-translate2/enum.Result.html) enumeration as return value of +All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google_translate2/enum.Result.html) enumeration as return value of the doit() methods, or handed as possibly intermediate results to either the -[Hub Delegate](http://byron.github.io/google-apis-rs/google-translate2/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google-translate2/../yup-oauth2/trait.AuthenticatorDelegate.html). +[Hub Delegate](http://byron.github.io/google-apis-rs/google_translate2/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google_translate2/../yup-oauth2/trait.AuthenticatorDelegate.html). 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](http://byron.github.io/google-apis-rs/google-translate2/enum.Result.html), should be +If a method supports downloads, the response body, which is part of the [Result](http://byron.github.io/google-apis-rs/google_translate2/enum.Result.html), should be read by you to obtain the media. -If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google-translate2/trait.ResponseResult.html), it will return that by default. +If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google_translate2/trait.ResponseResult.html), 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")`. @@ -136,29 +136,29 @@ Methods supporting uploads can do so using up to 2 different protocols: ## Customization and Callbacks -You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google-translate2/trait.Delegate.html) to the -[Method Builder](http://byron.github.io/google-apis-rs/google-translate2/trait.CallBuilder.html) before making the final `doit()` call. +You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google_translate2/trait.Delegate.html) to the +[Method Builder](http://byron.github.io/google-apis-rs/google_translate2/trait.CallBuilder.html) 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](http://byron.github.io/google-apis-rs/google-translate2/trait.Delegate.html) is default-implemented, allowing you to customize it with minimal effort. +The [delegate trait](http://byron.github.io/google-apis-rs/google_translate2/trait.Delegate.html) 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](http://byron.github.io/google-apis-rs/google-translate2/trait.RequestValue.html) and -[decodable](http://byron.github.io/google-apis-rs/google-translate2/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses +All structures provided by this library are made to be [enocodable](http://byron.github.io/google-apis-rs/google_translate2/trait.RequestValue.html) and +[decodable](http://byron.github.io/google-apis-rs/google_translate2/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses are valid. -Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google-translate2/trait.Part.html) which are identifiable by name, which will be sent to +Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google_translate2/trait.Part.html) 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](http://byron.github.io/google-apis-rs/google-translate2/trait.CallBuilder.html), you are able to prepare an action call by repeatedly calling it's methods. +Using [method builders](http://byron.github.io/google-apis-rs/google_translate2/trait.CallBuilder.html), 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][wiki-pod] are handed by copy * strings are passed as `&str` -* [request values](http://byron.github.io/google-apis-rs/google-translate2/trait.RequestValue.html) are borrowed +* [request values](http://byron.github.io/google-apis-rs/google_translate2/trait.RequestValue.html) are borrowed Arguments will always be copied or cloned into the builder, to make them independent of their original life times. diff --git a/gen/urlshortener1/README.md b/gen/urlshortener1/README.md index 5b8fe53df9..24fb5c49bb 100644 --- a/gen/urlshortener1/README.md +++ b/gen/urlshortener1/README.md @@ -11,10 +11,10 @@ Everything else about the *urlshortener* *v1* API can be found at the [official documentation site](https://developers.google.com/url-shortener/v1/getting_started). # Features -Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google-urlshortener1/struct.Urlshortener.html) ... +Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google_urlshortener1/struct.Urlshortener.html) ... -* [url](http://byron.github.io/google-apis-rs/google-urlshortener1/struct.Url.html) - * [*get*](http://byron.github.io/google-apis-rs/google-urlshortener1/struct.UrlGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google-urlshortener1/struct.UrlInsertCall.html) and [*list*](http://byron.github.io/google-apis-rs/google-urlshortener1/struct.UrlListCall.html) +* [url](http://byron.github.io/google-apis-rs/google_urlshortener1/struct.Url.html) + * [*get*](http://byron.github.io/google-apis-rs/google_urlshortener1/struct.UrlGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google_urlshortener1/struct.UrlInsertCall.html) and [*list*](http://byron.github.io/google-apis-rs/google_urlshortener1/struct.UrlListCall.html) @@ -23,17 +23,17 @@ Handle the following *Resources* with ease from the central [hub](http://byron.g The API is structured into the following primary items: -* **[Hub](http://byron.github.io/google-apis-rs/google-urlshortener1/struct.Urlshortener.html)** +* **[Hub](http://byron.github.io/google-apis-rs/google_urlshortener1/struct.Urlshortener.html)** * a central object to maintain state and allow accessing all *Activities* - * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google-urlshortener1/trait.MethodsBuilder.html) which in turn - allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google-urlshortener1/trait.CallBuilder.html) -* **[Resources](http://byron.github.io/google-apis-rs/google-urlshortener1/trait.Resource.html)** + * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google_urlshortener1/trait.MethodsBuilder.html) which in turn + allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google_urlshortener1/trait.CallBuilder.html) +* **[Resources](http://byron.github.io/google-apis-rs/google_urlshortener1/trait.Resource.html)** * primary types that you can apply *Activities* to * a collection of properties and *Parts* - * **[Parts](http://byron.github.io/google-apis-rs/google-urlshortener1/trait.Part.html)** + * **[Parts](http://byron.github.io/google-apis-rs/google_urlshortener1/trait.Part.html)** * a collection of properties * never directly used in *Activities* -* **[Activities](http://byron.github.io/google-apis-rs/google-urlshortener1/trait.CallBuilder.html)** +* **[Activities](http://byron.github.io/google-apis-rs/google_urlshortener1/trait.CallBuilder.html)** * operations to apply to *Resources* All *structures* are marked with applicable traits to further categorize them and ease browsing. @@ -114,17 +114,17 @@ match result { ``` ## Handling Errors -All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google-urlshortener1/enum.Result.html) enumeration as return value of +All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google_urlshortener1/enum.Result.html) enumeration as return value of the doit() methods, or handed as possibly intermediate results to either the -[Hub Delegate](http://byron.github.io/google-apis-rs/google-urlshortener1/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google-urlshortener1/../yup-oauth2/trait.AuthenticatorDelegate.html). +[Hub Delegate](http://byron.github.io/google-apis-rs/google_urlshortener1/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google_urlshortener1/../yup-oauth2/trait.AuthenticatorDelegate.html). 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](http://byron.github.io/google-apis-rs/google-urlshortener1/enum.Result.html), should be +If a method supports downloads, the response body, which is part of the [Result](http://byron.github.io/google-apis-rs/google_urlshortener1/enum.Result.html), should be read by you to obtain the media. -If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google-urlshortener1/trait.ResponseResult.html), it will return that by default. +If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google_urlshortener1/trait.ResponseResult.html), 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")`. @@ -134,29 +134,29 @@ Methods supporting uploads can do so using up to 2 different protocols: ## Customization and Callbacks -You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google-urlshortener1/trait.Delegate.html) to the -[Method Builder](http://byron.github.io/google-apis-rs/google-urlshortener1/trait.CallBuilder.html) before making the final `doit()` call. +You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google_urlshortener1/trait.Delegate.html) to the +[Method Builder](http://byron.github.io/google-apis-rs/google_urlshortener1/trait.CallBuilder.html) 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](http://byron.github.io/google-apis-rs/google-urlshortener1/trait.Delegate.html) is default-implemented, allowing you to customize it with minimal effort. +The [delegate trait](http://byron.github.io/google-apis-rs/google_urlshortener1/trait.Delegate.html) 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](http://byron.github.io/google-apis-rs/google-urlshortener1/trait.RequestValue.html) and -[decodable](http://byron.github.io/google-apis-rs/google-urlshortener1/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses +All structures provided by this library are made to be [enocodable](http://byron.github.io/google-apis-rs/google_urlshortener1/trait.RequestValue.html) and +[decodable](http://byron.github.io/google-apis-rs/google_urlshortener1/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses are valid. -Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google-urlshortener1/trait.Part.html) which are identifiable by name, which will be sent to +Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google_urlshortener1/trait.Part.html) 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](http://byron.github.io/google-apis-rs/google-urlshortener1/trait.CallBuilder.html), you are able to prepare an action call by repeatedly calling it's methods. +Using [method builders](http://byron.github.io/google-apis-rs/google_urlshortener1/trait.CallBuilder.html), 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][wiki-pod] are handed by copy * strings are passed as `&str` -* [request values](http://byron.github.io/google-apis-rs/google-urlshortener1/trait.RequestValue.html) are borrowed +* [request values](http://byron.github.io/google-apis-rs/google_urlshortener1/trait.RequestValue.html) are borrowed Arguments will always be copied or cloned into the builder, to make them independent of their original life times. diff --git a/gen/webfonts1/README.md b/gen/webfonts1/README.md index 207b0cd9dc..3c21e4ba32 100644 --- a/gen/webfonts1/README.md +++ b/gen/webfonts1/README.md @@ -11,10 +11,10 @@ Everything else about the *webfonts* *v1* API can be found at the [official documentation site](https://developers.google.com/fonts/docs/developer_api). # Features -Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google-webfonts1/struct.Webfonts.html) ... +Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google_webfonts1/struct.Webfonts.html) ... -* [webfonts](http://byron.github.io/google-apis-rs/google-webfonts1/struct.Webfont.html) - * [*list*](http://byron.github.io/google-apis-rs/google-webfonts1/struct.WebfontListCall.html) +* [webfonts](http://byron.github.io/google-apis-rs/google_webfonts1/struct.Webfont.html) + * [*list*](http://byron.github.io/google-apis-rs/google_webfonts1/struct.WebfontListCall.html) @@ -23,17 +23,17 @@ Handle the following *Resources* with ease from the central [hub](http://byron.g The API is structured into the following primary items: -* **[Hub](http://byron.github.io/google-apis-rs/google-webfonts1/struct.Webfonts.html)** +* **[Hub](http://byron.github.io/google-apis-rs/google_webfonts1/struct.Webfonts.html)** * a central object to maintain state and allow accessing all *Activities* - * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google-webfonts1/trait.MethodsBuilder.html) which in turn - allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google-webfonts1/trait.CallBuilder.html) -* **[Resources](http://byron.github.io/google-apis-rs/google-webfonts1/trait.Resource.html)** + * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google_webfonts1/trait.MethodsBuilder.html) which in turn + allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google_webfonts1/trait.CallBuilder.html) +* **[Resources](http://byron.github.io/google-apis-rs/google_webfonts1/trait.Resource.html)** * primary types that you can apply *Activities* to * a collection of properties and *Parts* - * **[Parts](http://byron.github.io/google-apis-rs/google-webfonts1/trait.Part.html)** + * **[Parts](http://byron.github.io/google-apis-rs/google_webfonts1/trait.Part.html)** * a collection of properties * never directly used in *Activities* -* **[Activities](http://byron.github.io/google-apis-rs/google-webfonts1/trait.CallBuilder.html)** +* **[Activities](http://byron.github.io/google-apis-rs/google_webfonts1/trait.CallBuilder.html)** * operations to apply to *Resources* All *structures* are marked with applicable traits to further categorize them and ease browsing. @@ -113,17 +113,17 @@ match result { ``` ## Handling Errors -All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google-webfonts1/enum.Result.html) enumeration as return value of +All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google_webfonts1/enum.Result.html) enumeration as return value of the doit() methods, or handed as possibly intermediate results to either the -[Hub Delegate](http://byron.github.io/google-apis-rs/google-webfonts1/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google-webfonts1/../yup-oauth2/trait.AuthenticatorDelegate.html). +[Hub Delegate](http://byron.github.io/google-apis-rs/google_webfonts1/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google_webfonts1/../yup-oauth2/trait.AuthenticatorDelegate.html). 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](http://byron.github.io/google-apis-rs/google-webfonts1/enum.Result.html), should be +If a method supports downloads, the response body, which is part of the [Result](http://byron.github.io/google-apis-rs/google_webfonts1/enum.Result.html), should be read by you to obtain the media. -If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google-webfonts1/trait.ResponseResult.html), it will return that by default. +If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google_webfonts1/trait.ResponseResult.html), 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")`. @@ -133,29 +133,29 @@ Methods supporting uploads can do so using up to 2 different protocols: ## Customization and Callbacks -You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google-webfonts1/trait.Delegate.html) to the -[Method Builder](http://byron.github.io/google-apis-rs/google-webfonts1/trait.CallBuilder.html) before making the final `doit()` call. +You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google_webfonts1/trait.Delegate.html) to the +[Method Builder](http://byron.github.io/google-apis-rs/google_webfonts1/trait.CallBuilder.html) 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](http://byron.github.io/google-apis-rs/google-webfonts1/trait.Delegate.html) is default-implemented, allowing you to customize it with minimal effort. +The [delegate trait](http://byron.github.io/google-apis-rs/google_webfonts1/trait.Delegate.html) 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](http://byron.github.io/google-apis-rs/google-webfonts1/trait.RequestValue.html) and -[decodable](http://byron.github.io/google-apis-rs/google-webfonts1/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses +All structures provided by this library are made to be [enocodable](http://byron.github.io/google-apis-rs/google_webfonts1/trait.RequestValue.html) and +[decodable](http://byron.github.io/google-apis-rs/google_webfonts1/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses are valid. -Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google-webfonts1/trait.Part.html) which are identifiable by name, which will be sent to +Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google_webfonts1/trait.Part.html) 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](http://byron.github.io/google-apis-rs/google-webfonts1/trait.CallBuilder.html), you are able to prepare an action call by repeatedly calling it's methods. +Using [method builders](http://byron.github.io/google-apis-rs/google_webfonts1/trait.CallBuilder.html), 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][wiki-pod] are handed by copy * strings are passed as `&str` -* [request values](http://byron.github.io/google-apis-rs/google-webfonts1/trait.RequestValue.html) are borrowed +* [request values](http://byron.github.io/google-apis-rs/google_webfonts1/trait.RequestValue.html) are borrowed Arguments will always be copied or cloned into the builder, to make them independent of their original life times. diff --git a/gen/webmasters3/README.md b/gen/webmasters3/README.md index d47b9b8097..309e2bf0f1 100644 --- a/gen/webmasters3/README.md +++ b/gen/webmasters3/README.md @@ -11,16 +11,16 @@ Everything else about the *webmasters* *v3* API can be found at the [official documentation site](https://developers.google.com/webmaster-tools/v3/welcome). # Features -Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google-webmasters3/struct.Webmasters.html) ... +Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google_webmasters3/struct.Webmasters.html) ... * sitemaps - * [*delete*](http://byron.github.io/google-apis-rs/google-webmasters3/struct.SitemapDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google-webmasters3/struct.SitemapGetCall.html), [*list*](http://byron.github.io/google-apis-rs/google-webmasters3/struct.SitemapListCall.html) and [*submit*](http://byron.github.io/google-apis-rs/google-webmasters3/struct.SitemapSubmitCall.html) + * [*delete*](http://byron.github.io/google-apis-rs/google_webmasters3/struct.SitemapDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google_webmasters3/struct.SitemapGetCall.html), [*list*](http://byron.github.io/google-apis-rs/google_webmasters3/struct.SitemapListCall.html) and [*submit*](http://byron.github.io/google-apis-rs/google_webmasters3/struct.SitemapSubmitCall.html) * sites - * [*add*](http://byron.github.io/google-apis-rs/google-webmasters3/struct.SiteAddCall.html), [*delete*](http://byron.github.io/google-apis-rs/google-webmasters3/struct.SiteDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google-webmasters3/struct.SiteGetCall.html) and [*list*](http://byron.github.io/google-apis-rs/google-webmasters3/struct.SiteListCall.html) + * [*add*](http://byron.github.io/google-apis-rs/google_webmasters3/struct.SiteAddCall.html), [*delete*](http://byron.github.io/google-apis-rs/google_webmasters3/struct.SiteDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google_webmasters3/struct.SiteGetCall.html) and [*list*](http://byron.github.io/google-apis-rs/google_webmasters3/struct.SiteListCall.html) * urlcrawlerrorscounts - * [*query*](http://byron.github.io/google-apis-rs/google-webmasters3/struct.UrlcrawlerrorscountQueryCall.html) + * [*query*](http://byron.github.io/google-apis-rs/google_webmasters3/struct.UrlcrawlerrorscountQueryCall.html) * urlcrawlerrorssamples - * [*get*](http://byron.github.io/google-apis-rs/google-webmasters3/struct.UrlcrawlerrorssampleGetCall.html), [*list*](http://byron.github.io/google-apis-rs/google-webmasters3/struct.UrlcrawlerrorssampleListCall.html) and [*mark as fixed*](http://byron.github.io/google-apis-rs/google-webmasters3/struct.UrlcrawlerrorssampleMarkAsFixedCall.html) + * [*get*](http://byron.github.io/google-apis-rs/google_webmasters3/struct.UrlcrawlerrorssampleGetCall.html), [*list*](http://byron.github.io/google-apis-rs/google_webmasters3/struct.UrlcrawlerrorssampleListCall.html) and [*mark as fixed*](http://byron.github.io/google-apis-rs/google_webmasters3/struct.UrlcrawlerrorssampleMarkAsFixedCall.html) @@ -29,17 +29,17 @@ Handle the following *Resources* with ease from the central [hub](http://byron.g The API is structured into the following primary items: -* **[Hub](http://byron.github.io/google-apis-rs/google-webmasters3/struct.Webmasters.html)** +* **[Hub](http://byron.github.io/google-apis-rs/google_webmasters3/struct.Webmasters.html)** * a central object to maintain state and allow accessing all *Activities* - * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google-webmasters3/trait.MethodsBuilder.html) which in turn - allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google-webmasters3/trait.CallBuilder.html) -* **[Resources](http://byron.github.io/google-apis-rs/google-webmasters3/trait.Resource.html)** + * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google_webmasters3/trait.MethodsBuilder.html) which in turn + allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google_webmasters3/trait.CallBuilder.html) +* **[Resources](http://byron.github.io/google-apis-rs/google_webmasters3/trait.Resource.html)** * primary types that you can apply *Activities* to * a collection of properties and *Parts* - * **[Parts](http://byron.github.io/google-apis-rs/google-webmasters3/trait.Part.html)** + * **[Parts](http://byron.github.io/google-apis-rs/google_webmasters3/trait.Part.html)** * a collection of properties * never directly used in *Activities* -* **[Activities](http://byron.github.io/google-apis-rs/google-webmasters3/trait.CallBuilder.html)** +* **[Activities](http://byron.github.io/google-apis-rs/google_webmasters3/trait.CallBuilder.html)** * operations to apply to *Resources* All *structures* are marked with applicable traits to further categorize them and ease browsing. @@ -118,17 +118,17 @@ match result { ``` ## Handling Errors -All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google-webmasters3/enum.Result.html) enumeration as return value of +All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google_webmasters3/enum.Result.html) enumeration as return value of the doit() methods, or handed as possibly intermediate results to either the -[Hub Delegate](http://byron.github.io/google-apis-rs/google-webmasters3/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google-webmasters3/../yup-oauth2/trait.AuthenticatorDelegate.html). +[Hub Delegate](http://byron.github.io/google-apis-rs/google_webmasters3/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google_webmasters3/../yup-oauth2/trait.AuthenticatorDelegate.html). 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](http://byron.github.io/google-apis-rs/google-webmasters3/enum.Result.html), should be +If a method supports downloads, the response body, which is part of the [Result](http://byron.github.io/google-apis-rs/google_webmasters3/enum.Result.html), should be read by you to obtain the media. -If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google-webmasters3/trait.ResponseResult.html), it will return that by default. +If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google_webmasters3/trait.ResponseResult.html), 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")`. @@ -138,29 +138,29 @@ Methods supporting uploads can do so using up to 2 different protocols: ## Customization and Callbacks -You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google-webmasters3/trait.Delegate.html) to the -[Method Builder](http://byron.github.io/google-apis-rs/google-webmasters3/trait.CallBuilder.html) before making the final `doit()` call. +You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google_webmasters3/trait.Delegate.html) to the +[Method Builder](http://byron.github.io/google-apis-rs/google_webmasters3/trait.CallBuilder.html) 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](http://byron.github.io/google-apis-rs/google-webmasters3/trait.Delegate.html) is default-implemented, allowing you to customize it with minimal effort. +The [delegate trait](http://byron.github.io/google-apis-rs/google_webmasters3/trait.Delegate.html) 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](http://byron.github.io/google-apis-rs/google-webmasters3/trait.RequestValue.html) and -[decodable](http://byron.github.io/google-apis-rs/google-webmasters3/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses +All structures provided by this library are made to be [enocodable](http://byron.github.io/google-apis-rs/google_webmasters3/trait.RequestValue.html) and +[decodable](http://byron.github.io/google-apis-rs/google_webmasters3/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses are valid. -Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google-webmasters3/trait.Part.html) which are identifiable by name, which will be sent to +Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google_webmasters3/trait.Part.html) 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](http://byron.github.io/google-apis-rs/google-webmasters3/trait.CallBuilder.html), you are able to prepare an action call by repeatedly calling it's methods. +Using [method builders](http://byron.github.io/google-apis-rs/google_webmasters3/trait.CallBuilder.html), 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][wiki-pod] are handed by copy * strings are passed as `&str` -* [request values](http://byron.github.io/google-apis-rs/google-webmasters3/trait.RequestValue.html) are borrowed +* [request values](http://byron.github.io/google-apis-rs/google_webmasters3/trait.RequestValue.html) are borrowed Arguments will always be copied or cloned into the builder, to make them independent of their original life times. diff --git a/gen/youtube3/README.md b/gen/youtube3/README.md index 30cb955471..d36473e146 100644 --- a/gen/youtube3/README.md +++ b/gen/youtube3/README.md @@ -11,62 +11,62 @@ Everything else about the *YouTube* *v3* API can be found at the [official documentation site](https://developers.google.com/youtube/v3). # Features -Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google-youtube3/struct.YouTube.html) ... +Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google_youtube3/struct.YouTube.html) ... -* [activities](http://byron.github.io/google-apis-rs/google-youtube3/struct.Activity.html) - * [*insert*](http://byron.github.io/google-apis-rs/google-youtube3/struct.ActivityInsertCall.html) and [*list*](http://byron.github.io/google-apis-rs/google-youtube3/struct.ActivityListCall.html) -* [captions](http://byron.github.io/google-apis-rs/google-youtube3/struct.Caption.html) - * [*delete*](http://byron.github.io/google-apis-rs/google-youtube3/struct.CaptionDeleteCall.html), [*download*](http://byron.github.io/google-apis-rs/google-youtube3/struct.CaptionDownloadCall.html), [*insert*](http://byron.github.io/google-apis-rs/google-youtube3/struct.CaptionInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google-youtube3/struct.CaptionListCall.html) and [*update*](http://byron.github.io/google-apis-rs/google-youtube3/struct.CaptionUpdateCall.html) +* [activities](http://byron.github.io/google-apis-rs/google_youtube3/struct.Activity.html) + * [*insert*](http://byron.github.io/google-apis-rs/google_youtube3/struct.ActivityInsertCall.html) and [*list*](http://byron.github.io/google-apis-rs/google_youtube3/struct.ActivityListCall.html) +* [captions](http://byron.github.io/google-apis-rs/google_youtube3/struct.Caption.html) + * [*delete*](http://byron.github.io/google-apis-rs/google_youtube3/struct.CaptionDeleteCall.html), [*download*](http://byron.github.io/google-apis-rs/google_youtube3/struct.CaptionDownloadCall.html), [*insert*](http://byron.github.io/google-apis-rs/google_youtube3/struct.CaptionInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google_youtube3/struct.CaptionListCall.html) and [*update*](http://byron.github.io/google-apis-rs/google_youtube3/struct.CaptionUpdateCall.html) * channel banners - * [*insert*](http://byron.github.io/google-apis-rs/google-youtube3/struct.ChannelBannerInsertCall.html) -* [channel sections](http://byron.github.io/google-apis-rs/google-youtube3/struct.ChannelSection.html) - * [*delete*](http://byron.github.io/google-apis-rs/google-youtube3/struct.ChannelSectionDeleteCall.html), [*insert*](http://byron.github.io/google-apis-rs/google-youtube3/struct.ChannelSectionInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google-youtube3/struct.ChannelSectionListCall.html) and [*update*](http://byron.github.io/google-apis-rs/google-youtube3/struct.ChannelSectionUpdateCall.html) -* [channels](http://byron.github.io/google-apis-rs/google-youtube3/struct.Channel.html) - * [*list*](http://byron.github.io/google-apis-rs/google-youtube3/struct.ChannelListCall.html) and [*update*](http://byron.github.io/google-apis-rs/google-youtube3/struct.ChannelUpdateCall.html) -* [guide categories](http://byron.github.io/google-apis-rs/google-youtube3/struct.GuideCategory.html) - * [*list*](http://byron.github.io/google-apis-rs/google-youtube3/struct.GuideCategoryListCall.html) -* [i18n languages](http://byron.github.io/google-apis-rs/google-youtube3/struct.I18nLanguage.html) - * [*list*](http://byron.github.io/google-apis-rs/google-youtube3/struct.I18nLanguageListCall.html) -* [i18n regions](http://byron.github.io/google-apis-rs/google-youtube3/struct.I18nRegion.html) - * [*list*](http://byron.github.io/google-apis-rs/google-youtube3/struct.I18nRegionListCall.html) -* [live broadcasts](http://byron.github.io/google-apis-rs/google-youtube3/struct.LiveBroadcast.html) - * [*bind*](http://byron.github.io/google-apis-rs/google-youtube3/struct.LiveBroadcastBindCall.html), [*control*](http://byron.github.io/google-apis-rs/google-youtube3/struct.LiveBroadcastControlCall.html), [*delete*](http://byron.github.io/google-apis-rs/google-youtube3/struct.LiveBroadcastDeleteCall.html), [*insert*](http://byron.github.io/google-apis-rs/google-youtube3/struct.LiveBroadcastInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google-youtube3/struct.LiveBroadcastListCall.html), [*transition*](http://byron.github.io/google-apis-rs/google-youtube3/struct.LiveBroadcastTransitionCall.html) and [*update*](http://byron.github.io/google-apis-rs/google-youtube3/struct.LiveBroadcastUpdateCall.html) -* [live streams](http://byron.github.io/google-apis-rs/google-youtube3/struct.LiveStream.html) - * [*delete*](http://byron.github.io/google-apis-rs/google-youtube3/struct.LiveStreamDeleteCall.html), [*insert*](http://byron.github.io/google-apis-rs/google-youtube3/struct.LiveStreamInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google-youtube3/struct.LiveStreamListCall.html) and [*update*](http://byron.github.io/google-apis-rs/google-youtube3/struct.LiveStreamUpdateCall.html) -* [playlist items](http://byron.github.io/google-apis-rs/google-youtube3/struct.PlaylistItem.html) - * [*delete*](http://byron.github.io/google-apis-rs/google-youtube3/struct.PlaylistItemDeleteCall.html), [*insert*](http://byron.github.io/google-apis-rs/google-youtube3/struct.PlaylistItemInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google-youtube3/struct.PlaylistItemListCall.html) and [*update*](http://byron.github.io/google-apis-rs/google-youtube3/struct.PlaylistItemUpdateCall.html) -* [playlists](http://byron.github.io/google-apis-rs/google-youtube3/struct.Playlist.html) - * [*delete*](http://byron.github.io/google-apis-rs/google-youtube3/struct.PlaylistDeleteCall.html), [*insert*](http://byron.github.io/google-apis-rs/google-youtube3/struct.PlaylistInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google-youtube3/struct.PlaylistListCall.html) and [*update*](http://byron.github.io/google-apis-rs/google-youtube3/struct.PlaylistUpdateCall.html) + * [*insert*](http://byron.github.io/google-apis-rs/google_youtube3/struct.ChannelBannerInsertCall.html) +* [channel sections](http://byron.github.io/google-apis-rs/google_youtube3/struct.ChannelSection.html) + * [*delete*](http://byron.github.io/google-apis-rs/google_youtube3/struct.ChannelSectionDeleteCall.html), [*insert*](http://byron.github.io/google-apis-rs/google_youtube3/struct.ChannelSectionInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google_youtube3/struct.ChannelSectionListCall.html) and [*update*](http://byron.github.io/google-apis-rs/google_youtube3/struct.ChannelSectionUpdateCall.html) +* [channels](http://byron.github.io/google-apis-rs/google_youtube3/struct.Channel.html) + * [*list*](http://byron.github.io/google-apis-rs/google_youtube3/struct.ChannelListCall.html) and [*update*](http://byron.github.io/google-apis-rs/google_youtube3/struct.ChannelUpdateCall.html) +* [guide categories](http://byron.github.io/google-apis-rs/google_youtube3/struct.GuideCategory.html) + * [*list*](http://byron.github.io/google-apis-rs/google_youtube3/struct.GuideCategoryListCall.html) +* [i18n languages](http://byron.github.io/google-apis-rs/google_youtube3/struct.I18nLanguage.html) + * [*list*](http://byron.github.io/google-apis-rs/google_youtube3/struct.I18nLanguageListCall.html) +* [i18n regions](http://byron.github.io/google-apis-rs/google_youtube3/struct.I18nRegion.html) + * [*list*](http://byron.github.io/google-apis-rs/google_youtube3/struct.I18nRegionListCall.html) +* [live broadcasts](http://byron.github.io/google-apis-rs/google_youtube3/struct.LiveBroadcast.html) + * [*bind*](http://byron.github.io/google-apis-rs/google_youtube3/struct.LiveBroadcastBindCall.html), [*control*](http://byron.github.io/google-apis-rs/google_youtube3/struct.LiveBroadcastControlCall.html), [*delete*](http://byron.github.io/google-apis-rs/google_youtube3/struct.LiveBroadcastDeleteCall.html), [*insert*](http://byron.github.io/google-apis-rs/google_youtube3/struct.LiveBroadcastInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google_youtube3/struct.LiveBroadcastListCall.html), [*transition*](http://byron.github.io/google-apis-rs/google_youtube3/struct.LiveBroadcastTransitionCall.html) and [*update*](http://byron.github.io/google-apis-rs/google_youtube3/struct.LiveBroadcastUpdateCall.html) +* [live streams](http://byron.github.io/google-apis-rs/google_youtube3/struct.LiveStream.html) + * [*delete*](http://byron.github.io/google-apis-rs/google_youtube3/struct.LiveStreamDeleteCall.html), [*insert*](http://byron.github.io/google-apis-rs/google_youtube3/struct.LiveStreamInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google_youtube3/struct.LiveStreamListCall.html) and [*update*](http://byron.github.io/google-apis-rs/google_youtube3/struct.LiveStreamUpdateCall.html) +* [playlist items](http://byron.github.io/google-apis-rs/google_youtube3/struct.PlaylistItem.html) + * [*delete*](http://byron.github.io/google-apis-rs/google_youtube3/struct.PlaylistItemDeleteCall.html), [*insert*](http://byron.github.io/google-apis-rs/google_youtube3/struct.PlaylistItemInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google_youtube3/struct.PlaylistItemListCall.html) and [*update*](http://byron.github.io/google-apis-rs/google_youtube3/struct.PlaylistItemUpdateCall.html) +* [playlists](http://byron.github.io/google-apis-rs/google_youtube3/struct.Playlist.html) + * [*delete*](http://byron.github.io/google-apis-rs/google_youtube3/struct.PlaylistDeleteCall.html), [*insert*](http://byron.github.io/google-apis-rs/google_youtube3/struct.PlaylistInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google_youtube3/struct.PlaylistListCall.html) and [*update*](http://byron.github.io/google-apis-rs/google_youtube3/struct.PlaylistUpdateCall.html) * search - * [*list*](http://byron.github.io/google-apis-rs/google-youtube3/struct.SearchListCall.html) -* [subscriptions](http://byron.github.io/google-apis-rs/google-youtube3/struct.Subscription.html) - * [*delete*](http://byron.github.io/google-apis-rs/google-youtube3/struct.SubscriptionDeleteCall.html), [*insert*](http://byron.github.io/google-apis-rs/google-youtube3/struct.SubscriptionInsertCall.html) and [*list*](http://byron.github.io/google-apis-rs/google-youtube3/struct.SubscriptionListCall.html) -* [thumbnails](http://byron.github.io/google-apis-rs/google-youtube3/struct.Thumbnail.html) - * [*set*](http://byron.github.io/google-apis-rs/google-youtube3/struct.ThumbnailSetCall.html) -* [video categories](http://byron.github.io/google-apis-rs/google-youtube3/struct.VideoCategory.html) - * [*list*](http://byron.github.io/google-apis-rs/google-youtube3/struct.VideoCategoryListCall.html) -* [videos](http://byron.github.io/google-apis-rs/google-youtube3/struct.Video.html) - * [*delete*](http://byron.github.io/google-apis-rs/google-youtube3/struct.VideoDeleteCall.html), [*get rating*](http://byron.github.io/google-apis-rs/google-youtube3/struct.VideoGetRatingCall.html), [*insert*](http://byron.github.io/google-apis-rs/google-youtube3/struct.VideoInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google-youtube3/struct.VideoListCall.html), [*rate*](http://byron.github.io/google-apis-rs/google-youtube3/struct.VideoRateCall.html) and [*update*](http://byron.github.io/google-apis-rs/google-youtube3/struct.VideoUpdateCall.html) + * [*list*](http://byron.github.io/google-apis-rs/google_youtube3/struct.SearchListCall.html) +* [subscriptions](http://byron.github.io/google-apis-rs/google_youtube3/struct.Subscription.html) + * [*delete*](http://byron.github.io/google-apis-rs/google_youtube3/struct.SubscriptionDeleteCall.html), [*insert*](http://byron.github.io/google-apis-rs/google_youtube3/struct.SubscriptionInsertCall.html) and [*list*](http://byron.github.io/google-apis-rs/google_youtube3/struct.SubscriptionListCall.html) +* [thumbnails](http://byron.github.io/google-apis-rs/google_youtube3/struct.Thumbnail.html) + * [*set*](http://byron.github.io/google-apis-rs/google_youtube3/struct.ThumbnailSetCall.html) +* [video categories](http://byron.github.io/google-apis-rs/google_youtube3/struct.VideoCategory.html) + * [*list*](http://byron.github.io/google-apis-rs/google_youtube3/struct.VideoCategoryListCall.html) +* [videos](http://byron.github.io/google-apis-rs/google_youtube3/struct.Video.html) + * [*delete*](http://byron.github.io/google-apis-rs/google_youtube3/struct.VideoDeleteCall.html), [*get rating*](http://byron.github.io/google-apis-rs/google_youtube3/struct.VideoGetRatingCall.html), [*insert*](http://byron.github.io/google-apis-rs/google_youtube3/struct.VideoInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google_youtube3/struct.VideoListCall.html), [*rate*](http://byron.github.io/google-apis-rs/google_youtube3/struct.VideoRateCall.html) and [*update*](http://byron.github.io/google-apis-rs/google_youtube3/struct.VideoUpdateCall.html) * watermarks - * [*set*](http://byron.github.io/google-apis-rs/google-youtube3/struct.WatermarkSetCall.html) and [*unset*](http://byron.github.io/google-apis-rs/google-youtube3/struct.WatermarkUnsetCall.html) + * [*set*](http://byron.github.io/google-apis-rs/google_youtube3/struct.WatermarkSetCall.html) and [*unset*](http://byron.github.io/google-apis-rs/google_youtube3/struct.WatermarkUnsetCall.html) Upload supported by ... -* [*set watermarks*](http://byron.github.io/google-apis-rs/google-youtube3/struct.WatermarkSetCall.html) -* [*insert channel banners*](http://byron.github.io/google-apis-rs/google-youtube3/struct.ChannelBannerInsertCall.html) -* [*set thumbnails*](http://byron.github.io/google-apis-rs/google-youtube3/struct.ThumbnailSetCall.html) -* [*insert captions*](http://byron.github.io/google-apis-rs/google-youtube3/struct.CaptionInsertCall.html) -* [*update captions*](http://byron.github.io/google-apis-rs/google-youtube3/struct.CaptionUpdateCall.html) -* [*insert videos*](http://byron.github.io/google-apis-rs/google-youtube3/struct.VideoInsertCall.html) +* [*set watermarks*](http://byron.github.io/google-apis-rs/google_youtube3/struct.WatermarkSetCall.html) +* [*insert channel banners*](http://byron.github.io/google-apis-rs/google_youtube3/struct.ChannelBannerInsertCall.html) +* [*set thumbnails*](http://byron.github.io/google-apis-rs/google_youtube3/struct.ThumbnailSetCall.html) +* [*insert captions*](http://byron.github.io/google-apis-rs/google_youtube3/struct.CaptionInsertCall.html) +* [*update captions*](http://byron.github.io/google-apis-rs/google_youtube3/struct.CaptionUpdateCall.html) +* [*insert videos*](http://byron.github.io/google-apis-rs/google_youtube3/struct.VideoInsertCall.html) Download supported by ... -* [*download captions*](http://byron.github.io/google-apis-rs/google-youtube3/struct.CaptionDownloadCall.html) +* [*download captions*](http://byron.github.io/google-apis-rs/google_youtube3/struct.CaptionDownloadCall.html) Subscription supported by ... -* [*list playlist items*](http://byron.github.io/google-apis-rs/google-youtube3/struct.PlaylistItemListCall.html) +* [*list playlist items*](http://byron.github.io/google-apis-rs/google_youtube3/struct.PlaylistItemListCall.html) @@ -74,17 +74,17 @@ Subscription supported by ... The API is structured into the following primary items: -* **[Hub](http://byron.github.io/google-apis-rs/google-youtube3/struct.YouTube.html)** +* **[Hub](http://byron.github.io/google-apis-rs/google_youtube3/struct.YouTube.html)** * a central object to maintain state and allow accessing all *Activities* - * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google-youtube3/trait.MethodsBuilder.html) which in turn - allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google-youtube3/trait.CallBuilder.html) -* **[Resources](http://byron.github.io/google-apis-rs/google-youtube3/trait.Resource.html)** + * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google_youtube3/trait.MethodsBuilder.html) which in turn + allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google_youtube3/trait.CallBuilder.html) +* **[Resources](http://byron.github.io/google-apis-rs/google_youtube3/trait.Resource.html)** * primary types that you can apply *Activities* to * a collection of properties and *Parts* - * **[Parts](http://byron.github.io/google-apis-rs/google-youtube3/trait.Part.html)** + * **[Parts](http://byron.github.io/google-apis-rs/google_youtube3/trait.Part.html)** * a collection of properties * never directly used in *Activities* -* **[Activities](http://byron.github.io/google-apis-rs/google-youtube3/trait.CallBuilder.html)** +* **[Activities](http://byron.github.io/google-apis-rs/google_youtube3/trait.CallBuilder.html)** * operations to apply to *Resources* All *structures* are marked with applicable traits to further categorize them and ease browsing. @@ -176,17 +176,17 @@ match result { ``` ## Handling Errors -All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google-youtube3/enum.Result.html) enumeration as return value of +All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google_youtube3/enum.Result.html) enumeration as return value of the doit() methods, or handed as possibly intermediate results to either the -[Hub Delegate](http://byron.github.io/google-apis-rs/google-youtube3/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google-youtube3/../yup-oauth2/trait.AuthenticatorDelegate.html). +[Hub Delegate](http://byron.github.io/google-apis-rs/google_youtube3/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google_youtube3/../yup-oauth2/trait.AuthenticatorDelegate.html). 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](http://byron.github.io/google-apis-rs/google-youtube3/enum.Result.html), should be +If a method supports downloads, the response body, which is part of the [Result](http://byron.github.io/google-apis-rs/google_youtube3/enum.Result.html), should be read by you to obtain the media. -If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google-youtube3/trait.ResponseResult.html), it will return that by default. +If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google_youtube3/trait.ResponseResult.html), 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")`. @@ -196,29 +196,29 @@ Methods supporting uploads can do so using up to 2 different protocols: ## Customization and Callbacks -You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google-youtube3/trait.Delegate.html) to the -[Method Builder](http://byron.github.io/google-apis-rs/google-youtube3/trait.CallBuilder.html) before making the final `doit()` call. +You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google_youtube3/trait.Delegate.html) to the +[Method Builder](http://byron.github.io/google-apis-rs/google_youtube3/trait.CallBuilder.html) 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](http://byron.github.io/google-apis-rs/google-youtube3/trait.Delegate.html) is default-implemented, allowing you to customize it with minimal effort. +The [delegate trait](http://byron.github.io/google-apis-rs/google_youtube3/trait.Delegate.html) 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](http://byron.github.io/google-apis-rs/google-youtube3/trait.RequestValue.html) and -[decodable](http://byron.github.io/google-apis-rs/google-youtube3/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses +All structures provided by this library are made to be [enocodable](http://byron.github.io/google-apis-rs/google_youtube3/trait.RequestValue.html) and +[decodable](http://byron.github.io/google-apis-rs/google_youtube3/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses are valid. -Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google-youtube3/trait.Part.html) which are identifiable by name, which will be sent to +Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google_youtube3/trait.Part.html) 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](http://byron.github.io/google-apis-rs/google-youtube3/trait.CallBuilder.html), you are able to prepare an action call by repeatedly calling it's methods. +Using [method builders](http://byron.github.io/google-apis-rs/google_youtube3/trait.CallBuilder.html), 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][wiki-pod] are handed by copy * strings are passed as `&str` -* [request values](http://byron.github.io/google-apis-rs/google-youtube3/trait.RequestValue.html) are borrowed +* [request values](http://byron.github.io/google-apis-rs/google_youtube3/trait.RequestValue.html) are borrowed Arguments will always be copied or cloned into the builder, to make them independent of their original life times. diff --git a/gen/youtubeanalytics1/README.md b/gen/youtubeanalytics1/README.md index e6904d83f1..b199678849 100644 --- a/gen/youtubeanalytics1/README.md +++ b/gen/youtubeanalytics1/README.md @@ -11,18 +11,18 @@ Everything else about the *YouTube Analytics* *v1* API can be found at the [official documentation site](http://developers.google.com/youtube/analytics/). # Features -Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google-youtubeanalytics1/struct.YouTubeAnalytics.html) ... +Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google_youtubeanalytics1/struct.YouTubeAnalytics.html) ... -* [batch report definitions](http://byron.github.io/google-apis-rs/google-youtubeanalytics1/struct.BatchReportDefinition.html) - * [*list*](http://byron.github.io/google-apis-rs/google-youtubeanalytics1/struct.BatchReportDefinitionListCall.html) -* [batch reports](http://byron.github.io/google-apis-rs/google-youtubeanalytics1/struct.BatchReport.html) - * [*list*](http://byron.github.io/google-apis-rs/google-youtubeanalytics1/struct.BatchReportListCall.html) -* [group items](http://byron.github.io/google-apis-rs/google-youtubeanalytics1/struct.GroupItem.html) - * [*delete*](http://byron.github.io/google-apis-rs/google-youtubeanalytics1/struct.GroupItemDeleteCall.html), [*insert*](http://byron.github.io/google-apis-rs/google-youtubeanalytics1/struct.GroupItemInsertCall.html) and [*list*](http://byron.github.io/google-apis-rs/google-youtubeanalytics1/struct.GroupItemListCall.html) -* [groups](http://byron.github.io/google-apis-rs/google-youtubeanalytics1/struct.Group.html) - * [*delete*](http://byron.github.io/google-apis-rs/google-youtubeanalytics1/struct.GroupDeleteCall.html), [*insert*](http://byron.github.io/google-apis-rs/google-youtubeanalytics1/struct.GroupInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google-youtubeanalytics1/struct.GroupListCall.html) and [*update*](http://byron.github.io/google-apis-rs/google-youtubeanalytics1/struct.GroupUpdateCall.html) +* [batch report definitions](http://byron.github.io/google-apis-rs/google_youtubeanalytics1/struct.BatchReportDefinition.html) + * [*list*](http://byron.github.io/google-apis-rs/google_youtubeanalytics1/struct.BatchReportDefinitionListCall.html) +* [batch reports](http://byron.github.io/google-apis-rs/google_youtubeanalytics1/struct.BatchReport.html) + * [*list*](http://byron.github.io/google-apis-rs/google_youtubeanalytics1/struct.BatchReportListCall.html) +* [group items](http://byron.github.io/google-apis-rs/google_youtubeanalytics1/struct.GroupItem.html) + * [*delete*](http://byron.github.io/google-apis-rs/google_youtubeanalytics1/struct.GroupItemDeleteCall.html), [*insert*](http://byron.github.io/google-apis-rs/google_youtubeanalytics1/struct.GroupItemInsertCall.html) and [*list*](http://byron.github.io/google-apis-rs/google_youtubeanalytics1/struct.GroupItemListCall.html) +* [groups](http://byron.github.io/google-apis-rs/google_youtubeanalytics1/struct.Group.html) + * [*delete*](http://byron.github.io/google-apis-rs/google_youtubeanalytics1/struct.GroupDeleteCall.html), [*insert*](http://byron.github.io/google-apis-rs/google_youtubeanalytics1/struct.GroupInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google_youtubeanalytics1/struct.GroupListCall.html) and [*update*](http://byron.github.io/google-apis-rs/google_youtubeanalytics1/struct.GroupUpdateCall.html) * reports - * [*query*](http://byron.github.io/google-apis-rs/google-youtubeanalytics1/struct.ReportQueryCall.html) + * [*query*](http://byron.github.io/google-apis-rs/google_youtubeanalytics1/struct.ReportQueryCall.html) @@ -31,17 +31,17 @@ Handle the following *Resources* with ease from the central [hub](http://byron.g The API is structured into the following primary items: -* **[Hub](http://byron.github.io/google-apis-rs/google-youtubeanalytics1/struct.YouTubeAnalytics.html)** +* **[Hub](http://byron.github.io/google-apis-rs/google_youtubeanalytics1/struct.YouTubeAnalytics.html)** * a central object to maintain state and allow accessing all *Activities* - * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google-youtubeanalytics1/trait.MethodsBuilder.html) which in turn - allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google-youtubeanalytics1/trait.CallBuilder.html) -* **[Resources](http://byron.github.io/google-apis-rs/google-youtubeanalytics1/trait.Resource.html)** + * creates [*Method Builders*](http://byron.github.io/google-apis-rs/google_youtubeanalytics1/trait.MethodsBuilder.html) which in turn + allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google_youtubeanalytics1/trait.CallBuilder.html) +* **[Resources](http://byron.github.io/google-apis-rs/google_youtubeanalytics1/trait.Resource.html)** * primary types that you can apply *Activities* to * a collection of properties and *Parts* - * **[Parts](http://byron.github.io/google-apis-rs/google-youtubeanalytics1/trait.Part.html)** + * **[Parts](http://byron.github.io/google-apis-rs/google_youtubeanalytics1/trait.Part.html)** * a collection of properties * never directly used in *Activities* -* **[Activities](http://byron.github.io/google-apis-rs/google-youtubeanalytics1/trait.CallBuilder.html)** +* **[Activities](http://byron.github.io/google-apis-rs/google_youtubeanalytics1/trait.CallBuilder.html)** * operations to apply to *Resources* All *structures* are marked with applicable traits to further categorize them and ease browsing. @@ -126,17 +126,17 @@ match result { ``` ## Handling Errors -All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google-youtubeanalytics1/enum.Result.html) enumeration as return value of +All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google_youtubeanalytics1/enum.Result.html) enumeration as return value of the doit() methods, or handed as possibly intermediate results to either the -[Hub Delegate](http://byron.github.io/google-apis-rs/google-youtubeanalytics1/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google-youtubeanalytics1/../yup-oauth2/trait.AuthenticatorDelegate.html). +[Hub Delegate](http://byron.github.io/google-apis-rs/google_youtubeanalytics1/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google_youtubeanalytics1/../yup-oauth2/trait.AuthenticatorDelegate.html). 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](http://byron.github.io/google-apis-rs/google-youtubeanalytics1/enum.Result.html), should be +If a method supports downloads, the response body, which is part of the [Result](http://byron.github.io/google-apis-rs/google_youtubeanalytics1/enum.Result.html), should be read by you to obtain the media. -If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google-youtubeanalytics1/trait.ResponseResult.html), it will return that by default. +If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google_youtubeanalytics1/trait.ResponseResult.html), 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")`. @@ -146,29 +146,29 @@ Methods supporting uploads can do so using up to 2 different protocols: ## Customization and Callbacks -You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google-youtubeanalytics1/trait.Delegate.html) to the -[Method Builder](http://byron.github.io/google-apis-rs/google-youtubeanalytics1/trait.CallBuilder.html) before making the final `doit()` call. +You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google_youtubeanalytics1/trait.Delegate.html) to the +[Method Builder](http://byron.github.io/google-apis-rs/google_youtubeanalytics1/trait.CallBuilder.html) 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](http://byron.github.io/google-apis-rs/google-youtubeanalytics1/trait.Delegate.html) is default-implemented, allowing you to customize it with minimal effort. +The [delegate trait](http://byron.github.io/google-apis-rs/google_youtubeanalytics1/trait.Delegate.html) 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](http://byron.github.io/google-apis-rs/google-youtubeanalytics1/trait.RequestValue.html) and -[decodable](http://byron.github.io/google-apis-rs/google-youtubeanalytics1/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses +All structures provided by this library are made to be [enocodable](http://byron.github.io/google-apis-rs/google_youtubeanalytics1/trait.RequestValue.html) and +[decodable](http://byron.github.io/google-apis-rs/google_youtubeanalytics1/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses are valid. -Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google-youtubeanalytics1/trait.Part.html) which are identifiable by name, which will be sent to +Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google_youtubeanalytics1/trait.Part.html) 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](http://byron.github.io/google-apis-rs/google-youtubeanalytics1/trait.CallBuilder.html), you are able to prepare an action call by repeatedly calling it's methods. +Using [method builders](http://byron.github.io/google-apis-rs/google_youtubeanalytics1/trait.CallBuilder.html), 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][wiki-pod] are handed by copy * strings are passed as `&str` -* [request values](http://byron.github.io/google-apis-rs/google-youtubeanalytics1/trait.RequestValue.html) are borrowed +* [request values](http://byron.github.io/google-apis-rs/google_youtubeanalytics1/trait.RequestValue.html) are borrowed Arguments will always be copied or cloned into the builder, to make them independent of their original life times. diff --git a/src/mako/api/lib/lib.mako b/src/mako/api/lib/lib.mako index ed4962527b..f82255d936 100644 --- a/src/mako/api/lib/lib.mako +++ b/src/mako/api/lib/lib.mako @@ -6,7 +6,8 @@ find_fattest_resource, build_all_params, pass_through, parts_from_params, REQUEST_MARKER_TRAIT, RESPONSE_MARKER_TRAIT, supports_scopes, to_api_version, to_fqan, METHODS_RESOURCE, ADD_PARAM_MEDIA_EXAMPLE, PROTOCOL_TYPE_INFO, enclose_in, - upload_action_fn, unique_type_name, schema_doc_format, METHODS_BUILDER_MARKER_TRAIT) + upload_action_fn, unique_type_name, schema_doc_format, METHODS_BUILDER_MARKER_TRAIT, + to_extern_crate_name) def pretty_name(name): return ' '.join(split_camelcase_s(name).split('.')) @@ -29,7 +30,7 @@ response_trait_url = 'trait.' + RESPONSE_MARKER_TRAIT + '.html' part_trait_url = 'trait.' + PART_MARKER_TRAIT + '.html' - doc_base_url = cargo.doc_base_url + '/' + util.crate_name() + '/' + doc_base_url = cargo.doc_base_url + '/' + to_extern_crate_name(util.crate_name()) + '/' def link(name, url): lf = '[%s](%s)'