Skip to content

Commit

Permalink
[skip ci] updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Vi Eng CI committed Jan 26, 2024
1 parent eeffe78 commit 4624f08
Show file tree
Hide file tree
Showing 58 changed files with 422 additions and 63 deletions.
Binary file modified .doctrees/autoapi/storage/blob/index.doctree
View file
Binary file not shown.
Binary file modified .doctrees/autoapi/storage/index.doctree
View file
Binary file not shown.
Binary file modified .doctrees/environment.pickle
View file
Binary file not shown.
6 changes: 5 additions & 1 deletion .github/CONTRIBUTING.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -917,6 +917,8 @@ <h2>Table Of Contents</h2>
<li class="toctree-l5"><a class="reference internal" href="../autoapi/storage/index.html#storage.Blob.download"><code class="docutils literal notranslate"><span class="pre">Blob.download()</span></code></a></li>
<li class="toctree-l5"><a class="reference internal" href="../autoapi/storage/index.html#storage.Blob.upload"><code class="docutils literal notranslate"><span class="pre">Blob.upload()</span></code></a></li>
<li class="toctree-l5"><a class="reference internal" href="../autoapi/storage/index.html#storage.Blob.get_signed_url"><code class="docutils literal notranslate"><span class="pre">Blob.get_signed_url()</span></code></a></li>
<li class="toctree-l5"><a class="reference internal" href="../autoapi/storage/index.html#storage.Blob.get_pem_signature"><code class="docutils literal notranslate"><span class="pre">Blob.get_pem_signature()</span></code></a></li>
<li class="toctree-l5"><a class="reference internal" href="../autoapi/storage/index.html#storage.Blob.get_iam_api_signature"><code class="docutils literal notranslate"><span class="pre">Blob.get_iam_api_signature()</span></code></a></li>
</ul>
</li>
<li class="toctree-l4"><a class="reference internal" href="../autoapi/storage/index.html#storage.Bucket"><code class="docutils literal notranslate"><span class="pre">Bucket</span></code></a><ul>
Expand Down Expand Up @@ -1818,6 +1820,8 @@ <h2>Table Of Contents</h2>
<li class="toctree-l5"><a class="reference internal" href="../autoapi/storage/index.html#storage.Blob.download"><code class="docutils literal notranslate"><span class="pre">Blob.download()</span></code></a></li>
<li class="toctree-l5"><a class="reference internal" href="../autoapi/storage/index.html#storage.Blob.upload"><code class="docutils literal notranslate"><span class="pre">Blob.upload()</span></code></a></li>
<li class="toctree-l5"><a class="reference internal" href="../autoapi/storage/index.html#storage.Blob.get_signed_url"><code class="docutils literal notranslate"><span class="pre">Blob.get_signed_url()</span></code></a></li>
<li class="toctree-l5"><a class="reference internal" href="../autoapi/storage/index.html#storage.Blob.get_pem_signature"><code class="docutils literal notranslate"><span class="pre">Blob.get_pem_signature()</span></code></a></li>
<li class="toctree-l5"><a class="reference internal" href="../autoapi/storage/index.html#storage.Blob.get_iam_api_signature"><code class="docutils literal notranslate"><span class="pre">Blob.get_iam_api_signature()</span></code></a></li>
</ul>
</li>
<li class="toctree-l4"><a class="reference internal" href="../autoapi/storage/index.html#storage.Bucket"><code class="docutils literal notranslate"><span class="pre">Bucket</span></code></a><ul>
Expand Down Expand Up @@ -2055,7 +2059,7 @@ <h3>Releases<a class="headerlink" href="#releases" title="Link to this heading">
<div id="footer-row" class="row">

<div class="col-md-12">
<span title="Built on 2024-01-25" class="pull-right">&copy; Copyright 2017, TalkIQ.
<span title="Built on 2024-01-26" class="pull-right">&copy; Copyright 2017, TalkIQ.
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6 and the
<a href="https://pypi.org/project/sphinx-sizzle-theme/"

