ngrok/ngrok-api-python
1
0
Fork 0
mirror of https://github.com/ngrok/ngrok-api-python.git synced 2026-06-16 16:54:33 +00:00
Code Issues Packages Projects Releases Wiki Activity

cut new release

Browse Source
This commit is contained in:
ngrok-release-bot
2021-05-21 15:02:28 +00:00
parent 436d30f0cd
commit 9c8e482eaa
65 changed files with 3875 additions and 2521 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/event_streams.html
+22 -9
View File
@@ -110,7 +110,7 @@
<p class="caption"><span class="caption-text">API</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="client.html">Client</a></li>
<li class="toctree-l1"><a class="reference internal" href="objects.html">Objects</a></li>
<li class="toctree-l1"><a class="reference internal" href="datatypes.html">Datatypes</a></li>
<li class="toctree-l1"><a class="reference internal" href="errors.html">Errors</a></li>
</ul>
<p class="caption"><span class="caption-text">Services</span></p>
@@ -183,8 +183,11 @@
<li><p><strong>sampling_rate</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">float</span></code>) – The percentage of all events you would like to capture. Valid values range from 0.01, representing 1% of all events to 1.00, representing 100% of all events.</p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="objects.html#ngrok.objects.EventStream" title="ngrok.objects.EventStream"><code class="xref py py-class docutils literal notranslate"><span class="pre">EventStream</span></code></a></p>
</dl>
<p><a class="reference external" href="https://ngrok.com/docs/api#api-event-streams-create">https://ngrok.com/docs/api#api-event-streams-create</a></p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="datatypes.html#ngrok.datatypes.EventStream" title="ngrok.datatypes.EventStream"><code class="xref py py-class docutils literal notranslate"><span class="pre">EventStream</span></code></a></p>
</dd>
</dl>
</dd></dl>
@@ -197,6 +200,7 @@
<dd class="field-odd"><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – a resource identifier</p>
</dd>
</dl>
<p><a class="reference external" href="https://ngrok.com/docs/api#api-event-streams-delete">https://ngrok.com/docs/api#api-event-streams-delete</a></p>
</dd></dl>
<dl class="py method">
<dt id="ngrok.services.EventStreamsClient.get">
@@ -206,8 +210,11 @@
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – a resource identifier</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="objects.html#ngrok.objects.EventStream" title="ngrok.objects.EventStream"><code class="xref py py-class docutils literal notranslate"><span class="pre">EventStream</span></code></a></p>
</dl>
<p><a class="reference external" href="https://ngrok.com/docs/api#api-event-streams-get">https://ngrok.com/docs/api#api-event-streams-get</a></p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="datatypes.html#ngrok.datatypes.EventStream" title="ngrok.datatypes.EventStream"><code class="xref py py-class docutils literal notranslate"><span class="pre">EventStream</span></code></a></p>
</dd>
</dl>
</dd></dl>
@@ -222,8 +229,11 @@
<li><p><strong>limit</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]) – </p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="objects.html#ngrok.objects.EventStreamList" title="ngrok.objects.EventStreamList"><code class="xref py py-class docutils literal notranslate"><span class="pre">EventStreamList</span></code></a></p>
</dl>
<p><a class="reference external" href="https://ngrok.com/docs/api#api-event-streams-list">https://ngrok.com/docs/api#api-event-streams-list</a></p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="datatypes.html#ngrok.datatypes.EventStreamList" title="ngrok.datatypes.EventStreamList"><code class="xref py py-class docutils literal notranslate"><span class="pre">EventStreamList</span></code></a></p>
</dd>
</dl>
</dd></dl>
@@ -242,8 +252,11 @@
<li><p><strong>sampling_rate</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">float</span></code>]) – The percentage of all events you would like to capture. Valid values range from 0.01, representing 1% of all events to 1.00, representing 100% of all events.</p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference internal" href="objects.html#ngrok.objects.EventStream" title="ngrok.objects.EventStream"><code class="xref py py-class docutils literal notranslate"><span class="pre">EventStream</span></code></a></p>
</dl>
<p><a class="reference external" href="https://ngrok.com/docs/api#api-event-streams-update">https://ngrok.com/docs/api#api-event-streams-update</a></p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference internal" href="datatypes.html#ngrok.datatypes.EventStream" title="ngrok.datatypes.EventStream"><code class="xref py py-class docutils literal notranslate"><span class="pre">EventStream</span></code></a></p>
</dd>
</dl>
</dd></dl>