docs: update generated docs (#1053)
Updates for both discovery docs and epydoc API Documentation
Fixes: #1049
diff --git a/docs/epy/googleapiclient.discovery-module.html b/docs/epy/googleapiclient.discovery-module.html
index d5d9929..ecf8516 100644
--- a/docs/epy/googleapiclient.discovery-module.html
+++ b/docs/epy/googleapiclient.discovery-module.html
@@ -56,12 +56,8 @@
</table>
<!-- ==================== MODULE DESCRIPTION ==================== -->
<h1 class="epydoc">Module discovery</h1><p class="nomargin-top"><span class="codelink"><a href="googleapiclient.discovery-pysrc.html">source code</a></span></p>
-<pre class="literalblock">
-Client for discovery based APIs.
-
-A client library for Google's discovery based APIs.
-
-</pre>
+<p>Client for discovery based APIs.</p>
+ <p>A client library for Google's discovery based APIs.</p>
<hr />
<div class="fields"> <p><strong>Author:</strong>
@@ -175,7 +171,10 @@
<span class="summary-sig-arg">credentials</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">cache_discovery</span>=<span class="summary-sig-default">True</span>,
<span class="summary-sig-arg">cache</span>=<span class="summary-sig-default">None</span>,
- <span class="summary-sig-arg">client_options</span>=<span class="summary-sig-default">None</span>)</span><br />
+ <span class="summary-sig-arg">client_options</span>=<span class="summary-sig-default">None</span>,
+ <span class="summary-sig-arg">adc_cert_path</span>=<span class="summary-sig-default">None</span>,
+ <span class="summary-sig-arg">adc_key_path</span>=<span class="summary-sig-default">None</span>,
+ <span class="summary-sig-arg">num_retries</span>=<span class="summary-sig-default">1</span>)</span><br />
Construct a Resource for interacting with an API.</td>
<td align="right" valign="top">
<span class="codelink"><a href="googleapiclient.discovery-pysrc.html#build">source code</a></span>
@@ -192,11 +191,30 @@
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
+ <td><span class="summary-sig"><a href="googleapiclient.discovery-module.html#_discovery_service_uri_options" class="summary-sig-name" onclick="show_private();">_discovery_service_uri_options</a>(<span class="summary-sig-arg">discoveryServiceUrl</span>,
+ <span class="summary-sig-arg">version</span>)</span><br />
+ Returns Discovery URIs to be used for attemnting to build the API Resource.</td>
+ <td align="right" valign="top">
+ <span class="codelink"><a href="googleapiclient.discovery-pysrc.html#_discovery_service_uri_options">source code</a></span>
+
+ </td>
+ </tr>
+ </table>
+
+ </td>
+ </tr>
+<tr class="private">
+ <td width="15%" align="right" valign="top" class="summary">
+ <span class="summary-type"> </span>
+ </td><td class="summary">
+ <table width="100%" cellpadding="0" cellspacing="0" border="0">
+ <tr>
<td><span class="summary-sig"><a href="googleapiclient.discovery-module.html#_retrieve_discovery_doc" class="summary-sig-name" onclick="show_private();">_retrieve_discovery_doc</a>(<span class="summary-sig-arg">url</span>,
<span class="summary-sig-arg">http</span>,
<span class="summary-sig-arg">cache_discovery</span>,
<span class="summary-sig-arg">cache</span>=<span class="summary-sig-default">None</span>,
- <span class="summary-sig-arg">developerKey</span>=<span class="summary-sig-default">None</span>)</span><br />
+ <span class="summary-sig-arg">developerKey</span>=<span class="summary-sig-default">None</span>,
+ <span class="summary-sig-arg">num_retries</span>=<span class="summary-sig-default">1</span>)</span><br />
Retrieves the discovery_doc from cache or the internet.</td>
<td align="right" valign="top">
<span class="codelink"><a href="googleapiclient.discovery-pysrc.html#_retrieve_discovery_doc">source code</a></span>
@@ -221,7 +239,9 @@
<span class="summary-sig-arg">model</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">requestBuilder</span>=<span class="summary-sig-default">HttpRequest</span>,
<span class="summary-sig-arg">credentials</span>=<span class="summary-sig-default">None</span>,
- <span class="summary-sig-arg">client_options</span>=<span class="summary-sig-default">None</span>)</span><br />
+ <span class="summary-sig-arg">client_options</span>=<span class="summary-sig-default">None</span>,
+ <span class="summary-sig-arg">adc_cert_path</span>=<span class="summary-sig-default">None</span>,
+ <span class="summary-sig-arg">adc_key_path</span>=<span class="summary-sig-default">None</span>)</span><br />
Create a Resource for interacting with an API.</td>
<td align="right" valign="top">
<span class="codelink"><a href="googleapiclient.discovery-pysrc.html#build_from_document">source code</a></span>
@@ -460,6 +480,13 @@
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
+ <a name="google_auth_httplib2"></a><span class="summary-name">google_auth_httplib2</span> = <code title="None">None</code>
+ </td>
+ </tr>
+<tr class="private">
+ <td width="15%" align="right" valign="top" class="summary">
+ <span class="summary-type"> </span>
+ </td><td class="summary">
<a name="logger"></a><span class="summary-name">logger</span> = <code title="logging.getLogger(__name__)">logging.getLogger(__name__)</code>
</td>
</tr>
@@ -556,6 +583,20 @@
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
+ <a href="googleapiclient.discovery-module.html#GOOGLE_API_USE_CLIENT_CERTIFICATE" class="summary-name" onclick="show_private();">GOOGLE_API_USE_CLIENT_CERTIFICATE</a> = <code title=""GOOGLE_API_USE_CLIENT_CERTIFICATE"">"GOOGLE_API_USE_CLIENT_CER<code class="variable-ellipsis">...</code></code>
+ </td>
+ </tr>
+<tr class="private">
+ <td width="15%" align="right" valign="top" class="summary">
+ <span class="summary-type"> </span>
+ </td><td class="summary">
+ <a name="GOOGLE_API_USE_MTLS_ENDPOINT"></a><span class="summary-name">GOOGLE_API_USE_MTLS_ENDPOINT</span> = <code title=""GOOGLE_API_USE_MTLS_ENDPOINT"">"GOOGLE_API_USE_MTLS_ENDPOINT"</code>
+ </td>
+ </tr>
+<tr class="private">
+ <td width="15%" align="right" valign="top" class="summary">
+ <span class="summary-type"> </span>
+ </td><td class="summary">
<a href="googleapiclient.discovery-module.html#STACK_QUERY_PARAMETERS" class="summary-name" onclick="show_private();">STACK_QUERY_PARAMETERS</a> = <code title="frozenset(["trace", "pp", "userip", "strict"])">frozenset(["trace", "pp", "userip", "<code class="variable-ellipsis">...</code></code>
</td>
</tr>
@@ -614,7 +655,7 @@
Returns:
The name with '_' appended if the name is a reserved word and '$' and '-'
- replaced with '_'.
+ replaced with '_'.
</pre>
<dl class="fields">
@@ -668,7 +709,10 @@
<span class="sig-arg">credentials</span>=<span class="sig-default">None</span>,
<span class="sig-arg">cache_discovery</span>=<span class="sig-default">True</span>,
<span class="sig-arg">cache</span>=<span class="sig-default">None</span>,
- <span class="sig-arg">client_options</span>=<span class="sig-default">None</span>)</span>
+ <span class="sig-arg">client_options</span>=<span class="sig-default">None</span>,
+ <span class="sig-arg">adc_cert_path</span>=<span class="sig-default">None</span>,
+ <span class="sig-arg">adc_key_path</span>=<span class="sig-default">None</span>,
+ <span class="sig-arg">num_retries</span>=<span class="sig-default">1</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="googleapiclient.discovery-pysrc.html#build">source code</a></span>
@@ -701,12 +745,41 @@
cache_discovery: Boolean, whether or not to cache the discovery doc.
cache: googleapiclient.discovery_cache.base.CacheBase, an optional
cache object for the discovery documents.
- client_options: Dictionary or google.api_core.client_options, Client options to set user
- options on the client. API endpoint should be set through client_options.
+ client_options: Mapping object or google.api_core.client_options, client
+ options to set user options on the client.
+ (1) The API endpoint should be set through client_options. If API endpoint
+ is not set, `GOOGLE_API_USE_MTLS_ENDPOINT` environment variable can be used
+ to control which endpoint to use.
+ (2) client_cert_source is not supported, client cert should be provided using
+ client_encrypted_cert_source instead. In order to use the provided client
+ cert, `GOOGLE_API_USE_CLIENT_CERTIFICATE` environment variable must be
+ set to `true`.
+ More details on the environment variables are here:
+ https://google.aip.dev/auth/4114
+ adc_cert_path: str, client certificate file path to save the application
+ default client certificate for mTLS. This field is required if you want to
+ use the default client certificate. `GOOGLE_API_USE_CLIENT_CERTIFICATE`
+ environment variable must be set to `true` in order to use this field,
+ otherwise this field doesn't nothing.
+ More details on the environment variables are here:
+ https://google.aip.dev/auth/4114
+ adc_key_path: str, client encrypted private key file path to save the
+ application default client encrypted private key for mTLS. This field is
+ required if you want to use the default client certificate.
+ `GOOGLE_API_USE_CLIENT_CERTIFICATE` environment variable must be set to
+ `true` in order to use this field, otherwise this field doesn't nothing.
+ More details on the environment variables are here:
+ https://google.aip.dev/auth/4114
+ num_retries: Integer, number of times to retry discovery with
+ randomized exponential backoff in case of intermittent/connection issues.
Returns:
A Resource object with methods for interacting with the service.
+Raises:
+ google.auth.exceptions.MutualTLSChannelError: if there are any problems
+ setting up mutual TLS channel.
+
</pre>
<dl class="fields">
<dt>Decorators:</dt>
@@ -716,6 +789,40 @@
</dl>
</td></tr></table>
</div>
+<a name="_discovery_service_uri_options"></a>
+<div class="private">
+<table class="details" border="1" cellpadding="3"
+ cellspacing="0" width="100%" bgcolor="white">
+<tr><td>
+ <table width="100%" cellpadding="0" cellspacing="0" border="0">
+ <tr valign="top"><td>
+ <h3 class="epydoc"><span class="sig"><span class="sig-name">_discovery_service_uri_options</span>(<span class="sig-arg">discoveryServiceUrl</span>,
+ <span class="sig-arg">version</span>)</span>
+ </h3>
+ </td><td align="right" valign="top"
+ ><span class="codelink"><a href="googleapiclient.discovery-pysrc.html#_discovery_service_uri_options">source code</a></span>
+ </td>
+ </tr></table>
+
+ <pre class="literalblock">
+
+ Returns Discovery URIs to be used for attemnting to build the API Resource.
+
+Args:
+ discoveryServiceUrl:
+ string, the Original Discovery Service URL preferred by the customer.
+ version:
+ string, API Version requested
+
+Returns:
+ A list of URIs to be tried for the Service Discovery, in order.
+
+
+</pre>
+ <dl class="fields">
+ </dl>
+</td></tr></table>
+</div>
<a name="_retrieve_discovery_doc"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
@@ -727,7 +834,8 @@
<span class="sig-arg">http</span>,
<span class="sig-arg">cache_discovery</span>,
<span class="sig-arg">cache</span>=<span class="sig-default">None</span>,
- <span class="sig-arg">developerKey</span>=<span class="sig-default">None</span>)</span>
+ <span class="sig-arg">developerKey</span>=<span class="sig-default">None</span>,
+ <span class="sig-arg">num_retries</span>=<span class="sig-default">1</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="googleapiclient.discovery-pysrc.html#_retrieve_discovery_doc">source code</a></span>
@@ -744,6 +852,10 @@
cache_discovery: Boolean, whether or not to cache the discovery doc.
cache: googleapiclient.discovery_cache.base.Cache, an optional cache
object for the discovery documents.
+ developerKey: string, Key for controlling API usage, generated
+ from the API Console.
+ num_retries: Integer, number of times to retry discovery with
+ randomized exponential backoff in case of intermittent/connection issues.
Returns:
A unicode string representation of the discovery document.
@@ -768,7 +880,9 @@
<span class="sig-arg">model</span>=<span class="sig-default">None</span>,
<span class="sig-arg">requestBuilder</span>=<span class="sig-default">HttpRequest</span>,
<span class="sig-arg">credentials</span>=<span class="sig-default">None</span>,
- <span class="sig-arg">client_options</span>=<span class="sig-default">None</span>)</span>
+ <span class="sig-arg">client_options</span>=<span class="sig-default">None</span>,
+ <span class="sig-arg">adc_cert_path</span>=<span class="sig-default">None</span>,
+ <span class="sig-arg">adc_key_path</span>=<span class="sig-default">None</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="googleapiclient.discovery-pysrc.html#build_from_document">source code</a></span>
@@ -799,12 +913,39 @@
credentials: oauth2client.Credentials or
google.auth.credentials.Credentials, credentials to be used for
authentication.
- client_options: Dictionary or google.api_core.client_options, Client options to set user
- options on the client. API endpoint should be set through client_options.
+ client_options: Mapping object or google.api_core.client_options, client
+ options to set user options on the client.
+ (1) The API endpoint should be set through client_options. If API endpoint
+ is not set, `GOOGLE_API_USE_MTLS_ENDPOINT` environment variable can be used
+ to control which endpoint to use.
+ (2) client_cert_source is not supported, client cert should be provided using
+ client_encrypted_cert_source instead. In order to use the provided client
+ cert, `GOOGLE_API_USE_CLIENT_CERTIFICATE` environment variable must be
+ set to `true`.
+ More details on the environment variables are here:
+ https://google.aip.dev/auth/4114
+ adc_cert_path: str, client certificate file path to save the application
+ default client certificate for mTLS. This field is required if you want to
+ use the default client certificate. `GOOGLE_API_USE_CLIENT_CERTIFICATE`
+ environment variable must be set to `true` in order to use this field,
+ otherwise this field doesn't nothing.
+ More details on the environment variables are here:
+ https://google.aip.dev/auth/4114
+ adc_key_path: str, client encrypted private key file path to save the
+ application default client encrypted private key for mTLS. This field is
+ required if you want to use the default client certificate.
+ `GOOGLE_API_USE_CLIENT_CERTIFICATE` environment variable must be set to
+ `true` in order to use this field, otherwise this field doesn't nothing.
+ More details on the environment variables are here:
+ https://google.aip.dev/auth/4114
Returns:
A Resource object with methods for interacting with the service.
+Raises:
+ google.auth.exceptions.MutualTLSChannelError: if there are any problems
+ setting up mutual TLS channel.
+
</pre>
<dl class="fields">
<dt>Decorators:</dt>
@@ -1320,6 +1461,24 @@
</dl>
</td></tr></table>
</div>
+<a name="GOOGLE_API_USE_CLIENT_CERTIFICATE"></a>
+<div class="private">
+<table class="details" border="1" cellpadding="3"
+ cellspacing="0" width="100%" bgcolor="white">
+<tr><td>
+ <h3 class="epydoc">GOOGLE_API_USE_CLIENT_CERTIFICATE</h3>
+
+ <dl class="fields">
+ </dl>
+ <dl class="fields">
+ <dt>Value:</dt>
+ <dd><table><tr><td><pre class="variable">
+"GOOGLE_API_USE_CLIENT_CERTIFICATE"
+</pre></td></tr></table>
+</dd>
+ </dl>
+</td></tr></table>
+</div>
<a name="STACK_QUERY_PARAMETERS"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
@@ -1383,7 +1542,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Thu Apr 30 17:06:05 2020
+ Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"