Expand Down
6 changes: 5 additions & 1 deletion .github/RELEASE.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -911,6 +911,8 @@ <h2>Table Of Contents</h2>
<li class="toctree-l5"><a class="reference internal" href="../autoapi/storage/index.html#storage.Blob.download"><code class="docutils literal notranslate"><span class="pre">Blob.download()</span></code></a></li>
<li class="toctree-l5"><a class="reference internal" href="../autoapi/storage/index.html#storage.Blob.upload"><code class="docutils literal notranslate"><span class="pre">Blob.upload()</span></code></a></li>
<li class="toctree-l5"><a class="reference internal" href="../autoapi/storage/index.html#storage.Blob.get_signed_url"><code class="docutils literal notranslate"><span class="pre">Blob.get_signed_url()</span></code></a></li>
<li class="toctree-l5"><a class="reference internal" href="../autoapi/storage/index.html#storage.Blob.get_pem_signature"><code class="docutils literal notranslate"><span class="pre">Blob.get_pem_signature()</span></code></a></li>
<li class="toctree-l5"><a class="reference internal" href="../autoapi/storage/index.html#storage.Blob.get_iam_api_signature"><code class="docutils literal notranslate"><span class="pre">Blob.get_iam_api_signature()</span></code></a></li>
</ul>
</li>
<li class="toctree-l4"><a class="reference internal" href="../autoapi/storage/index.html#storage.Bucket"><code class="docutils literal notranslate"><span class="pre">Bucket</span></code></a><ul>
Expand Down Expand Up @@ -1812,6 +1814,8 @@ <h2>Table Of Contents</h2>
<li class="toctree-l5"><a class="reference internal" href="../autoapi/storage/index.html#storage.Blob.download"><code class="docutils literal notranslate"><span class="pre">Blob.download()</span></code></a></li>
<li class="toctree-l5"><a class="reference internal" href="../autoapi/storage/index.html#storage.Blob.upload"><code class="docutils literal notranslate"><span class="pre">Blob.upload()</span></code></a></li>
<li class="toctree-l5"><a class="reference internal" href="../autoapi/storage/index.html#storage.Blob.get_signed_url"><code class="docutils literal notranslate"><span class="pre">Blob.get_signed_url()</span></code></a></li>
<li class="toctree-l5"><a class="reference internal" href="../autoapi/storage/index.html#storage.Blob.get_pem_signature"><code class="docutils literal notranslate"><span class="pre">Blob.get_pem_signature()</span></code></a></li>
<li class="toctree-l5"><a class="reference internal" href="../autoapi/storage/index.html#storage.Blob.get_iam_api_signature"><code class="docutils literal notranslate"><span class="pre">Blob.get_iam_api_signature()</span></code></a></li>
</ul>
</li>
<li class="toctree-l4"><a class="reference internal" href="../autoapi/storage/index.html#storage.Bucket"><code class="docutils literal notranslate"><span class="pre">Bucket</span></code></a><ul>
Expand Down Expand Up @@ -1969,7 +1973,7 @@ <h1>Releasing New Versions<a class="headerlink" href="#releasing-new-versions" t
<div id="footer-row" class="row">

<div class="col-md-12">
<span title="Built on 2024-01-25" class="pull-right">&copy; Copyright 2017, TalkIQ.
<span title="Built on 2024-01-26" class="pull-right">&copy; Copyright 2017, TalkIQ.
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6 and the
<a href="https://pypi.org/project/sphinx-sizzle-theme/"

Expand Down
33 changes: 32 additions & 1 deletion _sources/autoapi/storage/blob/index.rst.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ Classes
.. autoapisummary::

storage.blob.PemKind
storage.blob._SignatureMethod
storage.blob.Blob


Expand Down Expand Up @@ -85,6 +86,27 @@ Attributes



.. py:class:: _SignatureMethod(*args, **kwds)
Bases: :py:obj:`enum.Enum`

Indicates where the url signing will be done through Google's
IAM API or through local signing with a PEM file, which is faster
but requires that the provided token contains client_email and
private_key data

