Update docs after merge to master.

Author: travis-ci

_modules/gcloud/connection.html

@@ -98,6 +98,34 @@ <h1>Source code for gcloud.connection</h1><div class="highlight"><pre>
 
 <span class="sd">    Subclasses should understand only the basic types in method arguments,</span>
 <span class="sd">    however they should be capable of returning advanced types.</span>
+
+<span class="sd">    If no value is passed in for ``http``, a :class:`httplib2.Http` object</span>
+<span class="sd">    will be created and authorized with the ``credentials``. If not, the</span>
+<span class="sd">    ``credentials`` and ``http`` need not be related.</span>
+
+<span class="sd">    Subclasses may seek to use the private key from ``credentials`` to sign</span>
+<span class="sd">    data.</span>
+
+<span class="sd">    A custom (non-``httplib2``) HTTP object must have a ``request`` method</span>
+<span class="sd">    which accepts the following arguments:</span>
+
+<span class="sd">    * ``uri``</span>
+<span class="sd">    * ``method``</span>
+<span class="sd">    * ``body``</span>
+<span class="sd">    * ``headers``</span>
+
+<span class="sd">    In addition, ``redirections`` and ``connection_type`` may be used.</span>
+
+<span class="sd">    Without the use of ``credentials.authorize(http)``, a custom ``http``</span>
+<span class="sd">    object will also need to be able to add a bearer token to API</span>
+<span class="sd">    requests and handle token refresh on 401 errors.</span>
+
+<span class="sd">    :type credentials: :class:`oauth2client.client.OAuth2Credentials` or</span>
+<span class="sd">                       :class:`NoneType`</span>
+<span class="sd">    :param credentials: The OAuth2 Credentials to use for this connection.</span>
+
+<span class="sd">    :type http: :class:`httplib2.Http` or class that defines ``request()``.</span>
+<span class="sd">    :param http: An optional HTTP object to make requests.</span>
 <span class="sd">    &quot;&quot;&quot;</span>
 
     <span class="n">API_BASE_URL</span> <span class="o">=</span> <span class="s">&#39;https://www.googleapis.com&#39;</span>
@@ -109,14 +137,8 @@ <h1>Source code for gcloud.connection</h1><div class="highlight"><pre>
     <span class="n">USER_AGENT</span> <span class="o">=</span> <span class="s">&quot;gcloud-python/{0}&quot;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">get_distribution</span><span class="p">(</span><span class="s">&#39;gcloud&#39;</span><span class="p">)</span><span class="o">.</span><span class="n">version</span><span class="p">)</span>
     <span class="sd">&quot;&quot;&quot;The user agent for gcloud-python requests.&quot;&quot;&quot;</span>
 
-    <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">credentials</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
-        <span class="sd">&quot;&quot;&quot;Constructor for Connection.</span>
-
-<span class="sd">        :type credentials: :class:`oauth2client.client.OAuth2Credentials` or</span>
-<span class="sd">                           :class:`NoneType`</span>
-<span class="sd">        :param credentials: The OAuth2 Credentials to use for this connection.</span>
-<span class="sd">        &quot;&quot;&quot;</span>
-        <span class="bp">self</span><span class="o">.</span><span class="n">_http</span> <span class="o">=</span> <span class="bp">None</span>
+    <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">credentials</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">http</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">_http</span> <span class="o">=</span> <span class="n">http</span>
         <span class="bp">self</span><span class="o">.</span><span class="n">_credentials</span> <span class="o">=</span> <span class="n">credentials</span>
 
     <span class="nd">@property</span>

datastore-api.html

@@ -271,7 +271,7 @@ <h3>Try it yourself<a class="headerlink" href="#try-it-yourself" title="Permalin
 <p>Connections to gcloud datastore API servers.</p>
 <dl class="class">
 <dt id="gcloud.datastore.connection.Connection">
-<em class="property">class </em><tt class="descclassname">gcloud.datastore.connection.</tt><tt class="descname">Connection</tt><big>(</big><em>credentials=None</em><big>)</big><a class="reference internal" href="_modules/gcloud/datastore/connection.html#Connection"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#gcloud.datastore.connection.Connection" title="Permalink to this definition">#</a></dt>
+<em class="property">class </em><tt class="descclassname">gcloud.datastore.connection.</tt><tt class="descname">Connection</tt><big>(</big><em>credentials=None</em>, <em>http=None</em><big>)</big><a class="reference internal" href="_modules/gcloud/datastore/connection.html#Connection"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#gcloud.datastore.connection.Connection" title="Permalink to this definition">#</a></dt>
 <dd><p>Bases: <a class="reference internal" href="gcloud-api.html#gcloud.connection.Connection" title="gcloud.connection.Connection"><tt class="xref py py-class docutils literal"><span class="pre">gcloud.connection.Connection</span></tt></a></p>
 <p>A connection to the Google Cloud Datastore via the Protobuf API.</p>
 <p>This class should understand only the basic types (and protobufs)