.. py:attribute:: PEM
:value: 0



.. py:attribute:: IAM_API
:value: 1




.. py:class:: Blob(bucket, name, metadata)
Expand All @@ -100,7 +122,7 @@ Attributes
:async:


.. py:method:: get_signed_url(expiration, headers = None, query_params = None, http_method = 'GET', token = None)
.. py:method:: get_signed_url(expiration, headers = None, query_params = None, http_method = 'GET', iam_client = None, service_account_email = None, token = None, session = None)
:async:

Create a temporary access URL for Storage Blob accessible by anyone
Expand All @@ -110,4 +132,13 @@ Attributes
https://cloud.google.com/storage/docs/access-control/signing-urls-manually#python-sample


.. py:method:: get_pem_signature(str_to_sign, private_key)
:staticmethod:


.. py:method:: get_iam_api_signature(str_to_sign, iam_client, service_account_email, session)
:staticmethod:
:async:



11 changes: 10 additions & 1 deletion _sources/autoapi/storage/index.rst.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -210,7 +210,7 @@ Attributes
:async:


.. py:method:: get_signed_url(expiration, headers = None, query_params = None, http_method = 'GET', token = None)
.. py:method:: get_signed_url(expiration, headers = None, query_params = None, http_method = 'GET', iam_client = None, service_account_email = None, token = None, session = None)
:async:

Create a temporary access URL for Storage Blob accessible by anyone
Expand All @@ -220,6 +220,15 @@ Attributes
https://cloud.google.com/storage/docs/access-control/signing-urls-manually#python-sample


.. py:method:: get_pem_signature(str_to_sign, private_key)
:staticmethod:


.. py:method:: get_iam_api_signature(str_to_sign, iam_client, service_account_email, session)
:staticmethod:
:async:



.. py:class:: Bucket(storage, name)
Expand Down
6 changes: 5 additions & 1 deletion autoapi/auth/build_constants/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -917,6 +917,8 @@ <h2>Table Of Contents</h2>
<li class="toctree-l5"><a class="reference internal" href="../../storage/index.html#storage.Blob.download"><code class="docutils literal notranslate"><span class="pre">Blob.download()</span></code></a></li>
<li class="toctree-l5"><a class="reference internal" href="../../storage/index.html#storage.Blob.upload"><code class="docutils literal notranslate"><span class="pre">Blob.upload()</span></code></a></li>
<li class="toctree-l5"><a class="reference internal" href="../../storage/index.html#storage.Blob.get_signed_url"><code class="docutils literal notranslate"><span class="pre">Blob.get_signed_url()</span></code></a></li>
<li class="toctree-l5"><a class="reference internal" href="../../storage/index.html#storage.Blob.get_pem_signature"><code class="docutils literal notranslate"><span class="pre">Blob.get_pem_signature()</span></code></a></li>
<li class="toctree-l5"><a class="reference internal" href="../../storage/index.html#storage.Blob.get_iam_api_signature"><code class="docutils literal notranslate"><span class="pre">Blob.get_iam_api_signature()</span></code></a></li>
</ul>
</li>
<li class="toctree-l4"><a class="reference internal" href="../../storage/index.html#storage.Bucket"><code class="docutils literal notranslate"><span class="pre">Bucket</span></code></a><ul>
Expand Down Expand Up @@ -1818,6 +1820,8 @@ <h2>Table Of Contents</h2>
<li class="toctree-l5"><a class="reference internal" href="../../storage/index.html#storage.Blob.download"><code class="docutils literal notranslate"><span class="pre">Blob.download()</span></code></a></li>
<li class="toctree-l5"><a class="reference internal" href="../../storage/index.html#storage.Blob.upload"><code class="docutils literal notranslate"><span class="pre">Blob.upload()</span></code></a></li>
<li class="toctree-l5"><a class="reference internal" href="../../storage/index.html#storage.Blob.get_signed_url"><code class="docutils literal notranslate"><span class="pre">Blob.get_signed_url()</span></code></a></li>
<li class="toctree-l5"><a class="reference internal" href="../../storage/index.html#storage.Blob.get_pem_signature"><code class="docutils literal notranslate"><span class="pre">Blob.get_pem_signature()</span></code></a></li>
<li class="toctree-l5"><a class="reference internal" href="../../storage/index.html#storage.Blob.get_iam_api_signature"><code class="docutils literal notranslate"><span class="pre">Blob.get_iam_api_signature()</span></code></a></li>
</ul>
</li>
<li class="toctree-l4"><a class="reference internal" href="../../storage/index.html#storage.Bucket"><code class="docutils literal notranslate"><span class="pre">Bucket</span></code></a><ul>
Expand Down Expand Up @@ -1963,7 +1967,7 @@ <h2>Module Contents<a class="headerlink" href="#module-contents" title="Link to
<div id="footer-row" class="row">

<div class="col-md-12">
<span title="Built on 2024-01-25" class="pull-right">&copy; Copyright 2017, TalkIQ.
<span title="Built on 2024-01-26" class="pull-right">&copy; Copyright 2017, TalkIQ.
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6 and the
<a href="https://pypi.org/project/sphinx-sizzle-theme/"

Expand Down
6 changes: 5 additions & 1 deletion autoapi/auth/iam/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -917,6 +917,8 @@ <h2>Table Of Contents</h2>
<li class="toctree-l5"><a class="reference internal" href="../../storage/index.html#storage.Blob.download"><code class="docutils literal notranslate"><span class="pre">Blob.download()</span></code></a></li>
<li class="toctree-l5"><a class="reference internal" href="../../storage/index.html#storage.Blob.upload"><code class="docutils literal notranslate"><span class="pre">Blob.upload()</span></code></a></li>
<li class="toctree-l5"><a class="reference internal" href="../../storage/index.html#storage.Blob.get_signed_url"><code class="docutils literal notranslate"><span class="pre">Blob.get_signed_url()</span></code></a></li>
<li class="toctree-l5"><a class="reference internal" href="../../storage/index.html#storage.Blob.get_pem_signature"><code class="docutils literal notranslate"><span class="pre">Blob.get_pem_signature()</span></code></a></li>
<li class="toctree-l5"><a class="reference internal" href="../../storage/index.html#storage.Blob.get_iam_api_signature"><code class="docutils literal notranslate"><span class="pre">Blob.get_iam_api_signature()</span></code></a></li>
</ul>
</li>
<li class="toctree-l4"><a class="reference internal" href="../../storage/index.html#storage.Bucket"><code class="docutils literal notranslate"><span class="pre">Bucket</span></code></a><ul>
Expand Down Expand Up @@ -1818,6 +1820,8 @@ <h2>Table Of Contents</h2>
<li class="toctree-l5"><a class="reference internal" href="../../storage/index.html#storage.Blob.download"><code class="docutils literal notranslate"><span class="pre">Blob.download()</span></code></a></li>
<li class="toctree-l5"><a class="reference internal" href="../../storage/index.html#storage.Blob.upload"><code class="docutils literal notranslate"><span class="pre">Blob.upload()</span></code></a></li>
<li class="toctree-l5"><a class="reference internal" href="../../storage/index.html#storage.Blob.get_signed_url"><code class="docutils literal notranslate"><span class="pre">Blob.get_signed_url()</span></code></a></li>
<li class="toctree-l5"><a class="reference internal" href="../../storage/index.html#storage.Blob.get_pem_signature"><code class="docutils literal notranslate"><span class="pre">Blob.get_pem_signature()</span></code></a></li>
<li class="toctree-l5"><a class="reference internal" href="../../storage/index.html#storage.Blob.get_iam_api_signature"><code class="docutils literal notranslate"><span class="pre">Blob.get_iam_api_signature()</span></code></a></li>
</ul>
</li>
<li class="toctree-l4"><a class="reference internal" href="../../storage/index.html#storage.Bucket"><code class="docutils literal notranslate"><span class="pre">Bucket</span></code></a><ul>
Expand Down Expand Up @@ -2123,7 +2127,7 @@ <h3>Attributes<a class="headerlink" href="#attributes" title="Link to this headi
<div id="footer-row" class="row">