@@ -284,16 +284,6 @@ <h3>Try it yourself<a class="headerlink" href="#try-it-yourself" title="Permalin
 </tr>
 </tbody>
 </table>
-<p>Constructor for Connection.</p>
-<table class="docutils field-list" frame="void" rules="none">
-<col class="field-name" />
-<col class="field-body" />
-<tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>credentials</strong> (<tt class="xref py py-class docutils literal"><span class="pre">oauth2client.client.OAuth2Credentials</span></tt> or
-<tt class="xref py py-class docutils literal"><span class="pre">NoneType</span></tt>) &#8211; The OAuth2 Credentials to use for this connection.</td>
-</tr>
-</tbody>
-</table>
 <dl class="attribute">
 <dt id="gcloud.datastore.connection.Connection.API_URL_TEMPLATE">
 <tt class="descname">API_URL_TEMPLATE</tt><em class="property"> = '{api_base}/datastore/{api_version}/datasets/{dataset_id}/{method}'</em><a class="headerlink" href="#gcloud.datastore.connection.Connection.API_URL_TEMPLATE" title="Permalink to this definition">#</a></dt>

gcloud-api.html

@@ -85,18 +85,38 @@ <h1>GCloud Package<a class="headerlink" href="#gcloud-package" title="Permalink
 <p>Shared implementation of connections to API servers.</p>
 <dl class="class">
 <dt id="gcloud.connection.Connection">
-<em class="property">class </em><tt class="descclassname">gcloud.connection.</tt><tt class="descname">Connection</tt><big>(</big><em>credentials=None</em><big>)</big><a class="reference internal" href="_modules/gcloud/connection.html#Connection"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#gcloud.connection.Connection" title="Permalink to this definition">#</a></dt>
+<em class="property">class </em><tt class="descclassname">gcloud.connection.</tt><tt class="descname">Connection</tt><big>(</big><em>credentials=None</em>, <em>http=None</em><big>)</big><a class="reference internal" href="_modules/gcloud/connection.html#Connection"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#gcloud.connection.Connection" title="Permalink to this definition">#</a></dt>
 <dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>
 <p>A generic connection to Google Cloud Platform.</p>
 <p>Subclasses should understand only the basic types in method arguments,
 however they should be capable of returning advanced types.</p>
-<p>Constructor for Connection.</p>
+<p>If no value is passed in for <tt class="docutils literal"><span class="pre">http</span></tt>, a <tt class="xref py py-class docutils literal"><span class="pre">httplib2.Http</span></tt> object
+will be created and authorized with the <tt class="docutils literal"><span class="pre">credentials</span></tt>. If not, the
+<tt class="docutils literal"><span class="pre">credentials</span></tt> and <tt class="docutils literal"><span class="pre">http</span></tt> need not be related.</p>
+<p>Subclasses may seek to use the private key from <tt class="docutils literal"><span class="pre">credentials</span></tt> to sign
+data.</p>
+<p>A custom (non-<tt class="docutils literal"><span class="pre">httplib2</span></tt>) HTTP object must have a <tt class="docutils literal"><span class="pre">request</span></tt> method
+which accepts the following arguments:</p>
+<ul class="simple">
+<li><tt class="docutils literal"><span class="pre">uri</span></tt></li>
+<li><tt class="docutils literal"><span class="pre">method</span></tt></li>
+<li><tt class="docutils literal"><span class="pre">body</span></tt></li>
+<li><tt class="docutils literal"><span class="pre">headers</span></tt></li>
+</ul>
+<p>In addition, <tt class="docutils literal"><span class="pre">redirections</span></tt> and <tt class="docutils literal"><span class="pre">connection_type</span></tt> may be used.</p>
+<p>Without the use of <tt class="docutils literal"><span class="pre">credentials.authorize(http)</span></tt>, a custom <tt class="docutils literal"><span class="pre">http</span></tt>
+object will also need to be able to add a bearer token to API
+requests and handle token refresh on 401 errors.</p>
 <table class="docutils field-list" frame="void" rules="none">
 <col class="field-name" />
 <col class="field-body" />
 <tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>credentials</strong> (<tt class="xref py py-class docutils literal"><span class="pre">oauth2client.client.OAuth2Credentials</span></tt> or
-<tt class="xref py py-class docutils literal"><span class="pre">NoneType</span></tt>) &#8211; The OAuth2 Credentials to use for this connection.</td>
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
+<li><strong>credentials</strong> (<tt class="xref py py-class docutils literal"><span class="pre">oauth2client.client.OAuth2Credentials</span></tt> or
+<tt class="xref py py-class docutils literal"><span class="pre">NoneType</span></tt>) &#8211; The OAuth2 Credentials to use for this connection.</li>
+<li><strong>http</strong> (<tt class="xref py py-class docutils literal"><span class="pre">httplib2.Http</span></tt> or class that defines <tt class="docutils literal"><span class="pre">request()</span></tt>.) &#8211; An optional HTTP object to make requests.</li>
+</ul>
+</td>
 </tr>
 </tbody>
 </table>