<div class="col-md-12">
<span title="Built on 2024-01-25" class="pull-right">&copy; Copyright 2017, TalkIQ.
<span title="Built on 2024-01-26" class="pull-right">&copy; Copyright 2017, TalkIQ.
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6 and the
<a href="https://pypi.org/project/sphinx-sizzle-theme/"

Expand Down
6 changes: 5 additions & 1 deletion autoapi/auth/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -917,6 +917,8 @@ <h2>Table Of Contents</h2>
<li class="toctree-l5"><a class="reference internal" href="../storage/index.html#storage.Blob.download"><code class="docutils literal notranslate"><span class="pre">Blob.download()</span></code></a></li>
<li class="toctree-l5"><a class="reference internal" href="../storage/index.html#storage.Blob.upload"><code class="docutils literal notranslate"><span class="pre">Blob.upload()</span></code></a></li>
<li class="toctree-l5"><a class="reference internal" href="../storage/index.html#storage.Blob.get_signed_url"><code class="docutils literal notranslate"><span class="pre">Blob.get_signed_url()</span></code></a></li>
<li class="toctree-l5"><a class="reference internal" href="../storage/index.html#storage.Blob.get_pem_signature"><code class="docutils literal notranslate"><span class="pre">Blob.get_pem_signature()</span></code></a></li>
<li class="toctree-l5"><a class="reference internal" href="../storage/index.html#storage.Blob.get_iam_api_signature"><code class="docutils literal notranslate"><span class="pre">Blob.get_iam_api_signature()</span></code></a></li>
</ul>
</li>
<li class="toctree-l4"><a class="reference internal" href="../storage/index.html#storage.Bucket"><code class="docutils literal notranslate"><span class="pre">Bucket</span></code></a><ul>
Expand Down Expand Up @@ -1818,6 +1820,8 @@ <h2>Table Of Contents</h2>
<li class="toctree-l5"><a class="reference internal" href="../storage/index.html#storage.Blob.download"><code class="docutils literal notranslate"><span class="pre">Blob.download()</span></code></a></li>
<li class="toctree-l5"><a class="reference internal" href="../storage/index.html#storage.Blob.upload"><code class="docutils literal notranslate"><span class="pre">Blob.upload()</span></code></a></li>
<li class="toctree-l5"><a class="reference internal" href="../storage/index.html#storage.Blob.get_signed_url"><code class="docutils literal notranslate"><span class="pre">Blob.get_signed_url()</span></code></a></li>
<li class="toctree-l5"><a class="reference internal" href="../storage/index.html#storage.Blob.get_pem_signature"><code class="docutils literal notranslate"><span class="pre">Blob.get_pem_signature()</span></code></a></li>
<li class="toctree-l5"><a class="reference internal" href="../storage/index.html#storage.Blob.get_iam_api_signature"><code class="docutils literal notranslate"><span class="pre">Blob.get_iam_api_signature()</span></code></a></li>
</ul>
</li>
<li class="toctree-l4"><a class="reference internal" href="../storage/index.html#storage.Bucket"><code class="docutils literal notranslate"><span class="pre">Bucket</span></code></a><ul>
Expand Down Expand Up @@ -2446,7 +2450,7 @@ <h3>Attributes<a class="headerlink" href="#attributes" title="Link to this headi
<div id="footer-row" class="row">

<div class="col-md-12">
<span title="Built on 2024-01-25" class="pull-right">&copy; Copyright 2017, TalkIQ.
<span title="Built on 2024-01-26" class="pull-right">&copy; Copyright 2017, TalkIQ.
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6 and the
<a href="https://pypi.org/project/sphinx-sizzle-theme/"

Expand Down
Loading

0 comments on commit 4624f08

Please sign in to comment.