You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@streampipes.apache.org by bo...@apache.org on 2023/05/14 20:16:03 UTC
[streampipes-website] branch dev updated: chore(python-docs): update python doc assets to recent development state (#82)
This is an automated email from the ASF dual-hosted git repository.
bossenti pushed a commit to branch dev
in repository https://gitbox.apache.org/repos/asf/streampipes-website.git
The following commit(s) were added to refs/heads/dev by this push:
new 4fb7ea45 chore(python-docs): update python doc assets to recent development state (#82)
4fb7ea45 is described below
commit 4fb7ea4573b8b54824d2adfd72922de38b80666d
Author: github-actions[bot] <41...@users.noreply.github.com>
AuthorDate: Sun May 14 22:15:58 2023 +0200
chore(python-docs): update python doc assets to recent development state (#82)
Co-authored-by: bossenti <bo...@users.noreply.github.com>
---
docs-python/dev/404.html | 202 +++++-
.../dev/getting-started/developing/index.html | 202 +++++-
.../dev/getting-started/first-steps/index.html | 213 ++++++-
.../dev/getting-started/quickstart/index.html | 202 +++++-
docs-python/dev/img/interrogate_badge.svg | 55 ++
docs-python/dev/index.html | 202 +++++-
docs-python/dev/objects.inv | Bin 1773 -> 1927 bytes
docs-python/dev/reference/client/client/index.html | 202 +++++-
docs-python/dev/reference/client/config/index.html | 202 +++++-
.../client/credential_provider/index.html | 202 +++++-
.../endpoint/api/data_lake_measure/index.html | 206 +++++-
.../reference/endpoint/api/data_stream/index.html | 204 +++++-
.../broker => endpoint/api/version}/index.html | 687 ++++++++++++---------
.../dev/reference/endpoint/endpoint/index.html | 202 +++++-
.../dev/reference/endpoint/exceptions/index.html | 202 +++++-
.../function_zoo/river_function/index.html | 204 +++++-
.../reference/functions/broker/broker/index.html | 408 ++++++------
.../functions/broker/broker_handler/index.html | 309 ++++++++-
.../{output_collector => consumer}/index.html | 429 +++++++++----
.../kafka_consumer}/index.html | 465 +++++++++-----
.../kafka_message_fetcher}/index.html | 493 +++++++++------
.../kafka_publisher}/index.html | 480 +++++++++-----
.../nats_consumer}/index.html | 463 +++++++++-----
.../nats_publisher}/index.html | 478 +++++++++-----
.../functions/broker/output_collector/index.html | 258 ++++++--
.../{output_collector => publisher}/index.html | 397 +++++++-----
.../functions/function_handler/index.html | 202 +++++-
.../reference/functions/registration/index.html | 202 +++++-
.../functions/streampipes_function/index.html | 202 +++++-
.../functions/utils/async_iter_handler/index.html | 204 +++++-
.../functions/utils/data_stream_context/index.html | 206 +++++-
.../utils/data_stream_generator/index.html | 204 +++++-
.../functions/utils/function_context/index.html | 202 +++++-
docs-python/dev/reference/model/common/index.html | 202 +++++-
.../model/container/data_lake_measures/index.html | 202 +++++-
.../model/container/data_streams/index.html | 202 +++++-
.../model/container/resource_container/index.html | 204 +++++-
.../{data_streams => versions}/index.html | 299 +++++++--
.../model/resource/data_lake_measure/index.html | 204 +++++-
.../model/resource/data_series/index.html | 202 +++++-
.../model/resource/data_stream/index.html | 202 +++++-
.../reference/model/resource/exceptions/index.html | 202 +++++-
.../model/resource/function_definition/index.html | 202 +++++-
.../model/resource/query_result/index.html | 202 +++++-
.../reference/model/resource/resource/index.html | 204 +++++-
.../resource/{data_stream => version}/index.html | 494 +++++++++------
docs-python/dev/scripts/gen_ref_pages/index.html | 214 ++++++-
docs-python/dev/search/search_index.json | 2 +-
docs-python/dev/sitemap.xml | 125 ++--
docs-python/dev/sitemap.xml.gz | Bin 666 -> 705 bytes
.../index.html | 202 +++++-
.../index.html | 202 +++++-
.../index.html | 212 ++++++-
.../index.html | 222 ++++++-
54 files changed, 10921 insertions(+), 2268 deletions(-)
diff --git a/docs-python/dev/404.html b/docs-python/dev/404.html
index a6b5969c..57332d60 100644
--- a/docs-python/dev/404.html
+++ b/docs-python/dev/404.html
@@ -770,6 +770,8 @@
+
+
<label class="md-nav__link" for="__nav_4_2_3" id="__nav_4_2_3_label" tabindex="0">
@@ -812,6 +814,20 @@
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="/docs/docs/python/latest/latest/reference/endpoint/api/version/" class="md-nav__link">
+ Version
+ </a>
+ </li>
+
+
+
+
</ul>
</nav>
</li>
@@ -986,6 +1002,8 @@
+
+
<label class="md-nav__link" for="__nav_4_4_4" id="__nav_4_4_4_label" tabindex="0">
@@ -1034,8 +1052,85 @@
<li class="md-nav__item">
- <a href="/docs/docs/python/latest/latest/reference/functions/broker/kafka_broker/" class="md-nav__link">
- Kafka broker
+ <a href="/docs/docs/python/latest/latest/reference/functions/broker/consumer/" class="md-nav__link">
+ Consumer
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="/docs/docs/python/latest/latest/reference/functions/broker/output_collector/" class="md-nav__link">
+ Output collector
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="/docs/docs/python/latest/latest/reference/functions/broker/publisher/" class="md-nav__link">
+ Publisher
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item md-nav__item--nested">
+
+
+
+
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_4_4_6" >
+
+
+
+
+
+
+
+
+
+
+
+ <label class="md-nav__link" for="__nav_4_4_4_6" id="__nav_4_4_4_6_label" tabindex="0">
+ Kafka
+ <span class="md-nav__icon md-icon"></span>
+ </label>
+
+ <nav class="md-nav" data-md-level="4" aria-labelledby="__nav_4_4_4_6_label" aria-expanded="false">
+ <label class="md-nav__title" for="__nav_4_4_4_6">
+ <span class="md-nav__icon md-icon"></span>
+ Kafka
+ </label>
+ <ul class="md-nav__list" data-md-scrollfix>
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="/docs/docs/python/latest/latest/reference/functions/broker/kafka/kafka_consumer/" class="md-nav__link">
+ Kafka consumer
</a>
</li>
@@ -1048,7 +1143,7 @@
<li class="md-nav__item">
- <a href="/docs/docs/python/latest/latest/reference/functions/broker/kafka_message_fetcher/" class="md-nav__link">
+ <a href="/docs/docs/python/latest/latest/reference/functions/broker/kafka/kafka_message_fetcher/" class="md-nav__link">
Kafka message fetcher
</a>
</li>
@@ -1062,22 +1157,76 @@
<li class="md-nav__item">
- <a href="/docs/docs/python/latest/latest/reference/functions/broker/nats_broker/" class="md-nav__link">
- Nats broker
+ <a href="/docs/docs/python/latest/latest/reference/functions/broker/kafka/kafka_publisher/" class="md-nav__link">
+ Kafka publisher
</a>
</li>
+ </ul>
+ </nav>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item md-nav__item--nested">
+
+
+
+
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_4_4_7" >
+
+
+
+
+
+
+
+
+
+ <label class="md-nav__link" for="__nav_4_4_4_7" id="__nav_4_4_4_7_label" tabindex="0">
+ Nats
+ <span class="md-nav__icon md-icon"></span>
+ </label>
+
+ <nav class="md-nav" data-md-level="4" aria-labelledby="__nav_4_4_4_7_label" aria-expanded="false">
+ <label class="md-nav__title" for="__nav_4_4_4_7">
+ <span class="md-nav__icon md-icon"></span>
+ Nats
+ </label>
+ <ul class="md-nav__list" data-md-scrollfix>
+
<li class="md-nav__item">
- <a href="/docs/docs/python/latest/latest/reference/functions/broker/output_collector/" class="md-nav__link">
- Output collector
+ <a href="/docs/docs/python/latest/latest/reference/functions/broker/nats/nats_consumer/" class="md-nav__link">
+ Nats consumer
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="/docs/docs/python/latest/latest/reference/functions/broker/nats/nats_publisher/" class="md-nav__link">
+ Nats publisher
</a>
</li>
@@ -1091,6 +1240,13 @@
+ </ul>
+ </nav>
+ </li>
+
+
+
+
@@ -1268,6 +1424,8 @@
+
+
<label class="md-nav__link" for="__nav_4_5_2" id="__nav_4_5_2_label" tabindex="0">
@@ -1324,6 +1482,20 @@
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="/docs/docs/python/latest/latest/reference/model/container/versions/" class="md-nav__link">
+ Versions
+ </a>
+ </li>
+
+
+
+
</ul>
</nav>
</li>
@@ -1360,6 +1532,8 @@
+
+
<label class="md-nav__link" for="__nav_4_5_3" id="__nav_4_5_3_label" tabindex="0">
@@ -1472,6 +1646,20 @@
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="/docs/docs/python/latest/latest/reference/model/resource/version/" class="md-nav__link">
+ Version
+ </a>
+ </li>
+
+
+
+
</ul>
</nav>
</li>
diff --git a/docs-python/dev/getting-started/developing/index.html b/docs-python/dev/getting-started/developing/index.html
index 4b918f85..def866f5 100644
--- a/docs-python/dev/getting-started/developing/index.html
+++ b/docs-python/dev/getting-started/developing/index.html
@@ -856,6 +856,8 @@
+
+
<label class="md-nav__link" for="__nav_4_2_3" id="__nav_4_2_3_label" tabindex="0">
@@ -898,6 +900,20 @@
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../../reference/endpoint/api/version/" class="md-nav__link">
+ Version
+ </a>
+ </li>
+
+
+
+
</ul>
</nav>
</li>
@@ -1072,6 +1088,8 @@
+
+
<label class="md-nav__link" for="__nav_4_4_4" id="__nav_4_4_4_label" tabindex="0">
@@ -1120,8 +1138,85 @@
<li class="md-nav__item">
- <a href="../../reference/functions/broker/kafka_broker/" class="md-nav__link">
- Kafka broker
+ <a href="../../reference/functions/broker/consumer/" class="md-nav__link">
+ Consumer
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../../reference/functions/broker/output_collector/" class="md-nav__link">
+ Output collector
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../../reference/functions/broker/publisher/" class="md-nav__link">
+ Publisher
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item md-nav__item--nested">
+
+
+
+
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_4_4_6" >
+
+
+
+
+
+
+
+
+
+
+
+ <label class="md-nav__link" for="__nav_4_4_4_6" id="__nav_4_4_4_6_label" tabindex="0">
+ Kafka
+ <span class="md-nav__icon md-icon"></span>
+ </label>
+
+ <nav class="md-nav" data-md-level="4" aria-labelledby="__nav_4_4_4_6_label" aria-expanded="false">
+ <label class="md-nav__title" for="__nav_4_4_4_6">
+ <span class="md-nav__icon md-icon"></span>
+ Kafka
+ </label>
+ <ul class="md-nav__list" data-md-scrollfix>
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../../reference/functions/broker/kafka/kafka_consumer/" class="md-nav__link">
+ Kafka consumer
</a>
</li>
@@ -1134,7 +1229,7 @@
<li class="md-nav__item">
- <a href="../../reference/functions/broker/kafka_message_fetcher/" class="md-nav__link">
+ <a href="../../reference/functions/broker/kafka/kafka_message_fetcher/" class="md-nav__link">
Kafka message fetcher
</a>
</li>
@@ -1148,22 +1243,76 @@
<li class="md-nav__item">
- <a href="../../reference/functions/broker/nats_broker/" class="md-nav__link">
- Nats broker
+ <a href="../../reference/functions/broker/kafka/kafka_publisher/" class="md-nav__link">
+ Kafka publisher
</a>
</li>
+ </ul>
+ </nav>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item md-nav__item--nested">
+
+
+
+
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_4_4_7" >
+
+
+
+
+
+
+
+
+
+ <label class="md-nav__link" for="__nav_4_4_4_7" id="__nav_4_4_4_7_label" tabindex="0">
+ Nats
+ <span class="md-nav__icon md-icon"></span>
+ </label>
+
+ <nav class="md-nav" data-md-level="4" aria-labelledby="__nav_4_4_4_7_label" aria-expanded="false">
+ <label class="md-nav__title" for="__nav_4_4_4_7">
+ <span class="md-nav__icon md-icon"></span>
+ Nats
+ </label>
+ <ul class="md-nav__list" data-md-scrollfix>
+
<li class="md-nav__item">
- <a href="../../reference/functions/broker/output_collector/" class="md-nav__link">
- Output collector
+ <a href="../../reference/functions/broker/nats/nats_consumer/" class="md-nav__link">
+ Nats consumer
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../../reference/functions/broker/nats/nats_publisher/" class="md-nav__link">
+ Nats publisher
</a>
</li>
@@ -1177,6 +1326,13 @@
+ </ul>
+ </nav>
+ </li>
+
+
+
+
@@ -1354,6 +1510,8 @@
+
+
<label class="md-nav__link" for="__nav_4_5_2" id="__nav_4_5_2_label" tabindex="0">
@@ -1410,6 +1568,20 @@
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../../reference/model/container/versions/" class="md-nav__link">
+ Versions
+ </a>
+ </li>
+
+
+
+
</ul>
</nav>
</li>
@@ -1446,6 +1618,8 @@
+
+
<label class="md-nav__link" for="__nav_4_5_3" id="__nav_4_5_3_label" tabindex="0">
@@ -1558,6 +1732,20 @@
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../../reference/model/resource/version/" class="md-nav__link">
+ Version
+ </a>
+ </li>
+
+
+
+
</ul>
</nav>
</li>
diff --git a/docs-python/dev/getting-started/first-steps/index.html b/docs-python/dev/getting-started/first-steps/index.html
index f8bdf95e..0bf56eaf 100644
--- a/docs-python/dev/getting-started/first-steps/index.html
+++ b/docs-python/dev/getting-started/first-steps/index.html
@@ -842,6 +842,8 @@
+
+
<label class="md-nav__link" for="__nav_4_2_3" id="__nav_4_2_3_label" tabindex="0">
@@ -884,6 +886,20 @@
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../../reference/endpoint/api/version/" class="md-nav__link">
+ Version
+ </a>
+ </li>
+
+
+
+
</ul>
</nav>
</li>
@@ -1058,6 +1074,8 @@
+
+
<label class="md-nav__link" for="__nav_4_4_4" id="__nav_4_4_4_label" tabindex="0">
@@ -1106,8 +1124,36 @@
<li class="md-nav__item">
- <a href="../../reference/functions/broker/kafka_broker/" class="md-nav__link">
- Kafka broker
+ <a href="../../reference/functions/broker/consumer/" class="md-nav__link">
+ Consumer
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../../reference/functions/broker/output_collector/" class="md-nav__link">
+ Output collector
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../../reference/functions/broker/publisher/" class="md-nav__link">
+ Publisher
</a>
</li>
@@ -1119,8 +1165,57 @@
+
+ <li class="md-nav__item md-nav__item--nested">
+
+
+
+
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_4_4_6" >
+
+
+
+
+
+
+
+
+
+
+
+ <label class="md-nav__link" for="__nav_4_4_4_6" id="__nav_4_4_4_6_label" tabindex="0">
+ Kafka
+ <span class="md-nav__icon md-icon"></span>
+ </label>
+
+ <nav class="md-nav" data-md-level="4" aria-labelledby="__nav_4_4_4_6_label" aria-expanded="false">
+ <label class="md-nav__title" for="__nav_4_4_4_6">
+ <span class="md-nav__icon md-icon"></span>
+ Kafka
+ </label>
+ <ul class="md-nav__list" data-md-scrollfix>
+
+
+
+
+
+
<li class="md-nav__item">
- <a href="../../reference/functions/broker/kafka_message_fetcher/" class="md-nav__link">
+ <a href="../../reference/functions/broker/kafka/kafka_consumer/" class="md-nav__link">
+ Kafka consumer
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../../reference/functions/broker/kafka/kafka_message_fetcher/" class="md-nav__link">
Kafka message fetcher
</a>
</li>
@@ -1134,22 +1229,76 @@
<li class="md-nav__item">
- <a href="../../reference/functions/broker/nats_broker/" class="md-nav__link">
- Nats broker
+ <a href="../../reference/functions/broker/kafka/kafka_publisher/" class="md-nav__link">
+ Kafka publisher
</a>
</li>
+ </ul>
+ </nav>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item md-nav__item--nested">
+
+
+
+
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_4_4_7" >
+
+
+
+
+
+
+
+
+
+ <label class="md-nav__link" for="__nav_4_4_4_7" id="__nav_4_4_4_7_label" tabindex="0">
+ Nats
+ <span class="md-nav__icon md-icon"></span>
+ </label>
+
+ <nav class="md-nav" data-md-level="4" aria-labelledby="__nav_4_4_4_7_label" aria-expanded="false">
+ <label class="md-nav__title" for="__nav_4_4_4_7">
+ <span class="md-nav__icon md-icon"></span>
+ Nats
+ </label>
+ <ul class="md-nav__list" data-md-scrollfix>
+
<li class="md-nav__item">
- <a href="../../reference/functions/broker/output_collector/" class="md-nav__link">
- Output collector
+ <a href="../../reference/functions/broker/nats/nats_consumer/" class="md-nav__link">
+ Nats consumer
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../../reference/functions/broker/nats/nats_publisher/" class="md-nav__link">
+ Nats publisher
</a>
</li>
@@ -1163,6 +1312,13 @@
+ </ul>
+ </nav>
+ </li>
+
+
+
+
@@ -1340,6 +1496,8 @@
+
+
<label class="md-nav__link" for="__nav_4_5_2" id="__nav_4_5_2_label" tabindex="0">
@@ -1396,6 +1554,20 @@
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../../reference/model/container/versions/" class="md-nav__link">
+ Versions
+ </a>
+ </li>
+
+
+
+
</ul>
</nav>
</li>
@@ -1432,6 +1604,8 @@
+
+
<label class="md-nav__link" for="__nav_4_5_3" id="__nav_4_5_3_label" tabindex="0">
@@ -1544,6 +1718,20 @@
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../../reference/model/resource/version/" class="md-nav__link">
+ Version
+ </a>
+ </li>
+
+
+
+
</ul>
</nav>
</li>
@@ -1691,7 +1879,16 @@ Thereby, when running locally, we need to add the following port mapping entry t
<p>Once all services are started, you can access StreamPipes via <code>http://localhost</code>.</p>
<h4 id="setup-streampipes-with-kafka-as-message-broker">Setup StreamPipes with Kafka as message broker<a class="headerlink" href="#setup-streampipes-with-kafka-as-message-broker" title="Permanent link">¶</a></h4>
<p>Alternatively, you can use <code>docker-compose.yml</code> to start StreamPipes with Kafka as messaging layer.
-Therefore, you onyl need to execute the following command:
+When running locally we have to modify <code>services.kafka.environment</code> and add the ports to <code>services.kafka.ports</code>:
+<div class="language-yaml highlight"><pre><span></span><code><span class="nt">environment</span><span class="p">:</span>
+<span class="w"> </span><span class="nt">KAFKA_LISTENER_SECURITY_PROTOCOL_MAP</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">PLAINTEXT:PLAINTEXT,OUTSIDE:PLAINTEXT</span>
+<span class="w"> </span><span class="nt">KAFKA_ADVERTISED_LISTENERS</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">PLAINTEXT://:9092,OUTSIDE://localhost:9094</span>
+<span class="w"> </span><span class="nt">KAFKA_LISTENERS</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">PLAINTEXT://:9092,OUTSIDE://:9094</span>
+<span class="nn">...</span>
+<span class="nt">ports</span><span class="p">:</span>
+<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">9094:9094</span>
+</code></pre></div>
+Then, you need to execute the following command:
<div class="language-bash highlight"><pre><span></span><code>docker-compose<span class="w"> </span>-f<span class="w"> </span>docker-compose.yml<span class="w"> </span>up<span class="w"> </span>-d
</code></pre></div></p>
<p>Once all services are started, you can access StreamPipes via <code>http://localhost</code>.</p>
diff --git a/docs-python/dev/getting-started/quickstart/index.html b/docs-python/dev/getting-started/quickstart/index.html
index 8e803efe..226b8976 100644
--- a/docs-python/dev/getting-started/quickstart/index.html
+++ b/docs-python/dev/getting-started/quickstart/index.html
@@ -795,6 +795,8 @@
+
+
<label class="md-nav__link" for="__nav_4_2_3" id="__nav_4_2_3_label" tabindex="0">
@@ -837,6 +839,20 @@
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../../reference/endpoint/api/version/" class="md-nav__link">
+ Version
+ </a>
+ </li>
+
+
+
+
</ul>
</nav>
</li>
@@ -1011,6 +1027,8 @@
+
+
<label class="md-nav__link" for="__nav_4_4_4" id="__nav_4_4_4_label" tabindex="0">
@@ -1059,8 +1077,85 @@
<li class="md-nav__item">
- <a href="../../reference/functions/broker/kafka_broker/" class="md-nav__link">
- Kafka broker
+ <a href="../../reference/functions/broker/consumer/" class="md-nav__link">
+ Consumer
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../../reference/functions/broker/output_collector/" class="md-nav__link">
+ Output collector
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../../reference/functions/broker/publisher/" class="md-nav__link">
+ Publisher
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item md-nav__item--nested">
+
+
+
+
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_4_4_6" >
+
+
+
+
+
+
+
+
+
+
+
+ <label class="md-nav__link" for="__nav_4_4_4_6" id="__nav_4_4_4_6_label" tabindex="0">
+ Kafka
+ <span class="md-nav__icon md-icon"></span>
+ </label>
+
+ <nav class="md-nav" data-md-level="4" aria-labelledby="__nav_4_4_4_6_label" aria-expanded="false">
+ <label class="md-nav__title" for="__nav_4_4_4_6">
+ <span class="md-nav__icon md-icon"></span>
+ Kafka
+ </label>
+ <ul class="md-nav__list" data-md-scrollfix>
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../../reference/functions/broker/kafka/kafka_consumer/" class="md-nav__link">
+ Kafka consumer
</a>
</li>
@@ -1073,7 +1168,7 @@
<li class="md-nav__item">
- <a href="../../reference/functions/broker/kafka_message_fetcher/" class="md-nav__link">
+ <a href="../../reference/functions/broker/kafka/kafka_message_fetcher/" class="md-nav__link">
Kafka message fetcher
</a>
</li>
@@ -1087,22 +1182,76 @@
<li class="md-nav__item">
- <a href="../../reference/functions/broker/nats_broker/" class="md-nav__link">
- Nats broker
+ <a href="../../reference/functions/broker/kafka/kafka_publisher/" class="md-nav__link">
+ Kafka publisher
</a>
</li>
+ </ul>
+ </nav>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item md-nav__item--nested">
+
+
+
+
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_4_4_7" >
+
+
+
+
+
+
+
+
+
+ <label class="md-nav__link" for="__nav_4_4_4_7" id="__nav_4_4_4_7_label" tabindex="0">
+ Nats
+ <span class="md-nav__icon md-icon"></span>
+ </label>
+
+ <nav class="md-nav" data-md-level="4" aria-labelledby="__nav_4_4_4_7_label" aria-expanded="false">
+ <label class="md-nav__title" for="__nav_4_4_4_7">
+ <span class="md-nav__icon md-icon"></span>
+ Nats
+ </label>
+ <ul class="md-nav__list" data-md-scrollfix>
+
<li class="md-nav__item">
- <a href="../../reference/functions/broker/output_collector/" class="md-nav__link">
- Output collector
+ <a href="../../reference/functions/broker/nats/nats_consumer/" class="md-nav__link">
+ Nats consumer
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../../reference/functions/broker/nats/nats_publisher/" class="md-nav__link">
+ Nats publisher
</a>
</li>
@@ -1116,6 +1265,13 @@
+ </ul>
+ </nav>
+ </li>
+
+
+
+
@@ -1293,6 +1449,8 @@
+
+
<label class="md-nav__link" for="__nav_4_5_2" id="__nav_4_5_2_label" tabindex="0">
@@ -1349,6 +1507,20 @@
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../../reference/model/container/versions/" class="md-nav__link">
+ Versions
+ </a>
+ </li>
+
+
+
+
</ul>
</nav>
</li>
@@ -1385,6 +1557,8 @@
+
+
<label class="md-nav__link" for="__nav_4_5_3" id="__nav_4_5_3_label" tabindex="0">
@@ -1497,6 +1671,20 @@
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../../reference/model/resource/version/" class="md-nav__link">
+ Version
+ </a>
+ </li>
+
+
+
+
</ul>
</nav>
</li>
diff --git a/docs-python/dev/img/interrogate_badge.svg b/docs-python/dev/img/interrogate_badge.svg
new file mode 100644
index 00000000..c4d5627d
--- /dev/null
+++ b/docs-python/dev/img/interrogate_badge.svg
@@ -0,0 +1,55 @@
+<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="140" height="20" role="img" aria-label="interrogate: 100%">
+ <title>interrogate: 100%</title>
+ <linearGradient id="s" x2="0" y2="100%">
+ <stop offset="0" stop-color="#bbb" stop-opacity=".1"/>
+ <stop offset="1" stop-opacity=".1"/>
+ </linearGradient>
+ <clipPath id="r">
+ <rect width="140" height="20" rx="3" fill="#fff"/>
+ </clipPath>
+ <g clip-path="url(#r)">
+ <rect width="93" height="20" fill="#555"/>
+ <rect x="93" width="47" height="20" fill="#4c1"/>
+ <rect width="140" height="20" fill="url(#s)"/>
+ </g>
+ <g fill="#fff" text-anchor="middle" font-family="Verdana,Geneva,DejaVu Sans,sans-serif" text-rendering="geometricPrecision" font-size="110">
+ <text aria-hidden="true" x="590" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="610">interrogate</text>
+ <text x="590" y="140" transform="scale(.1)" fill="#fff" textLength="610">interrogate</text>
+ <text aria-hidden="true" x="1160" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="330">100%</text>
+ <text x="1160" y="140" transform="scale(.1)" fill="#fff" textLength="330" data-interrogate="result">100%</text>
+ </g>
+ <g id="logo-shadow" transform="matrix(0.854876,0,0,0.854876,-6.73514,1.732)">
+ <g transform="matrix(0.299012,0,0,0.299012,9.70229,-6.68582)">
+ <path d="M50,64.25C52.76,64.25 55,61.13 55,59.75C55,58.37 52.76,57.25 50,57.25C47.24,57.25 45,58.37 45,59.75C45,61.13 47.24,64.25 50,64.25Z" style="fill:rgb(1,1,1);fill-opacity:0.3;fill-rule:nonzero;"/>
+ </g>
+ <g transform="matrix(0.299012,0,0,0.299012,9.70229,-6.68582)">
+ <path d="M88,49.05C86.506,43.475 83.018,38.638 78.2,35.46C72.969,32.002 66.539,30.844 60.43,32.26C56.576,33.145 52.995,34.958 50,37.54C46.998,34.958 43.411,33.149 39.55,32.27C33.441,30.853 27.011,32.011 21.78,35.47C16.97,38.652 13.489,43.489 12,49.06L12,49.13C11.82,49.79 11.66,50.46 11.53,51.13C11.146,53.207 11.021,55.323 11.16,57.43C11.16,58.03 11.26,58.63 11.34,59.23C11.34,59.51 11.43,59.79 11.48,60.07C11.53,60.35 11.58,60.68 11.64,60.98C11.7,61.28 11.8,61.69 11.89,62.05C11 [...]
+ </g>
+ <g transform="matrix(0.299012,0,0,0.299012,9.70229,-6.68582)">
+ <circle cx="71.33" cy="56" r="5.16" style="fill:rgb(1,1,1);fill-opacity:0.3;"/>
+ </g>
+ <g transform="matrix(0.299012,0,0,0.299012,9.70229,-6.68582)">
+ <circle cx="28.67" cy="56" r="5.16" style="fill:rgb(1,1,1);fill-opacity:0.3;"/>
+ </g>
+ <g transform="matrix(0.299012,0,0,0.299012,9.70229,-6.68582)">
+ <path d="M58,66C55.912,68.161 53.003,69.339 50,69.24C46.997,69.339 44.088,68.161 42,66C41.714,65.677 41.302,65.491 40.87,65.491C40.042,65.491 39.361,66.172 39.361,67C39.361,67.368 39.496,67.724 39.74,68C42.403,70.804 46.134,72.35 50,72.25C53.862,72.347 57.59,70.802 60.25,68C60.495,67.725 60.63,67.369 60.63,67C60.63,66.174 59.951,65.495 59.125,65.495C58.695,65.495 58.285,65.679 58,66Z" style="fill:rgb(1,1,1);fill-opacity:0.3;fill-rule:nonzero;"/>
+ </g>
+ </g>
+ <g id="logo-pink" transform="matrix(0.854876,0,0,0.854876,-6.73514,0.877124)">
+ <g transform="matrix(0.299012,0,0,0.299012,9.70229,-6.68582)">
+ <path d="M50,64.25C52.76,64.25 55,61.13 55,59.75C55,58.37 52.76,57.25 50,57.25C47.24,57.25 45,58.37 45,59.75C45,61.13 47.24,64.25 50,64.25Z" style="fill:rgb(222,120,160);fill-rule:nonzero;"/>
+ </g>
+ <g transform="matrix(0.299012,0,0,0.299012,9.70229,-6.68582)">
+ <path d="M88,49.05C86.506,43.475 83.018,38.638 78.2,35.46C72.969,32.002 66.539,30.844 60.43,32.26C56.576,33.145 52.995,34.958 50,37.54C46.998,34.958 43.411,33.149 39.55,32.27C33.441,30.853 27.011,32.011 21.78,35.47C16.97,38.652 13.489,43.489 12,49.06L12,49.13C11.82,49.79 11.66,50.46 11.53,51.13C11.146,53.207 11.021,55.323 11.16,57.43C11.16,58.03 11.26,58.63 11.34,59.23C11.34,59.51 11.43,59.79 11.48,60.07C11.53,60.35 11.58,60.68 11.64,60.98C11.7,61.28 11.8,61.69 11.89,62.05C11 [...]
+ </g>
+ <g transform="matrix(0.299012,0,0,0.299012,9.70229,-6.68582)">
+ <circle cx="71.33" cy="56" r="5.16" style="fill:rgb(222,120,160);"/>
+ </g>
+ <g transform="matrix(0.299012,0,0,0.299012,9.70229,-6.68582)">
+ <circle cx="28.67" cy="56" r="5.16" style="fill:rgb(222,120,160);"/>
+ </g>
+ <g transform="matrix(0.299012,0,0,0.299012,9.70229,-6.68582)">
+ <path d="M58,66C55.912,68.161 53.003,69.339 50,69.24C46.997,69.339 44.088,68.161 42,66C41.714,65.677 41.302,65.491 40.87,65.491C40.042,65.491 39.361,66.172 39.361,67C39.361,67.368 39.496,67.724 39.74,68C42.403,70.804 46.134,72.35 50,72.25C53.862,72.347 57.59,70.802 60.25,68C60.495,67.725 60.63,67.369 60.63,67C60.63,66.174 59.951,65.495 59.125,65.495C58.695,65.495 58.285,65.679 58,66Z" style="fill:rgb(222,120,160);fill-rule:nonzero;"/>
+ </g>
+ </g>
+</svg>
diff --git a/docs-python/dev/index.html b/docs-python/dev/index.html
index 157f0196..4050fd1c 100644
--- a/docs-python/dev/index.html
+++ b/docs-python/dev/index.html
@@ -818,6 +818,8 @@
+
+
<label class="md-nav__link" for="__nav_4_2_3" id="__nav_4_2_3_label" tabindex="0">
@@ -860,6 +862,20 @@
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="reference/endpoint/api/version/" class="md-nav__link">
+ Version
+ </a>
+ </li>
+
+
+
+
</ul>
</nav>
</li>
@@ -1034,6 +1050,8 @@
+
+
<label class="md-nav__link" for="__nav_4_4_4" id="__nav_4_4_4_label" tabindex="0">
@@ -1082,8 +1100,85 @@
<li class="md-nav__item">
- <a href="reference/functions/broker/kafka_broker/" class="md-nav__link">
- Kafka broker
+ <a href="reference/functions/broker/consumer/" class="md-nav__link">
+ Consumer
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="reference/functions/broker/output_collector/" class="md-nav__link">
+ Output collector
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="reference/functions/broker/publisher/" class="md-nav__link">
+ Publisher
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item md-nav__item--nested">
+
+
+
+
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_4_4_6" >
+
+
+
+
+
+
+
+
+
+
+
+ <label class="md-nav__link" for="__nav_4_4_4_6" id="__nav_4_4_4_6_label" tabindex="0">
+ Kafka
+ <span class="md-nav__icon md-icon"></span>
+ </label>
+
+ <nav class="md-nav" data-md-level="4" aria-labelledby="__nav_4_4_4_6_label" aria-expanded="false">
+ <label class="md-nav__title" for="__nav_4_4_4_6">
+ <span class="md-nav__icon md-icon"></span>
+ Kafka
+ </label>
+ <ul class="md-nav__list" data-md-scrollfix>
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="reference/functions/broker/kafka/kafka_consumer/" class="md-nav__link">
+ Kafka consumer
</a>
</li>
@@ -1096,7 +1191,7 @@
<li class="md-nav__item">
- <a href="reference/functions/broker/kafka_message_fetcher/" class="md-nav__link">
+ <a href="reference/functions/broker/kafka/kafka_message_fetcher/" class="md-nav__link">
Kafka message fetcher
</a>
</li>
@@ -1110,22 +1205,76 @@
<li class="md-nav__item">
- <a href="reference/functions/broker/nats_broker/" class="md-nav__link">
- Nats broker
+ <a href="reference/functions/broker/kafka/kafka_publisher/" class="md-nav__link">
+ Kafka publisher
</a>
</li>
+ </ul>
+ </nav>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item md-nav__item--nested">
+
+
+
+
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_4_4_7" >
+
+
+
+
+
+
+
+
+
+ <label class="md-nav__link" for="__nav_4_4_4_7" id="__nav_4_4_4_7_label" tabindex="0">
+ Nats
+ <span class="md-nav__icon md-icon"></span>
+ </label>
+
+ <nav class="md-nav" data-md-level="4" aria-labelledby="__nav_4_4_4_7_label" aria-expanded="false">
+ <label class="md-nav__title" for="__nav_4_4_4_7">
+ <span class="md-nav__icon md-icon"></span>
+ Nats
+ </label>
+ <ul class="md-nav__list" data-md-scrollfix>
+
<li class="md-nav__item">
- <a href="reference/functions/broker/output_collector/" class="md-nav__link">
- Output collector
+ <a href="reference/functions/broker/nats/nats_consumer/" class="md-nav__link">
+ Nats consumer
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="reference/functions/broker/nats/nats_publisher/" class="md-nav__link">
+ Nats publisher
</a>
</li>
@@ -1139,6 +1288,13 @@
+ </ul>
+ </nav>
+ </li>
+
+
+
+
@@ -1316,6 +1472,8 @@
+
+
<label class="md-nav__link" for="__nav_4_5_2" id="__nav_4_5_2_label" tabindex="0">
@@ -1372,6 +1530,20 @@
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="reference/model/container/versions/" class="md-nav__link">
+ Versions
+ </a>
+ </li>
+
+
+
+
</ul>
</nav>
</li>
@@ -1408,6 +1580,8 @@
+
+
<label class="md-nav__link" for="__nav_4_5_3" id="__nav_4_5_3_label" tabindex="0">
@@ -1520,6 +1694,20 @@
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="reference/model/resource/version/" class="md-nav__link">
+ Version
+ </a>
+ </li>
+
+
+
+
</ul>
</nav>
</li>
diff --git a/docs-python/dev/objects.inv b/docs-python/dev/objects.inv
index 8bb93520..70d7510b 100644
Binary files a/docs-python/dev/objects.inv and b/docs-python/dev/objects.inv differ
diff --git a/docs-python/dev/reference/client/client/index.html b/docs-python/dev/reference/client/client/index.html
index 68707ea7..2af4b465 100644
--- a/docs-python/dev/reference/client/client/index.html
+++ b/docs-python/dev/reference/client/client/index.html
@@ -865,6 +865,8 @@
+
+
<label class="md-nav__link" for="__nav_4_2_3" id="__nav_4_2_3_label" tabindex="0">
@@ -907,6 +909,20 @@
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../../endpoint/api/version/" class="md-nav__link">
+ Version
+ </a>
+ </li>
+
+
+
+
</ul>
</nav>
</li>
@@ -1081,6 +1097,8 @@
+
+
<label class="md-nav__link" for="__nav_4_4_4" id="__nav_4_4_4_label" tabindex="0">
@@ -1129,8 +1147,85 @@
<li class="md-nav__item">
- <a href="../../functions/broker/kafka_broker/" class="md-nav__link">
- Kafka broker
+ <a href="../../functions/broker/consumer/" class="md-nav__link">
+ Consumer
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../../functions/broker/output_collector/" class="md-nav__link">
+ Output collector
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../../functions/broker/publisher/" class="md-nav__link">
+ Publisher
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item md-nav__item--nested">
+
+
+
+
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_4_4_6" >
+
+
+
+
+
+
+
+
+
+
+
+ <label class="md-nav__link" for="__nav_4_4_4_6" id="__nav_4_4_4_6_label" tabindex="0">
+ Kafka
+ <span class="md-nav__icon md-icon"></span>
+ </label>
+
+ <nav class="md-nav" data-md-level="4" aria-labelledby="__nav_4_4_4_6_label" aria-expanded="false">
+ <label class="md-nav__title" for="__nav_4_4_4_6">
+ <span class="md-nav__icon md-icon"></span>
+ Kafka
+ </label>
+ <ul class="md-nav__list" data-md-scrollfix>
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../../functions/broker/kafka/kafka_consumer/" class="md-nav__link">
+ Kafka consumer
</a>
</li>
@@ -1143,7 +1238,7 @@
<li class="md-nav__item">
- <a href="../../functions/broker/kafka_message_fetcher/" class="md-nav__link">
+ <a href="../../functions/broker/kafka/kafka_message_fetcher/" class="md-nav__link">
Kafka message fetcher
</a>
</li>
@@ -1157,22 +1252,76 @@
<li class="md-nav__item">
- <a href="../../functions/broker/nats_broker/" class="md-nav__link">
- Nats broker
+ <a href="../../functions/broker/kafka/kafka_publisher/" class="md-nav__link">
+ Kafka publisher
</a>
</li>
+ </ul>
+ </nav>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item md-nav__item--nested">
+
+
+
+
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_4_4_7" >
+
+
+
+
+
+
+
+
+
+ <label class="md-nav__link" for="__nav_4_4_4_7" id="__nav_4_4_4_7_label" tabindex="0">
+ Nats
+ <span class="md-nav__icon md-icon"></span>
+ </label>
+
+ <nav class="md-nav" data-md-level="4" aria-labelledby="__nav_4_4_4_7_label" aria-expanded="false">
+ <label class="md-nav__title" for="__nav_4_4_4_7">
+ <span class="md-nav__icon md-icon"></span>
+ Nats
+ </label>
+ <ul class="md-nav__list" data-md-scrollfix>
+
<li class="md-nav__item">
- <a href="../../functions/broker/output_collector/" class="md-nav__link">
- Output collector
+ <a href="../../functions/broker/nats/nats_consumer/" class="md-nav__link">
+ Nats consumer
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../../functions/broker/nats/nats_publisher/" class="md-nav__link">
+ Nats publisher
</a>
</li>
@@ -1186,6 +1335,13 @@
+ </ul>
+ </nav>
+ </li>
+
+
+
+
@@ -1363,6 +1519,8 @@
+
+
<label class="md-nav__link" for="__nav_4_5_2" id="__nav_4_5_2_label" tabindex="0">
@@ -1419,6 +1577,20 @@
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../../model/container/versions/" class="md-nav__link">
+ Versions
+ </a>
+ </li>
+
+
+
+
</ul>
</nav>
</li>
@@ -1455,6 +1627,8 @@
+
+
<label class="md-nav__link" for="__nav_4_5_3" id="__nav_4_5_3_label" tabindex="0">
@@ -1567,6 +1741,20 @@
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../../model/resource/version/" class="md-nav__link">
+ Version
+ </a>
+ </li>
+
+
+
+
</ul>
</nav>
</li>
diff --git a/docs-python/dev/reference/client/config/index.html b/docs-python/dev/reference/client/config/index.html
index 240c5d4e..4c520919 100644
--- a/docs-python/dev/reference/client/config/index.html
+++ b/docs-python/dev/reference/client/config/index.html
@@ -831,6 +831,8 @@
+
+
<label class="md-nav__link" for="__nav_4_2_3" id="__nav_4_2_3_label" tabindex="0">
@@ -873,6 +875,20 @@
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../../endpoint/api/version/" class="md-nav__link">
+ Version
+ </a>
+ </li>
+
+
+
+
</ul>
</nav>
</li>
@@ -1047,6 +1063,8 @@
+
+
<label class="md-nav__link" for="__nav_4_4_4" id="__nav_4_4_4_label" tabindex="0">
@@ -1095,8 +1113,85 @@
<li class="md-nav__item">
- <a href="../../functions/broker/kafka_broker/" class="md-nav__link">
- Kafka broker
+ <a href="../../functions/broker/consumer/" class="md-nav__link">
+ Consumer
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../../functions/broker/output_collector/" class="md-nav__link">
+ Output collector
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../../functions/broker/publisher/" class="md-nav__link">
+ Publisher
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item md-nav__item--nested">
+
+
+
+
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_4_4_6" >
+
+
+
+
+
+
+
+
+
+
+
+ <label class="md-nav__link" for="__nav_4_4_4_6" id="__nav_4_4_4_6_label" tabindex="0">
+ Kafka
+ <span class="md-nav__icon md-icon"></span>
+ </label>
+
+ <nav class="md-nav" data-md-level="4" aria-labelledby="__nav_4_4_4_6_label" aria-expanded="false">
+ <label class="md-nav__title" for="__nav_4_4_4_6">
+ <span class="md-nav__icon md-icon"></span>
+ Kafka
+ </label>
+ <ul class="md-nav__list" data-md-scrollfix>
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../../functions/broker/kafka/kafka_consumer/" class="md-nav__link">
+ Kafka consumer
</a>
</li>
@@ -1109,7 +1204,7 @@
<li class="md-nav__item">
- <a href="../../functions/broker/kafka_message_fetcher/" class="md-nav__link">
+ <a href="../../functions/broker/kafka/kafka_message_fetcher/" class="md-nav__link">
Kafka message fetcher
</a>
</li>
@@ -1123,22 +1218,76 @@
<li class="md-nav__item">
- <a href="../../functions/broker/nats_broker/" class="md-nav__link">
- Nats broker
+ <a href="../../functions/broker/kafka/kafka_publisher/" class="md-nav__link">
+ Kafka publisher
</a>
</li>
+ </ul>
+ </nav>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item md-nav__item--nested">
+
+
+
+
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_4_4_7" >
+
+
+
+
+
+
+
+
+
+ <label class="md-nav__link" for="__nav_4_4_4_7" id="__nav_4_4_4_7_label" tabindex="0">
+ Nats
+ <span class="md-nav__icon md-icon"></span>
+ </label>
+
+ <nav class="md-nav" data-md-level="4" aria-labelledby="__nav_4_4_4_7_label" aria-expanded="false">
+ <label class="md-nav__title" for="__nav_4_4_4_7">
+ <span class="md-nav__icon md-icon"></span>
+ Nats
+ </label>
+ <ul class="md-nav__list" data-md-scrollfix>
+
<li class="md-nav__item">
- <a href="../../functions/broker/output_collector/" class="md-nav__link">
- Output collector
+ <a href="../../functions/broker/nats/nats_consumer/" class="md-nav__link">
+ Nats consumer
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../../functions/broker/nats/nats_publisher/" class="md-nav__link">
+ Nats publisher
</a>
</li>
@@ -1152,6 +1301,13 @@
+ </ul>
+ </nav>
+ </li>
+
+
+
+
@@ -1329,6 +1485,8 @@
+
+
<label class="md-nav__link" for="__nav_4_5_2" id="__nav_4_5_2_label" tabindex="0">
@@ -1385,6 +1543,20 @@
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../../model/container/versions/" class="md-nav__link">
+ Versions
+ </a>
+ </li>
+
+
+
+
</ul>
</nav>
</li>
@@ -1421,6 +1593,8 @@
+
+
<label class="md-nav__link" for="__nav_4_5_3" id="__nav_4_5_3_label" tabindex="0">
@@ -1533,6 +1707,20 @@
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../../model/resource/version/" class="md-nav__link">
+ Version
+ </a>
+ </li>
+
+
+
+
</ul>
</nav>
</li>
diff --git a/docs-python/dev/reference/client/credential_provider/index.html b/docs-python/dev/reference/client/credential_provider/index.html
index a64692ca..d9e1ec79 100644
--- a/docs-python/dev/reference/client/credential_provider/index.html
+++ b/docs-python/dev/reference/client/credential_provider/index.html
@@ -864,6 +864,8 @@
+
+
<label class="md-nav__link" for="__nav_4_2_3" id="__nav_4_2_3_label" tabindex="0">
@@ -906,6 +908,20 @@
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../../endpoint/api/version/" class="md-nav__link">
+ Version
+ </a>
+ </li>
+
+
+
+
</ul>
</nav>
</li>
@@ -1080,6 +1096,8 @@
+
+
<label class="md-nav__link" for="__nav_4_4_4" id="__nav_4_4_4_label" tabindex="0">
@@ -1128,8 +1146,85 @@
<li class="md-nav__item">
- <a href="../../functions/broker/kafka_broker/" class="md-nav__link">
- Kafka broker
+ <a href="../../functions/broker/consumer/" class="md-nav__link">
+ Consumer
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../../functions/broker/output_collector/" class="md-nav__link">
+ Output collector
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../../functions/broker/publisher/" class="md-nav__link">
+ Publisher
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item md-nav__item--nested">
+
+
+
+
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_4_4_6" >
+
+
+
+
+
+
+
+
+
+
+
+ <label class="md-nav__link" for="__nav_4_4_4_6" id="__nav_4_4_4_6_label" tabindex="0">
+ Kafka
+ <span class="md-nav__icon md-icon"></span>
+ </label>
+
+ <nav class="md-nav" data-md-level="4" aria-labelledby="__nav_4_4_4_6_label" aria-expanded="false">
+ <label class="md-nav__title" for="__nav_4_4_4_6">
+ <span class="md-nav__icon md-icon"></span>
+ Kafka
+ </label>
+ <ul class="md-nav__list" data-md-scrollfix>
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../../functions/broker/kafka/kafka_consumer/" class="md-nav__link">
+ Kafka consumer
</a>
</li>
@@ -1142,7 +1237,7 @@
<li class="md-nav__item">
- <a href="../../functions/broker/kafka_message_fetcher/" class="md-nav__link">
+ <a href="../../functions/broker/kafka/kafka_message_fetcher/" class="md-nav__link">
Kafka message fetcher
</a>
</li>
@@ -1156,22 +1251,76 @@
<li class="md-nav__item">
- <a href="../../functions/broker/nats_broker/" class="md-nav__link">
- Nats broker
+ <a href="../../functions/broker/kafka/kafka_publisher/" class="md-nav__link">
+ Kafka publisher
</a>
</li>
+ </ul>
+ </nav>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item md-nav__item--nested">
+
+
+
+
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_4_4_7" >
+
+
+
+
+
+
+
+
+
+ <label class="md-nav__link" for="__nav_4_4_4_7" id="__nav_4_4_4_7_label" tabindex="0">
+ Nats
+ <span class="md-nav__icon md-icon"></span>
+ </label>
+
+ <nav class="md-nav" data-md-level="4" aria-labelledby="__nav_4_4_4_7_label" aria-expanded="false">
+ <label class="md-nav__title" for="__nav_4_4_4_7">
+ <span class="md-nav__icon md-icon"></span>
+ Nats
+ </label>
+ <ul class="md-nav__list" data-md-scrollfix>
+
<li class="md-nav__item">
- <a href="../../functions/broker/output_collector/" class="md-nav__link">
- Output collector
+ <a href="../../functions/broker/nats/nats_consumer/" class="md-nav__link">
+ Nats consumer
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../../functions/broker/nats/nats_publisher/" class="md-nav__link">
+ Nats publisher
</a>
</li>
@@ -1185,6 +1334,13 @@
+ </ul>
+ </nav>
+ </li>
+
+
+
+
@@ -1362,6 +1518,8 @@
+
+
<label class="md-nav__link" for="__nav_4_5_2" id="__nav_4_5_2_label" tabindex="0">
@@ -1418,6 +1576,20 @@
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../../model/container/versions/" class="md-nav__link">
+ Versions
+ </a>
+ </li>
+
+
+
+
</ul>
</nav>
</li>
@@ -1454,6 +1626,8 @@
+
+
<label class="md-nav__link" for="__nav_4_5_3" id="__nav_4_5_3_label" tabindex="0">
@@ -1566,6 +1740,20 @@
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../../model/resource/version/" class="md-nav__link">
+ Version
+ </a>
+ </li>
+
+
+
+
</ul>
</nav>
</li>
diff --git a/docs-python/dev/reference/endpoint/api/data_lake_measure/index.html b/docs-python/dev/reference/endpoint/api/data_lake_measure/index.html
index 611d9351..8f03650d 100644
--- a/docs-python/dev/reference/endpoint/api/data_lake_measure/index.html
+++ b/docs-python/dev/reference/endpoint/api/data_lake_measure/index.html
@@ -789,6 +789,8 @@
+
+
<label class="md-nav__link" for="__nav_4_2_3" id="__nav_4_2_3_label" tabindex="0">
@@ -922,6 +924,20 @@
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../version/" class="md-nav__link">
+ Version
+ </a>
+ </li>
+
+
+
+
</ul>
</nav>
</li>
@@ -1096,6 +1112,8 @@
+
+
<label class="md-nav__link" for="__nav_4_4_4" id="__nav_4_4_4_label" tabindex="0">
@@ -1144,8 +1162,85 @@
<li class="md-nav__item">
- <a href="../../../functions/broker/kafka_broker/" class="md-nav__link">
- Kafka broker
+ <a href="../../../functions/broker/consumer/" class="md-nav__link">
+ Consumer
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../../../functions/broker/output_collector/" class="md-nav__link">
+ Output collector
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../../../functions/broker/publisher/" class="md-nav__link">
+ Publisher
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item md-nav__item--nested">
+
+
+
+
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_4_4_6" >
+
+
+
+
+
+
+
+
+
+
+
+ <label class="md-nav__link" for="__nav_4_4_4_6" id="__nav_4_4_4_6_label" tabindex="0">
+ Kafka
+ <span class="md-nav__icon md-icon"></span>
+ </label>
+
+ <nav class="md-nav" data-md-level="4" aria-labelledby="__nav_4_4_4_6_label" aria-expanded="false">
+ <label class="md-nav__title" for="__nav_4_4_4_6">
+ <span class="md-nav__icon md-icon"></span>
+ Kafka
+ </label>
+ <ul class="md-nav__list" data-md-scrollfix>
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../../../functions/broker/kafka/kafka_consumer/" class="md-nav__link">
+ Kafka consumer
</a>
</li>
@@ -1158,7 +1253,7 @@
<li class="md-nav__item">
- <a href="../../../functions/broker/kafka_message_fetcher/" class="md-nav__link">
+ <a href="../../../functions/broker/kafka/kafka_message_fetcher/" class="md-nav__link">
Kafka message fetcher
</a>
</li>
@@ -1172,22 +1267,76 @@
<li class="md-nav__item">
- <a href="../../../functions/broker/nats_broker/" class="md-nav__link">
- Nats broker
+ <a href="../../../functions/broker/kafka/kafka_publisher/" class="md-nav__link">
+ Kafka publisher
</a>
</li>
+ </ul>
+ </nav>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item md-nav__item--nested">
+
+
+
+
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_4_4_7" >
+
+
+
+
+
+
+
+
+
+ <label class="md-nav__link" for="__nav_4_4_4_7" id="__nav_4_4_4_7_label" tabindex="0">
+ Nats
+ <span class="md-nav__icon md-icon"></span>
+ </label>
+
+ <nav class="md-nav" data-md-level="4" aria-labelledby="__nav_4_4_4_7_label" aria-expanded="false">
+ <label class="md-nav__title" for="__nav_4_4_4_7">
+ <span class="md-nav__icon md-icon"></span>
+ Nats
+ </label>
+ <ul class="md-nav__list" data-md-scrollfix>
+
<li class="md-nav__item">
- <a href="../../../functions/broker/output_collector/" class="md-nav__link">
- Output collector
+ <a href="../../../functions/broker/nats/nats_consumer/" class="md-nav__link">
+ Nats consumer
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../../../functions/broker/nats/nats_publisher/" class="md-nav__link">
+ Nats publisher
</a>
</li>
@@ -1201,6 +1350,13 @@
+ </ul>
+ </nav>
+ </li>
+
+
+
+
@@ -1378,6 +1534,8 @@
+
+
<label class="md-nav__link" for="__nav_4_5_2" id="__nav_4_5_2_label" tabindex="0">
@@ -1434,6 +1592,20 @@
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../../../model/container/versions/" class="md-nav__link">
+ Versions
+ </a>
+ </li>
+
+
+
+
</ul>
</nav>
</li>
@@ -1470,6 +1642,8 @@
+
+
<label class="md-nav__link" for="__nav_4_5_3" id="__nav_4_5_3_label" tabindex="0">
@@ -1582,6 +1756,20 @@
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../../../model/resource/version/" class="md-nav__link">
+ Version
+ </a>
+ </li>
+
+
+
+
</ul>
</nav>
</li>
@@ -1744,8 +1932,8 @@ This endpoint allows to consume data stored in StreamPipes' data lake.</p>
<p>Implementation of the DataLakeMeasure endpoint.</p>
-<p>This endpoint provides an interfact to all data stored in the StreamPipes data lake.</p>
-<p>Consequently, it allows uerying metadata about available data sets (see <code>all()</code> method).
+<p>This endpoint provides an interface to all data stored in the StreamPipes data lake.</p>
+<p>Consequently, it allows querying metadata about available data sets (see <code>all()</code> method).
The metadata is returned as an instance of <a class="autorefs autorefs-internal" href="../../../model/container/data_lake_measures/#streampipes.model.container.data_lake_measures.DataLakeMeasures"><code>DataLakeMeasures</code></a>.</p>
<p>In addition, the endpoint provides direct access to the data stored in the data laka by querying a
specific data lake measure using the <code>get()</code> method.</p>
diff --git a/docs-python/dev/reference/endpoint/api/data_stream/index.html b/docs-python/dev/reference/endpoint/api/data_stream/index.html
index d045a9dc..02af14b1 100644
--- a/docs-python/dev/reference/endpoint/api/data_stream/index.html
+++ b/docs-python/dev/reference/endpoint/api/data_stream/index.html
@@ -37,7 +37,7 @@
<link rel="prev" href="../data_lake_measure/">
- <link rel="next" href="../../../function_zoo/river_function/">
+ <link rel="next" href="../version/">
<link rel="icon" href="https://streampipes.apache.org/img/favicon/favicon.png">
<meta name="generator" content="mkdocs-1.4.2, mkdocs-material-9.1.3">
@@ -789,6 +789,8 @@
+
+
<label class="md-nav__link" for="__nav_4_2_3" id="__nav_4_2_3_label" tabindex="0">
@@ -875,6 +877,20 @@
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../version/" class="md-nav__link">
+ Version
+ </a>
+ </li>
+
+
+
+
</ul>
</nav>
</li>
@@ -1049,6 +1065,8 @@
+
+
<label class="md-nav__link" for="__nav_4_4_4" id="__nav_4_4_4_label" tabindex="0">
@@ -1097,8 +1115,85 @@
<li class="md-nav__item">
- <a href="../../../functions/broker/kafka_broker/" class="md-nav__link">
- Kafka broker
+ <a href="../../../functions/broker/consumer/" class="md-nav__link">
+ Consumer
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../../../functions/broker/output_collector/" class="md-nav__link">
+ Output collector
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../../../functions/broker/publisher/" class="md-nav__link">
+ Publisher
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item md-nav__item--nested">
+
+
+
+
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_4_4_6" >
+
+
+
+
+
+
+
+
+
+
+
+ <label class="md-nav__link" for="__nav_4_4_4_6" id="__nav_4_4_4_6_label" tabindex="0">
+ Kafka
+ <span class="md-nav__icon md-icon"></span>
+ </label>
+
+ <nav class="md-nav" data-md-level="4" aria-labelledby="__nav_4_4_4_6_label" aria-expanded="false">
+ <label class="md-nav__title" for="__nav_4_4_4_6">
+ <span class="md-nav__icon md-icon"></span>
+ Kafka
+ </label>
+ <ul class="md-nav__list" data-md-scrollfix>
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../../../functions/broker/kafka/kafka_consumer/" class="md-nav__link">
+ Kafka consumer
</a>
</li>
@@ -1111,7 +1206,7 @@
<li class="md-nav__item">
- <a href="../../../functions/broker/kafka_message_fetcher/" class="md-nav__link">
+ <a href="../../../functions/broker/kafka/kafka_message_fetcher/" class="md-nav__link">
Kafka message fetcher
</a>
</li>
@@ -1125,22 +1220,76 @@
<li class="md-nav__item">
- <a href="../../../functions/broker/nats_broker/" class="md-nav__link">
- Nats broker
+ <a href="../../../functions/broker/kafka/kafka_publisher/" class="md-nav__link">
+ Kafka publisher
</a>
</li>
+ </ul>
+ </nav>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item md-nav__item--nested">
+
+
+
+
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_4_4_7" >
+
+
+
+
+
+
+
+
+
+ <label class="md-nav__link" for="__nav_4_4_4_7" id="__nav_4_4_4_7_label" tabindex="0">
+ Nats
+ <span class="md-nav__icon md-icon"></span>
+ </label>
+
+ <nav class="md-nav" data-md-level="4" aria-labelledby="__nav_4_4_4_7_label" aria-expanded="false">
+ <label class="md-nav__title" for="__nav_4_4_4_7">
+ <span class="md-nav__icon md-icon"></span>
+ Nats
+ </label>
+ <ul class="md-nav__list" data-md-scrollfix>
+
<li class="md-nav__item">
- <a href="../../../functions/broker/output_collector/" class="md-nav__link">
- Output collector
+ <a href="../../../functions/broker/nats/nats_consumer/" class="md-nav__link">
+ Nats consumer
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../../../functions/broker/nats/nats_publisher/" class="md-nav__link">
+ Nats publisher
</a>
</li>
@@ -1154,6 +1303,13 @@
+ </ul>
+ </nav>
+ </li>
+
+
+
+
@@ -1331,6 +1487,8 @@
+
+
<label class="md-nav__link" for="__nav_4_5_2" id="__nav_4_5_2_label" tabindex="0">
@@ -1387,6 +1545,20 @@
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../../../model/container/versions/" class="md-nav__link">
+ Versions
+ </a>
+ </li>
+
+
+
+
</ul>
</nav>
</li>
@@ -1423,6 +1595,8 @@
+
+
<label class="md-nav__link" for="__nav_4_5_3" id="__nav_4_5_3_label" tabindex="0">
@@ -1535,6 +1709,20 @@
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../../../model/resource/version/" class="md-nav__link">
+ Version
+ </a>
+ </li>
+
+
+
+
</ul>
</nav>
</li>
diff --git a/docs-python/dev/reference/functions/broker/broker/index.html b/docs-python/dev/reference/endpoint/api/version/index.html
similarity index 76%
copy from docs-python/dev/reference/functions/broker/broker/index.html
copy to docs-python/dev/reference/endpoint/api/version/index.html
index 89484777..0fc65c1a 100644
--- a/docs-python/dev/reference/functions/broker/broker/index.html
+++ b/docs-python/dev/reference/endpoint/api/version/index.html
@@ -31,20 +31,20 @@
<meta name="author" content="Apache Software Foundation (ASF)">
- <link rel="canonical" href="https://streampipes.apache.org/docs/docs/python/latest/latest/reference/functions/broker/broker/">
+ <link rel="canonical" href="https://streampipes.apache.org/docs/docs/python/latest/latest/reference/endpoint/api/version/">
- <link rel="prev" href="../../streampipes_function/">
+ <link rel="prev" href="../data_stream/">
- <link rel="next" href="../broker_handler/">
+ <link rel="next" href="../../../function_zoo/river_function/">
<link rel="icon" href="https://streampipes.apache.org/img/favicon/favicon.png">
<meta name="generator" content="mkdocs-1.4.2, mkdocs-material-9.1.3">
- <title>Broker - Apache StreamPipes Python</title>
+ <title>Version - Apache StreamPipes Python</title>
@@ -136,7 +136,7 @@
<div data-md-component="skip">
- <a href="#streampipes.functions.broker.broker" class="md-skip">
+ <a href="#streampipes.endpoint.api.version" class="md-skip">
Skip to content
</a>
@@ -174,7 +174,7 @@
<div class="md-header__topic" data-md-component="header-topic">
<span class="md-ellipsis">
- Broker
+ Version
</span>
</div>
@@ -707,14 +707,16 @@
+
+
- <li class="md-nav__item md-nav__item--nested">
+ <li class="md-nav__item md-nav__item--active md-nav__item--nested">
- <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_2" >
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_2" checked>
@@ -731,7 +733,7 @@
<span class="md-nav__icon md-icon"></span>
</label>
- <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_2_label" aria-expanded="false">
+ <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_2_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_4_2">
<span class="md-nav__icon md-icon"></span>
Endpoint
@@ -744,7 +746,7 @@
<li class="md-nav__item">
- <a href="../../../endpoint/endpoint/" class="md-nav__link">
+ <a href="../../endpoint/" class="md-nav__link">
Endpoint
</a>
</li>
@@ -758,7 +760,7 @@
<li class="md-nav__item">
- <a href="../../../endpoint/exceptions/" class="md-nav__link">
+ <a href="../../exceptions/" class="md-nav__link">
Exceptions
</a>
</li>
@@ -770,14 +772,16 @@
+
+
- <li class="md-nav__item md-nav__item--nested">
+ <li class="md-nav__item md-nav__item--active md-nav__item--nested">
- <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_2_3" >
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_2_3" checked>
@@ -785,6 +789,8 @@
+
+
<label class="md-nav__link" for="__nav_4_2_3" id="__nav_4_2_3_label" tabindex="0">
@@ -792,7 +798,7 @@
<span class="md-nav__icon md-icon"></span>
</label>
- <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_4_2_3_label" aria-expanded="false">
+ <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_4_2_3_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_4_2_3">
<span class="md-nav__icon md-icon"></span>
Api
@@ -805,7 +811,7 @@
<li class="md-nav__item">
- <a href="../../../endpoint/api/data_lake_measure/" class="md-nav__link">
+ <a href="../data_lake_measure/" class="md-nav__link">
Data lake measure
</a>
</li>
@@ -819,7 +825,7 @@
<li class="md-nav__item">
- <a href="../../../endpoint/api/data_stream/" class="md-nav__link">
+ <a href="../data_stream/" class="md-nav__link">
Data stream
</a>
</li>
@@ -827,6 +833,91 @@
+
+
+
+
+
+
+
+ <li class="md-nav__item md-nav__item--active">
+
+ <input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
+
+
+
+ <label class="md-nav__link md-nav__link--active" for="__toc">
+ Version
+ <span class="md-nav__icon md-icon"></span>
+ </label>
+
+ <a href="./" class="md-nav__link md-nav__link--active">
+ Version
+ </a>
+
+
+
+<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
+
+
+
+
+ <label class="md-nav__title" for="__toc">
+ <span class="md-nav__icon md-icon"></span>
+ Table of contents
+ </label>
+ <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
+
+ <li class="md-nav__item">
+ <a href="#streampipes.endpoint.api.version" class="md-nav__link">
+ streampipes.endpoint.api.version
+ </a>
+
+</li>
+
+ <li class="md-nav__item">
+ <a href="#streampipes.endpoint.api.version.VersionEndpoint" class="md-nav__link">
+ VersionEndpoint
+ </a>
+
+ <nav class="md-nav" aria-label="VersionEndpoint">
+ <ul class="md-nav__list">
+
+ <li class="md-nav__item">
+ <a href="#streampipes.endpoint.api.version.VersionEndpoint.all" class="md-nav__link">
+ all()
+ </a>
+
+</li>
+
+ <li class="md-nav__item">
+ <a href="#streampipes.endpoint.api.version.VersionEndpoint.get" class="md-nav__link">
+ get()
+ </a>
+
+</li>
+
+ <li class="md-nav__item">
+ <a href="#streampipes.endpoint.api.version.VersionEndpoint.post" class="md-nav__link">
+ post()
+ </a>
+
+</li>
+
+ </ul>
+ </nav>
+
+</li>
+
+ </ul>
+
+</nav>
+
+ </li>
+
+
+
+
</ul>
</nav>
</li>
@@ -897,16 +988,14 @@
-
-
- <li class="md-nav__item md-nav__item--active md-nav__item--nested">
+ <li class="md-nav__item md-nav__item--nested">
- <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_4" checked>
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_4" >
@@ -927,7 +1016,7 @@
<span class="md-nav__icon md-icon"></span>
</label>
- <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_4_label" aria-expanded="true">
+ <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_4_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_4_4">
<span class="md-nav__icon md-icon"></span>
Functions
@@ -940,7 +1029,7 @@
<li class="md-nav__item">
- <a href="../../function_handler/" class="md-nav__link">
+ <a href="../../../functions/function_handler/" class="md-nav__link">
Function handler
</a>
</li>
@@ -954,7 +1043,7 @@
<li class="md-nav__item">
- <a href="../../registration/" class="md-nav__link">
+ <a href="../../../functions/registration/" class="md-nav__link">
Registration
</a>
</li>
@@ -968,7 +1057,7 @@
<li class="md-nav__item">
- <a href="../../streampipes_function/" class="md-nav__link">
+ <a href="../../../functions/streampipes_function/" class="md-nav__link">
Streampipes function
</a>
</li>
@@ -980,16 +1069,14 @@
-
-
- <li class="md-nav__item md-nav__item--active md-nav__item--nested">
+ <li class="md-nav__item md-nav__item--nested">
- <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_4_4" checked>
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_4_4" >
@@ -1005,6 +1092,8 @@
+
+
<label class="md-nav__link" for="__nav_4_4_4" id="__nav_4_4_4_label" tabindex="0">
@@ -1012,7 +1101,7 @@
<span class="md-nav__icon md-icon"></span>
</label>
- <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_4_4_4_label" aria-expanded="true">
+ <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_4_4_4_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_4_4_4">
<span class="md-nav__icon md-icon"></span>
Broker
@@ -1023,96 +1112,67 @@
-
-
- <li class="md-nav__item md-nav__item--active">
-
- <input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
-
-
-
- <label class="md-nav__link md-nav__link--active" for="__toc">
- Broker
- <span class="md-nav__icon md-icon"></span>
- </label>
-
- <a href="./" class="md-nav__link md-nav__link--active">
+ <li class="md-nav__item">
+ <a href="../../../functions/broker/broker/" class="md-nav__link">
Broker
</a>
-
-
+ </li>
+
-<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../../../functions/broker/broker_handler/" class="md-nav__link">
+ Broker handler
+ </a>
+ </li>
- <label class="md-nav__title" for="__toc">
- <span class="md-nav__icon md-icon"></span>
- Table of contents
- </label>
- <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
-
- <li class="md-nav__item">
- <a href="#streampipes.functions.broker.broker" class="md-nav__link">
- streampipes.functions.broker.broker
- </a>
+
+
+
+
+
-</li>
-
- <li class="md-nav__item">
- <a href="#streampipes.functions.broker.broker.Broker" class="md-nav__link">
- Broker
- </a>
- <nav class="md-nav" aria-label="Broker">
- <ul class="md-nav__list">
-
- <li class="md-nav__item">
- <a href="#streampipes.functions.broker.broker.Broker.connect" class="md-nav__link">
- connect()
- </a>
-</li>
-
- <li class="md-nav__item">
- <a href="#streampipes.functions.broker.broker.Broker.createSubscription" class="md-nav__link">
- createSubscription()
- </a>
+ <li class="md-nav__item">
+ <a href="../../../functions/broker/consumer/" class="md-nav__link">
+ Consumer
+ </a>
+ </li>
-</li>
-
- <li class="md-nav__item">
- <a href="#streampipes.functions.broker.broker.Broker.disconnect" class="md-nav__link">
- disconnect()
- </a>
+
+
+
+
+
-</li>
-
- <li class="md-nav__item">
- <a href="#streampipes.functions.broker.broker.Broker.get_message" class="md-nav__link">
- get_message()
- </a>
-</li>
-
- <li class="md-nav__item">
- <a href="#streampipes.functions.broker.broker.Broker.publish_event" class="md-nav__link">
- publish_event()
- </a>
-</li>
-
- </ul>
- </nav>
+ <li class="md-nav__item">
+ <a href="../../../functions/broker/output_collector/" class="md-nav__link">
+ Output collector
+ </a>
+ </li>
-</li>
-
- </ul>
+
+
+
+
+
-</nav>
-
+
+
+ <li class="md-nav__item">
+ <a href="../../../functions/broker/publisher/" class="md-nav__link">
+ Publisher
+ </a>
</li>
@@ -1123,9 +1183,44 @@
+
+ <li class="md-nav__item md-nav__item--nested">
+
+
+
+
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_4_4_6" >
+
+
+
+
+
+
+
+
+
+
+
+ <label class="md-nav__link" for="__nav_4_4_4_6" id="__nav_4_4_4_6_label" tabindex="0">
+ Kafka
+ <span class="md-nav__icon md-icon"></span>
+ </label>
+
+ <nav class="md-nav" data-md-level="4" aria-labelledby="__nav_4_4_4_6_label" aria-expanded="false">
+ <label class="md-nav__title" for="__nav_4_4_4_6">
+ <span class="md-nav__icon md-icon"></span>
+ Kafka
+ </label>
+ <ul class="md-nav__list" data-md-scrollfix>
+
+
+
+
+
+
<li class="md-nav__item">
- <a href="../broker_handler/" class="md-nav__link">
- Broker handler
+ <a href="../../../functions/broker/kafka/kafka_consumer/" class="md-nav__link">
+ Kafka consumer
</a>
</li>
@@ -1138,8 +1233,8 @@
<li class="md-nav__item">
- <a href="../kafka_broker/" class="md-nav__link">
- Kafka broker
+ <a href="../../../functions/broker/kafka/kafka_message_fetcher/" class="md-nav__link">
+ Kafka message fetcher
</a>
</li>
@@ -1152,22 +1247,62 @@
<li class="md-nav__item">
- <a href="../kafka_message_fetcher/" class="md-nav__link">
- Kafka message fetcher
+ <a href="../../../functions/broker/kafka/kafka_publisher/" class="md-nav__link">
+ Kafka publisher
</a>
</li>
+ </ul>
+ </nav>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item md-nav__item--nested">
+
+
+
+
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_4_4_7" >
+
+
+
+
+
+
+
+
+
+ <label class="md-nav__link" for="__nav_4_4_4_7" id="__nav_4_4_4_7_label" tabindex="0">
+ Nats
+ <span class="md-nav__icon md-icon"></span>
+ </label>
+
+ <nav class="md-nav" data-md-level="4" aria-labelledby="__nav_4_4_4_7_label" aria-expanded="false">
+ <label class="md-nav__title" for="__nav_4_4_4_7">
+ <span class="md-nav__icon md-icon"></span>
+ Nats
+ </label>
+ <ul class="md-nav__list" data-md-scrollfix>
+
<li class="md-nav__item">
- <a href="../nats_broker/" class="md-nav__link">
- Nats broker
+ <a href="../../../functions/broker/nats/nats_consumer/" class="md-nav__link">
+ Nats consumer
</a>
</li>
@@ -1180,8 +1315,8 @@
<li class="md-nav__item">
- <a href="../output_collector/" class="md-nav__link">
- Output collector
+ <a href="../../../functions/broker/nats/nats_publisher/" class="md-nav__link">
+ Nats publisher
</a>
</li>
@@ -1195,6 +1330,13 @@
+ </ul>
+ </nav>
+ </li>
+
+
+
+
@@ -1238,7 +1380,7 @@
<li class="md-nav__item">
- <a href="../../utils/async_iter_handler/" class="md-nav__link">
+ <a href="../../../functions/utils/async_iter_handler/" class="md-nav__link">
Async iter handler
</a>
</li>
@@ -1252,7 +1394,7 @@
<li class="md-nav__item">
- <a href="../../utils/data_stream_context/" class="md-nav__link">
+ <a href="../../../functions/utils/data_stream_context/" class="md-nav__link">
Data stream context
</a>
</li>
@@ -1266,7 +1408,7 @@
<li class="md-nav__item">
- <a href="../../utils/data_stream_generator/" class="md-nav__link">
+ <a href="../../../functions/utils/data_stream_generator/" class="md-nav__link">
Data stream generator
</a>
</li>
@@ -1280,7 +1422,7 @@
<li class="md-nav__item">
- <a href="../../utils/function_context/" class="md-nav__link">
+ <a href="../../../functions/utils/function_context/" class="md-nav__link">
Function context
</a>
</li>
@@ -1372,6 +1514,8 @@
+
+
<label class="md-nav__link" for="__nav_4_5_2" id="__nav_4_5_2_label" tabindex="0">
@@ -1428,6 +1572,20 @@
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../../../model/container/versions/" class="md-nav__link">
+ Versions
+ </a>
+ </li>
+
+
+
+
</ul>
</nav>
</li>
@@ -1464,6 +1622,8 @@
+
+
<label class="md-nav__link" for="__nav_4_5_3" id="__nav_4_5_3_label" tabindex="0">
@@ -1576,6 +1736,20 @@
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../../../model/resource/version/" class="md-nav__link">
+ Version
+ </a>
+ </li>
+
+
+
+
</ul>
</nav>
</li>
@@ -1621,51 +1795,37 @@
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
- <a href="#streampipes.functions.broker.broker" class="md-nav__link">
- streampipes.functions.broker.broker
+ <a href="#streampipes.endpoint.api.version" class="md-nav__link">
+ streampipes.endpoint.api.version
</a>
</li>
<li class="md-nav__item">
- <a href="#streampipes.functions.broker.broker.Broker" class="md-nav__link">
- Broker
+ <a href="#streampipes.endpoint.api.version.VersionEndpoint" class="md-nav__link">
+ VersionEndpoint
</a>
- <nav class="md-nav" aria-label="Broker">
+ <nav class="md-nav" aria-label="VersionEndpoint">
<ul class="md-nav__list">
<li class="md-nav__item">
- <a href="#streampipes.functions.broker.broker.Broker.connect" class="md-nav__link">
- connect()
- </a>
-
-</li>
-
- <li class="md-nav__item">
- <a href="#streampipes.functions.broker.broker.Broker.createSubscription" class="md-nav__link">
- createSubscription()
- </a>
-
-</li>
-
- <li class="md-nav__item">
- <a href="#streampipes.functions.broker.broker.Broker.disconnect" class="md-nav__link">
- disconnect()
+ <a href="#streampipes.endpoint.api.version.VersionEndpoint.all" class="md-nav__link">
+ all()
</a>
</li>
<li class="md-nav__item">
- <a href="#streampipes.functions.broker.broker.Broker.get_message" class="md-nav__link">
- get_message()
+ <a href="#streampipes.endpoint.api.version.VersionEndpoint.get" class="md-nav__link">
+ get()
</a>
</li>
<li class="md-nav__item">
- <a href="#streampipes.functions.broker.broker.Broker.publish_event" class="md-nav__link">
- publish_event()
+ <a href="#streampipes.endpoint.api.version.VersionEndpoint.post" class="md-nav__link">
+ post()
</a>
</li>
@@ -1693,13 +1853,15 @@
- <h1>Broker</h1>
+ <h1>Version</h1>
<div class="doc doc-object doc-module">
-<a id="streampipes.functions.broker.broker"></a>
+<a id="streampipes.endpoint.api.version"></a>
<div class="doc doc-contents first">
+
+ <p>Specific implementation of the StreamPipes API's version endpoint.</p>
@@ -1716,52 +1878,21 @@
-<h2 id="streampipes.functions.broker.broker.Broker" class="doc doc-heading">
- <code>Broker</code>
+<h2 id="streampipes.endpoint.api.version.VersionEndpoint" class="doc doc-heading">
+ <code>VersionEndpoint</code>
-<a href="#streampipes.functions.broker.broker.Broker" class="headerlink" title="Permanent link">¶</a></h2>
+<a href="#streampipes.endpoint.api.version.VersionEndpoint" class="headerlink" title="Permanent link">¶</a></h2>
<div class="doc doc-contents ">
<p class="doc doc-class-bases">
- Bases: <code><span title="abc.ABC">ABC</span></code></p>
+ Bases: <code><a class="autorefs autorefs-internal" title="streampipes.endpoint.APIEndpoint" href="../../endpoint/#streampipes.endpoint.endpoint.APIEndpoint">APIEndpoint</a></code></p>
- <p>Abstract implementation of a broker.</p>
-<p>A broker allows both to subscribe to a data stream and to publish events to a data stream.</p>
-
-
-
-
-
- <div class="doc doc-children">
-
-
-
-
-
-
-
-
-
-<div class="doc doc-object doc-function">
-
-
-
-<h3 id="streampipes.functions.broker.broker.Broker.connect" class="doc doc-heading">
-<code class="highlight language-python"><span class="n">connect</span><span class="p">(</span><span class="n">data_stream</span><span class="p">)</span></code>
-
- <span class="doc doc-labels">
- <small class="doc doc-label doc-label-async"><code>async</code></small>
- </span>
-
-<a href="#streampipes.functions.broker.broker.Broker.connect" class="headerlink" title="Permanent link">¶</a></h3>
-
-
- <div class="doc doc-contents ">
-
- <p>Connects to the broker running in StreamPipes.</p>
+ <p>Implementation of the Versions endpoint.</p>
+<p>This endpoint provides metadata about the StreamPipes version of the connected instance.
+It only allows to apply the <code>get()</code> method with an empty string as identifier.</p>
<table>
<thead>
@@ -1772,80 +1903,79 @@
</thead>
<tbody>
<tr>
- <td><code>data_stream</code></td>
+ <td><code>parent_client</code></td>
<td class="doc-param-details">
- <p>Contains the meta information (resources) for a data stream.</p>
+ <p>The instance of <a class="autorefs autorefs-internal" href="../../../client/client/#streampipes.client.client.StreamPipesClient">StreamPipesClient</a> the endpoint is attached to.</p>
<p>
- <span class="doc-param-annotation">
- <b>TYPE:</b>
- <code><a class="autorefs autorefs-internal" title="streampipes.model.resource.data_stream.DataStream" href="../../../model/resource/data_stream/#streampipes.model.resource.data_stream.DataStream">DataStream</a></code>
- </span>
</p>
</td>
</tr>
</tbody>
</table>
- <table>
- <thead>
- <tr>
- <th><b>RETURNS</b></th>
- <th><b>DESCRIPTION</b></th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <span class="doc-returns-annotation">
- <code>None</code>
- </span>
- </td>
- <td class="doc-returns-details">
-
- </td>
- </tr>
- </tbody>
- </table>
+<p><strong>Examples:</strong></p>
+ <div class="highlight"><pre><span></span><code><span class="gp">>>> </span><span class="kn">from</span> <span class="nn">streampipes.client</span> <span class="kn">import</span> <span class="n">StreamPipesClient</span>
+<span class="gp">>>> </span><span class="kn">from</span> <span class="nn">streampipes.client.config</span> <span class="kn">import</span> <span class="n">StreamPipesClientConfig</span>
+<span class="gp">>>> </span><span class="kn">from</span> <span class="nn">streampipes.client.credential_provider</span> <span class="kn">import</span> <span class="n">StreamPipesApiKeyCredentials</span>
+</code></pre></div>
+ <div class="highlight"><pre><span></span><code><span class="gp">>>> </span><span class="n">client_config</span> <span class="o">=</span> <span class="n">StreamPipesClientConfig</span><span class="p">(</span>
+<span class="gp">... </span> <span class="n">credential_provider</span><span class="o">=</span><span class="n">StreamPipesApiKeyCredentials</span><span class="p">(</span><span class="n">username</span><span class="o">=</span><span class="s2">"test-user"</span><span class="p">,</span> <span class="n">api_key</span><span class="o">=</span><span class="s2">"api-key"</span><span class="p">),</span>
+<span class="gp">... </span> <span class="n">host_address</span><span class="o">=</span><span class="s2">"localhost"</span><span class="p">,</span>
+<span class="gp">... </span> <span class="n">port</span><span class="o">=</span><span class="mi">8082</span><span class="p">,</span>
+<span class="gp">... </span> <span class="n">https_disabled</span><span class="o">=</span><span class="kc">True</span>
+<span class="gp">... </span><span class="p">)</span>
+</code></pre></div>
+ <div class="highlight"><pre><span></span><code><span class="gp">>>> </span><span class="n">client</span> <span class="o">=</span> <span class="n">StreamPipesClient</span><span class="o">.</span><span class="n">create</span><span class="p">(</span><span class="n">client_config</span><span class="o">=</span><span class="n">client_config</span><span class="p">)</span>
+</code></pre></div>
+ <div class="highlight"><pre><span></span><code><span class="gp">>>> </span><span class="n">client</span><span class="o">.</span><span class="n">versionApi</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">identifier</span><span class="o">=</span><span class="s2">""</span><span class="p">)</span><span class="o">.</span><span class="n">to_dict</span><span class="p">(</span><span class="n">use_source_names</span><span clas [...]
+<span class="go">{'backend_version': '0.92.0-SNAPSHOT'}</span>
+</code></pre></div>
+
+
+
+
+
+ <div class="doc doc-children">
+
+
+
+
+
+
- </div>
-</div>
<div class="doc doc-object doc-function">
-<h3 id="streampipes.functions.broker.broker.Broker.createSubscription" class="doc doc-heading">
-<code class="highlight language-python"><span class="n">createSubscription</span><span class="p">()</span></code>
-
- <span class="doc doc-labels">
- <small class="doc doc-label doc-label-async"><code>async</code></small>
- <small class="doc doc-label doc-label-abstractmethod"><code>abstractmethod</code></small>
- </span>
+<h3 id="streampipes.endpoint.api.version.VersionEndpoint.all" class="doc doc-heading">
+<code class="highlight language-python"><span class="nb">all</span><span class="p">()</span></code>
-<a href="#streampipes.functions.broker.broker.Broker.createSubscription" class="headerlink" title="Permanent link">¶</a></h3>
+<a href="#streampipes.endpoint.api.version.VersionEndpoint.all" class="headerlink" title="Permanent link">¶</a></h3>
<div class="doc doc-contents ">
- <p>Creates a subscription to a data stream.</p>
+ <p>Usually, this method returns information about all resources provided by this endpoint.
+However, this endpoint does not support this kind of operation.</p>
<table>
<thead>
<tr>
- <th><b>RETURNS</b></th>
+ <th><b>RAISES</b></th>
<th><b>DESCRIPTION</b></th>
</tr>
</thead>
<tbody>
<tr>
<td>
- <span class="doc-returns-annotation">
- <code>None</code>
- </span>
+ <span class="doc-raises-annotation">
+ <code>NotImplementedError</code>
+ </span>
</td>
- <td class="doc-returns-details">
-
+ <td class="doc-raises-details">
+ <p>this endpoint does not return multiple entries, therefore this method is not available</p>
</td>
</tr>
</tbody>
@@ -1859,64 +1989,40 @@
-<h3 id="streampipes.functions.broker.broker.Broker.disconnect" class="doc doc-heading">
-<code class="highlight language-python"><span class="n">disconnect</span><span class="p">()</span></code>
-
- <span class="doc doc-labels">
- <small class="doc doc-label doc-label-async"><code>async</code></small>
- <small class="doc doc-label doc-label-abstractmethod"><code>abstractmethod</code></small>
- </span>
+<h3 id="streampipes.endpoint.api.version.VersionEndpoint.get" class="doc doc-heading">
+<code class="highlight language-python"><span class="n">get</span><span class="p">(</span><span class="n">identifier</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span></code>
-<a href="#streampipes.functions.broker.broker.Broker.disconnect" class="headerlink" title="Permanent link">¶</a></h3>
+<a href="#streampipes.endpoint.api.version.VersionEndpoint.get" class="headerlink" title="Permanent link">¶</a></h3>
<div class="doc doc-contents ">
- <p>Closes the connection to the server.</p>
+ <p>Queries the resource from the API endpoint.</p>
+<p>For this endpoint only one resource is available.</p>
<table>
<thead>
<tr>
- <th><b>RETURNS</b></th>
+ <th><b>PARAMETER</b></th>
<th><b>DESCRIPTION</b></th>
</tr>
</thead>
<tbody>
<tr>
- <td>
- <span class="doc-returns-annotation">
- <code>None</code>
- </span>
- </td>
- <td class="doc-returns-details">
-
+ <td><code>identifier</code></td>
+ <td class="doc-param-details">
+ <p>Not supported by this endpoint, is set to an empty string.</p>
+ <p>
+ <span class="doc-param-annotation">
+ <b>TYPE:</b>
+ <code>str</code>
+ </span>
+ </p>
</td>
</tr>
</tbody>
</table>
- </div>
-
-</div>
-
-<div class="doc doc-object doc-function">
-
-
-
-<h3 id="streampipes.functions.broker.broker.Broker.get_message" class="doc doc-heading">
-<code class="highlight language-python"><span class="n">get_message</span><span class="p">()</span></code>
-
- <span class="doc doc-labels">
- <small class="doc doc-label doc-label-abstractmethod"><code>abstractmethod</code></small>
- </span>
-
-<a href="#streampipes.functions.broker.broker.Broker.get_message" class="headerlink" title="Permanent link">¶</a></h3>
-
-
- <div class="doc doc-contents ">
-
- <p>Get the published messages of the subscription.</p>
-
<table>
<thead>
<tr>
@@ -1927,14 +2033,14 @@
<tbody>
<tr>
<td>
- <code>iterator</code>
+ <code>versions</code>
</td>
<td class="doc-returns-details">
- <p>An async iterator for the messages.</p>
+ <p>The specified resource as an instance of the corresponding model class(<a class="autorefs autorefs-internal" href="../../../model/resource/version/#streampipes.model.resource.version.Version">Version</a>). # noqa: 501</p>
<p>
<span class="doc-returns-annotation">
<b>TYPE:</b>
- <code><span title="typing.AsyncIterator">AsyncIterator</span></code>
+ <code>Version</code>
</span>
</p>
</td>
@@ -1950,60 +2056,33 @@
-<h3 id="streampipes.functions.broker.broker.Broker.publish_event" class="doc doc-heading">
-<code class="highlight language-python"><span class="n">publish_event</span><span class="p">(</span><span class="n">event</span><span class="p">)</span></code>
-
- <span class="doc doc-labels">
- <small class="doc doc-label doc-label-async"><code>async</code></small>
- <small class="doc doc-label doc-label-abstractmethod"><code>abstractmethod</code></small>
- </span>
+<h3 id="streampipes.endpoint.api.version.VersionEndpoint.post" class="doc doc-heading">
+<code class="highlight language-python"><span class="n">post</span><span class="p">(</span><span class="n">resource</span><span class="p">)</span></code>
-<a href="#streampipes.functions.broker.broker.Broker.publish_event" class="headerlink" title="Permanent link">¶</a></h3>
+<a href="#streampipes.endpoint.api.version.VersionEndpoint.post" class="headerlink" title="Permanent link">¶</a></h3>
<div class="doc doc-contents ">
- <p>Publish an event to a connected data stream.</p>
+ <p>Usually, this method allows to create via this endpoint.
+Since the data represented by this endpoint is immutable, it does not support this kind of operation.</p>
<table>
<thead>
<tr>
- <th><b>PARAMETER</b></th>
- <th><b>DESCRIPTION</b></th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><code>event</code></td>
- <td class="doc-param-details">
- <p>The event to be published.</p>
- <p>
- <span class="doc-param-annotation">
- <b>TYPE:</b>
- <code><span title="typing.Dict">Dict</span>[str, <span title="typing.Any">Any</span>]</code>
- </span>
- </p>
- </td>
- </tr>
- </tbody>
- </table>
-
- <table>
- <thead>
- <tr>
- <th><b>RETURNS</b></th>
+ <th><b>RAISES</b></th>
<th><b>DESCRIPTION</b></th>
</tr>
</thead>
<tbody>
<tr>
<td>
- <span class="doc-returns-annotation">
- <code>None</code>
- </span>
+ <span class="doc-raises-annotation">
+ <code>NotImplementedError</code>
+ </span>
</td>
- <td class="doc-returns-details">
-
+ <td class="doc-raises-details">
+ <p>this endpoint does not allow for POST requests, therefore this method is not available</p>
</td>
</tr>
</tbody>
diff --git a/docs-python/dev/reference/endpoint/endpoint/index.html b/docs-python/dev/reference/endpoint/endpoint/index.html
index ef2cf925..271427ee 100644
--- a/docs-python/dev/reference/endpoint/endpoint/index.html
+++ b/docs-python/dev/reference/endpoint/endpoint/index.html
@@ -899,6 +899,8 @@
+
+
<label class="md-nav__link" for="__nav_4_2_3" id="__nav_4_2_3_label" tabindex="0">
@@ -941,6 +943,20 @@
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../api/version/" class="md-nav__link">
+ Version
+ </a>
+ </li>
+
+
+
+
</ul>
</nav>
</li>
@@ -1115,6 +1131,8 @@
+
+
<label class="md-nav__link" for="__nav_4_4_4" id="__nav_4_4_4_label" tabindex="0">
@@ -1163,8 +1181,85 @@
<li class="md-nav__item">
- <a href="../../functions/broker/kafka_broker/" class="md-nav__link">
- Kafka broker
+ <a href="../../functions/broker/consumer/" class="md-nav__link">
+ Consumer
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../../functions/broker/output_collector/" class="md-nav__link">
+ Output collector
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../../functions/broker/publisher/" class="md-nav__link">
+ Publisher
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item md-nav__item--nested">
+
+
+
+
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_4_4_6" >
+
+
+
+
+
+
+
+
+
+
+
+ <label class="md-nav__link" for="__nav_4_4_4_6" id="__nav_4_4_4_6_label" tabindex="0">
+ Kafka
+ <span class="md-nav__icon md-icon"></span>
+ </label>
+
+ <nav class="md-nav" data-md-level="4" aria-labelledby="__nav_4_4_4_6_label" aria-expanded="false">
+ <label class="md-nav__title" for="__nav_4_4_4_6">
+ <span class="md-nav__icon md-icon"></span>
+ Kafka
+ </label>
+ <ul class="md-nav__list" data-md-scrollfix>
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../../functions/broker/kafka/kafka_consumer/" class="md-nav__link">
+ Kafka consumer
</a>
</li>
@@ -1177,7 +1272,7 @@
<li class="md-nav__item">
- <a href="../../functions/broker/kafka_message_fetcher/" class="md-nav__link">
+ <a href="../../functions/broker/kafka/kafka_message_fetcher/" class="md-nav__link">
Kafka message fetcher
</a>
</li>
@@ -1191,22 +1286,76 @@
<li class="md-nav__item">
- <a href="../../functions/broker/nats_broker/" class="md-nav__link">
- Nats broker
+ <a href="../../functions/broker/kafka/kafka_publisher/" class="md-nav__link">
+ Kafka publisher
</a>
</li>
+ </ul>
+ </nav>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item md-nav__item--nested">
+
+
+
+
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_4_4_7" >
+
+
+
+
+
+
+
+
+
+ <label class="md-nav__link" for="__nav_4_4_4_7" id="__nav_4_4_4_7_label" tabindex="0">
+ Nats
+ <span class="md-nav__icon md-icon"></span>
+ </label>
+
+ <nav class="md-nav" data-md-level="4" aria-labelledby="__nav_4_4_4_7_label" aria-expanded="false">
+ <label class="md-nav__title" for="__nav_4_4_4_7">
+ <span class="md-nav__icon md-icon"></span>
+ Nats
+ </label>
+ <ul class="md-nav__list" data-md-scrollfix>
+
<li class="md-nav__item">
- <a href="../../functions/broker/output_collector/" class="md-nav__link">
- Output collector
+ <a href="../../functions/broker/nats/nats_consumer/" class="md-nav__link">
+ Nats consumer
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../../functions/broker/nats/nats_publisher/" class="md-nav__link">
+ Nats publisher
</a>
</li>
@@ -1220,6 +1369,13 @@
+ </ul>
+ </nav>
+ </li>
+
+
+
+
@@ -1397,6 +1553,8 @@
+
+
<label class="md-nav__link" for="__nav_4_5_2" id="__nav_4_5_2_label" tabindex="0">
@@ -1453,6 +1611,20 @@
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../../model/container/versions/" class="md-nav__link">
+ Versions
+ </a>
+ </li>
+
+
+
+
</ul>
</nav>
</li>
@@ -1489,6 +1661,8 @@
+
+
<label class="md-nav__link" for="__nav_4_5_3" id="__nav_4_5_3_label" tabindex="0">
@@ -1601,6 +1775,20 @@
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../../model/resource/version/" class="md-nav__link">
+ Version
+ </a>
+ </li>
+
+
+
+
</ul>
</nav>
</li>
diff --git a/docs-python/dev/reference/endpoint/exceptions/index.html b/docs-python/dev/reference/endpoint/exceptions/index.html
index c781ee84..5ccb3eec 100644
--- a/docs-python/dev/reference/endpoint/exceptions/index.html
+++ b/docs-python/dev/reference/endpoint/exceptions/index.html
@@ -831,6 +831,8 @@
+
+
<label class="md-nav__link" for="__nav_4_2_3" id="__nav_4_2_3_label" tabindex="0">
@@ -873,6 +875,20 @@
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../api/version/" class="md-nav__link">
+ Version
+ </a>
+ </li>
+
+
+
+
</ul>
</nav>
</li>
@@ -1047,6 +1063,8 @@
+
+
<label class="md-nav__link" for="__nav_4_4_4" id="__nav_4_4_4_label" tabindex="0">
@@ -1095,8 +1113,85 @@
<li class="md-nav__item">
- <a href="../../functions/broker/kafka_broker/" class="md-nav__link">
- Kafka broker
+ <a href="../../functions/broker/consumer/" class="md-nav__link">
+ Consumer
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../../functions/broker/output_collector/" class="md-nav__link">
+ Output collector
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../../functions/broker/publisher/" class="md-nav__link">
+ Publisher
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item md-nav__item--nested">
+
+
+
+
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_4_4_6" >
+
+
+
+
+
+
+
+
+
+
+
+ <label class="md-nav__link" for="__nav_4_4_4_6" id="__nav_4_4_4_6_label" tabindex="0">
+ Kafka
+ <span class="md-nav__icon md-icon"></span>
+ </label>
+
+ <nav class="md-nav" data-md-level="4" aria-labelledby="__nav_4_4_4_6_label" aria-expanded="false">
+ <label class="md-nav__title" for="__nav_4_4_4_6">
+ <span class="md-nav__icon md-icon"></span>
+ Kafka
+ </label>
+ <ul class="md-nav__list" data-md-scrollfix>
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../../functions/broker/kafka/kafka_consumer/" class="md-nav__link">
+ Kafka consumer
</a>
</li>
@@ -1109,7 +1204,7 @@
<li class="md-nav__item">
- <a href="../../functions/broker/kafka_message_fetcher/" class="md-nav__link">
+ <a href="../../functions/broker/kafka/kafka_message_fetcher/" class="md-nav__link">
Kafka message fetcher
</a>
</li>
@@ -1123,22 +1218,76 @@
<li class="md-nav__item">
- <a href="../../functions/broker/nats_broker/" class="md-nav__link">
- Nats broker
+ <a href="../../functions/broker/kafka/kafka_publisher/" class="md-nav__link">
+ Kafka publisher
</a>
</li>
+ </ul>
+ </nav>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item md-nav__item--nested">
+
+
+
+
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_4_4_7" >
+
+
+
+
+
+
+
+
+
+ <label class="md-nav__link" for="__nav_4_4_4_7" id="__nav_4_4_4_7_label" tabindex="0">
+ Nats
+ <span class="md-nav__icon md-icon"></span>
+ </label>
+
+ <nav class="md-nav" data-md-level="4" aria-labelledby="__nav_4_4_4_7_label" aria-expanded="false">
+ <label class="md-nav__title" for="__nav_4_4_4_7">
+ <span class="md-nav__icon md-icon"></span>
+ Nats
+ </label>
+ <ul class="md-nav__list" data-md-scrollfix>
+
<li class="md-nav__item">
- <a href="../../functions/broker/output_collector/" class="md-nav__link">
- Output collector
+ <a href="../../functions/broker/nats/nats_consumer/" class="md-nav__link">
+ Nats consumer
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../../functions/broker/nats/nats_publisher/" class="md-nav__link">
+ Nats publisher
</a>
</li>
@@ -1152,6 +1301,13 @@
+ </ul>
+ </nav>
+ </li>
+
+
+
+
@@ -1329,6 +1485,8 @@
+
+
<label class="md-nav__link" for="__nav_4_5_2" id="__nav_4_5_2_label" tabindex="0">
@@ -1385,6 +1543,20 @@
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../../model/container/versions/" class="md-nav__link">
+ Versions
+ </a>
+ </li>
+
+
+
+
</ul>
</nav>
</li>
@@ -1421,6 +1593,8 @@
+
+
<label class="md-nav__link" for="__nav_4_5_3" id="__nav_4_5_3_label" tabindex="0">
@@ -1533,6 +1707,20 @@
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../../model/resource/version/" class="md-nav__link">
+ Version
+ </a>
+ </li>
+
+
+
+
</ul>
</nav>
</li>
diff --git a/docs-python/dev/reference/function_zoo/river_function/index.html b/docs-python/dev/reference/function_zoo/river_function/index.html
index 616497d9..36a04b74 100644
--- a/docs-python/dev/reference/function_zoo/river_function/index.html
+++ b/docs-python/dev/reference/function_zoo/river_function/index.html
@@ -34,7 +34,7 @@
<link rel="canonical" href="https://streampipes.apache.org/docs/docs/python/latest/latest/reference/function_zoo/river_function/">
- <link rel="prev" href="../../endpoint/api/data_stream/">
+ <link rel="prev" href="../../endpoint/api/version/">
<link rel="next" href="../../functions/function_handler/">
@@ -785,6 +785,8 @@
+
+
<label class="md-nav__link" for="__nav_4_2_3" id="__nav_4_2_3_label" tabindex="0">
@@ -827,6 +829,20 @@
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../../endpoint/api/version/" class="md-nav__link">
+ Version
+ </a>
+ </li>
+
+
+
+
</ul>
</nav>
</li>
@@ -1115,6 +1131,8 @@
+
+
<label class="md-nav__link" for="__nav_4_4_4" id="__nav_4_4_4_label" tabindex="0">
@@ -1163,8 +1181,85 @@
<li class="md-nav__item">
- <a href="../../functions/broker/kafka_broker/" class="md-nav__link">
- Kafka broker
+ <a href="../../functions/broker/consumer/" class="md-nav__link">
+ Consumer
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../../functions/broker/output_collector/" class="md-nav__link">
+ Output collector
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../../functions/broker/publisher/" class="md-nav__link">
+ Publisher
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item md-nav__item--nested">
+
+
+
+
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_4_4_6" >
+
+
+
+
+
+
+
+
+
+
+
+ <label class="md-nav__link" for="__nav_4_4_4_6" id="__nav_4_4_4_6_label" tabindex="0">
+ Kafka
+ <span class="md-nav__icon md-icon"></span>
+ </label>
+
+ <nav class="md-nav" data-md-level="4" aria-labelledby="__nav_4_4_4_6_label" aria-expanded="false">
+ <label class="md-nav__title" for="__nav_4_4_4_6">
+ <span class="md-nav__icon md-icon"></span>
+ Kafka
+ </label>
+ <ul class="md-nav__list" data-md-scrollfix>
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../../functions/broker/kafka/kafka_consumer/" class="md-nav__link">
+ Kafka consumer
</a>
</li>
@@ -1177,7 +1272,7 @@
<li class="md-nav__item">
- <a href="../../functions/broker/kafka_message_fetcher/" class="md-nav__link">
+ <a href="../../functions/broker/kafka/kafka_message_fetcher/" class="md-nav__link">
Kafka message fetcher
</a>
</li>
@@ -1191,22 +1286,76 @@
<li class="md-nav__item">
- <a href="../../functions/broker/nats_broker/" class="md-nav__link">
- Nats broker
+ <a href="../../functions/broker/kafka/kafka_publisher/" class="md-nav__link">
+ Kafka publisher
</a>
</li>
+ </ul>
+ </nav>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item md-nav__item--nested">
+
+
+
+
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_4_4_7" >
+
+
+
+
+
+
+
+
+
+ <label class="md-nav__link" for="__nav_4_4_4_7" id="__nav_4_4_4_7_label" tabindex="0">
+ Nats
+ <span class="md-nav__icon md-icon"></span>
+ </label>
+
+ <nav class="md-nav" data-md-level="4" aria-labelledby="__nav_4_4_4_7_label" aria-expanded="false">
+ <label class="md-nav__title" for="__nav_4_4_4_7">
+ <span class="md-nav__icon md-icon"></span>
+ Nats
+ </label>
+ <ul class="md-nav__list" data-md-scrollfix>
+
<li class="md-nav__item">
- <a href="../../functions/broker/output_collector/" class="md-nav__link">
- Output collector
+ <a href="../../functions/broker/nats/nats_consumer/" class="md-nav__link">
+ Nats consumer
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../../functions/broker/nats/nats_publisher/" class="md-nav__link">
+ Nats publisher
</a>
</li>
@@ -1220,6 +1369,13 @@
+ </ul>
+ </nav>
+ </li>
+
+
+
+
@@ -1397,6 +1553,8 @@
+
+
<label class="md-nav__link" for="__nav_4_5_2" id="__nav_4_5_2_label" tabindex="0">
@@ -1453,6 +1611,20 @@
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../../model/container/versions/" class="md-nav__link">
+ Versions
+ </a>
+ </li>
+
+
+
+
</ul>
</nav>
</li>
@@ -1489,6 +1661,8 @@
+
+
<label class="md-nav__link" for="__nav_4_5_3" id="__nav_4_5_3_label" tabindex="0">
@@ -1601,6 +1775,20 @@
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../../model/resource/version/" class="md-nav__link">
+ Version
+ </a>
+ </li>
+
+
+
+
</ul>
</nav>
</li>
diff --git a/docs-python/dev/reference/functions/broker/broker/index.html b/docs-python/dev/reference/functions/broker/broker/index.html
index 89484777..39cddb80 100644
--- a/docs-python/dev/reference/functions/broker/broker/index.html
+++ b/docs-python/dev/reference/functions/broker/broker/index.html
@@ -785,6 +785,8 @@
+
+
<label class="md-nav__link" for="__nav_4_2_3" id="__nav_4_2_3_label" tabindex="0">
@@ -827,6 +829,20 @@
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../../../endpoint/api/version/" class="md-nav__link">
+ Version
+ </a>
+ </li>
+
+
+
+
</ul>
</nav>
</li>
@@ -1005,6 +1021,8 @@
+
+
<label class="md-nav__link" for="__nav_4_4_4" id="__nav_4_4_4_label" tabindex="0">
@@ -1074,13 +1092,6 @@
connect()
</a>
-</li>
-
- <li class="md-nav__item">
- <a href="#streampipes.functions.broker.broker.Broker.createSubscription" class="md-nav__link">
- createSubscription()
- </a>
-
</li>
<li class="md-nav__item">
@@ -1088,20 +1099,6 @@
disconnect()
</a>
-</li>
-
- <li class="md-nav__item">
- <a href="#streampipes.functions.broker.broker.Broker.get_message" class="md-nav__link">
- get_message()
- </a>
-
-</li>
-
- <li class="md-nav__item">
- <a href="#streampipes.functions.broker.broker.Broker.publish_event" class="md-nav__link">
- publish_event()
- </a>
-
</li>
</ul>
@@ -1138,8 +1135,85 @@
<li class="md-nav__item">
- <a href="../kafka_broker/" class="md-nav__link">
- Kafka broker
+ <a href="../consumer/" class="md-nav__link">
+ Consumer
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../output_collector/" class="md-nav__link">
+ Output collector
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../publisher/" class="md-nav__link">
+ Publisher
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item md-nav__item--nested">
+
+
+
+
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_4_4_6" >
+
+
+
+
+
+
+
+
+
+
+
+ <label class="md-nav__link" for="__nav_4_4_4_6" id="__nav_4_4_4_6_label" tabindex="0">
+ Kafka
+ <span class="md-nav__icon md-icon"></span>
+ </label>
+
+ <nav class="md-nav" data-md-level="4" aria-labelledby="__nav_4_4_4_6_label" aria-expanded="false">
+ <label class="md-nav__title" for="__nav_4_4_4_6">
+ <span class="md-nav__icon md-icon"></span>
+ Kafka
+ </label>
+ <ul class="md-nav__list" data-md-scrollfix>
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../kafka/kafka_consumer/" class="md-nav__link">
+ Kafka consumer
</a>
</li>
@@ -1152,7 +1226,7 @@
<li class="md-nav__item">
- <a href="../kafka_message_fetcher/" class="md-nav__link">
+ <a href="../kafka/kafka_message_fetcher/" class="md-nav__link">
Kafka message fetcher
</a>
</li>
@@ -1166,8 +1240,62 @@
<li class="md-nav__item">
- <a href="../nats_broker/" class="md-nav__link">
- Nats broker
+ <a href="../kafka/kafka_publisher/" class="md-nav__link">
+ Kafka publisher
+ </a>
+ </li>
+
+
+
+
+ </ul>
+ </nav>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item md-nav__item--nested">
+
+
+
+
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_4_4_7" >
+
+
+
+
+
+
+
+
+
+ <label class="md-nav__link" for="__nav_4_4_4_7" id="__nav_4_4_4_7_label" tabindex="0">
+ Nats
+ <span class="md-nav__icon md-icon"></span>
+ </label>
+
+ <nav class="md-nav" data-md-level="4" aria-labelledby="__nav_4_4_4_7_label" aria-expanded="false">
+ <label class="md-nav__title" for="__nav_4_4_4_7">
+ <span class="md-nav__icon md-icon"></span>
+ Nats
+ </label>
+ <ul class="md-nav__list" data-md-scrollfix>
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../nats/nats_consumer/" class="md-nav__link">
+ Nats consumer
</a>
</li>
@@ -1180,8 +1308,8 @@
<li class="md-nav__item">
- <a href="../output_collector/" class="md-nav__link">
- Output collector
+ <a href="../nats/nats_publisher/" class="md-nav__link">
+ Nats publisher
</a>
</li>
@@ -1195,6 +1323,13 @@
+ </ul>
+ </nav>
+ </li>
+
+
+
+
@@ -1372,6 +1507,8 @@
+
+
<label class="md-nav__link" for="__nav_4_5_2" id="__nav_4_5_2_label" tabindex="0">
@@ -1428,6 +1565,20 @@
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../../../model/container/versions/" class="md-nav__link">
+ Versions
+ </a>
+ </li>
+
+
+
+
</ul>
</nav>
</li>
@@ -1464,6 +1615,8 @@
+
+
<label class="md-nav__link" for="__nav_4_5_3" id="__nav_4_5_3_label" tabindex="0">
@@ -1576,6 +1729,20 @@
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../../../model/resource/version/" class="md-nav__link">
+ Version
+ </a>
+ </li>
+
+
+
+
</ul>
</nav>
</li>
@@ -1640,13 +1807,6 @@
connect()
</a>
-</li>
-
- <li class="md-nav__item">
- <a href="#streampipes.functions.broker.broker.Broker.createSubscription" class="md-nav__link">
- createSubscription()
- </a>
-
</li>
<li class="md-nav__item">
@@ -1654,20 +1814,6 @@
disconnect()
</a>
-</li>
-
- <li class="md-nav__item">
- <a href="#streampipes.functions.broker.broker.Broker.get_message" class="md-nav__link">
- get_message()
- </a>
-
-</li>
-
- <li class="md-nav__item">
- <a href="#streampipes.functions.broker.broker.Broker.publish_event" class="md-nav__link">
- publish_event()
- </a>
-
</li>
</ul>
@@ -1728,8 +1874,8 @@
Bases: <code><span title="abc.ABC">ABC</span></code></p>
- <p>Abstract implementation of a broker.</p>
-<p>A broker allows both to subscribe to a data stream and to publish events to a data stream.</p>
+ <p>Abstract implementation of a broker for consumer and publisher.</p>
+<p>It contains the basic logic to connect to a data stream.</p>
@@ -1815,56 +1961,12 @@
-<h3 id="streampipes.functions.broker.broker.Broker.createSubscription" class="doc doc-heading">
-<code class="highlight language-python"><span class="n">createSubscription</span><span class="p">()</span></code>
-
- <span class="doc doc-labels">
- <small class="doc doc-label doc-label-async"><code>async</code></small>
- <small class="doc doc-label doc-label-abstractmethod"><code>abstractmethod</code></small>
- </span>
-
-<a href="#streampipes.functions.broker.broker.Broker.createSubscription" class="headerlink" title="Permanent link">¶</a></h3>
-
-
- <div class="doc doc-contents ">
-
- <p>Creates a subscription to a data stream.</p>
-
- <table>
- <thead>
- <tr>
- <th><b>RETURNS</b></th>
- <th><b>DESCRIPTION</b></th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <span class="doc-returns-annotation">
- <code>None</code>
- </span>
- </td>
- <td class="doc-returns-details">
-
- </td>
- </tr>
- </tbody>
- </table>
-
- </div>
-
-</div>
-
-<div class="doc doc-object doc-function">
-
-
-
<h3 id="streampipes.functions.broker.broker.Broker.disconnect" class="doc doc-heading">
<code class="highlight language-python"><span class="n">disconnect</span><span class="p">()</span></code>
<span class="doc doc-labels">
- <small class="doc doc-label doc-label-async"><code>async</code></small>
<small class="doc doc-label doc-label-abstractmethod"><code>abstractmethod</code></small>
+ <small class="doc doc-label doc-label-async"><code>async</code></small>
</span>
<a href="#streampipes.functions.broker.broker.Broker.disconnect" class="headerlink" title="Permanent link">¶</a></h3>
@@ -1899,120 +2001,6 @@
</div>
-<div class="doc doc-object doc-function">
-
-
-
-<h3 id="streampipes.functions.broker.broker.Broker.get_message" class="doc doc-heading">
-<code class="highlight language-python"><span class="n">get_message</span><span class="p">()</span></code>
-
- <span class="doc doc-labels">
- <small class="doc doc-label doc-label-abstractmethod"><code>abstractmethod</code></small>
- </span>
-
-<a href="#streampipes.functions.broker.broker.Broker.get_message" class="headerlink" title="Permanent link">¶</a></h3>
-
-
- <div class="doc doc-contents ">
-
- <p>Get the published messages of the subscription.</p>
-
- <table>
- <thead>
- <tr>
- <th><b>RETURNS</b></th>
- <th><b>DESCRIPTION</b></th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>iterator</code>
- </td>
- <td class="doc-returns-details">
- <p>An async iterator for the messages.</p>
- <p>
- <span class="doc-returns-annotation">
- <b>TYPE:</b>
- <code><span title="typing.AsyncIterator">AsyncIterator</span></code>
- </span>
- </p>
- </td>
- </tr>
- </tbody>
- </table>
-
- </div>
-
-</div>
-
-<div class="doc doc-object doc-function">
-
-
-
-<h3 id="streampipes.functions.broker.broker.Broker.publish_event" class="doc doc-heading">
-<code class="highlight language-python"><span class="n">publish_event</span><span class="p">(</span><span class="n">event</span><span class="p">)</span></code>
-
- <span class="doc doc-labels">
- <small class="doc doc-label doc-label-async"><code>async</code></small>
- <small class="doc doc-label doc-label-abstractmethod"><code>abstractmethod</code></small>
- </span>
-
-<a href="#streampipes.functions.broker.broker.Broker.publish_event" class="headerlink" title="Permanent link">¶</a></h3>
-
-
- <div class="doc doc-contents ">
-
- <p>Publish an event to a connected data stream.</p>
-
- <table>
- <thead>
- <tr>
- <th><b>PARAMETER</b></th>
- <th><b>DESCRIPTION</b></th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><code>event</code></td>
- <td class="doc-param-details">
- <p>The event to be published.</p>
- <p>
- <span class="doc-param-annotation">
- <b>TYPE:</b>
- <code><span title="typing.Dict">Dict</span>[str, <span title="typing.Any">Any</span>]</code>
- </span>
- </p>
- </td>
- </tr>
- </tbody>
- </table>
-
- <table>
- <thead>
- <tr>
- <th><b>RETURNS</b></th>
- <th><b>DESCRIPTION</b></th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <span class="doc-returns-annotation">
- <code>None</code>
- </span>
- </td>
- <td class="doc-returns-details">
-
- </td>
- </tr>
- </tbody>
- </table>
-
- </div>
-
-</div>
-
</div>
diff --git a/docs-python/dev/reference/functions/broker/broker_handler/index.html b/docs-python/dev/reference/functions/broker/broker_handler/index.html
index 8cc4ad90..02df4e33 100644
--- a/docs-python/dev/reference/functions/broker/broker_handler/index.html
+++ b/docs-python/dev/reference/functions/broker/broker_handler/index.html
@@ -37,7 +37,7 @@
<link rel="prev" href="../broker/">
- <link rel="next" href="../kafka_broker/">
+ <link rel="next" href="../consumer/">
<link rel="icon" href="https://streampipes.apache.org/img/favicon/favicon.png">
<meta name="generator" content="mkdocs-1.4.2, mkdocs-material-9.1.3">
@@ -785,6 +785,8 @@
+
+
<label class="md-nav__link" for="__nav_4_2_3" id="__nav_4_2_3_label" tabindex="0">
@@ -827,6 +829,20 @@
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../../../endpoint/api/version/" class="md-nav__link">
+ Version
+ </a>
+ </li>
+
+
+
+
</ul>
</nav>
</li>
@@ -1005,6 +1021,8 @@
+
+
<label class="md-nav__link" for="__nav_4_4_4" id="__nav_4_4_4_label" tabindex="0">
@@ -1094,6 +1112,13 @@
get_broker()
</a>
+</li>
+
+ <li class="md-nav__item">
+ <a href="#streampipes.functions.broker.broker_handler.get_broker_description" class="md-nav__link">
+ get_broker_description()
+ </a>
+
</li>
</ul>
@@ -1111,8 +1136,8 @@
<li class="md-nav__item">
- <a href="../kafka_broker/" class="md-nav__link">
- Kafka broker
+ <a href="../consumer/" class="md-nav__link">
+ Consumer
</a>
</li>
@@ -1125,7 +1150,84 @@
<li class="md-nav__item">
- <a href="../kafka_message_fetcher/" class="md-nav__link">
+ <a href="../output_collector/" class="md-nav__link">
+ Output collector
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../publisher/" class="md-nav__link">
+ Publisher
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item md-nav__item--nested">
+
+
+
+
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_4_4_6" >
+
+
+
+
+
+
+
+
+
+
+
+ <label class="md-nav__link" for="__nav_4_4_4_6" id="__nav_4_4_4_6_label" tabindex="0">
+ Kafka
+ <span class="md-nav__icon md-icon"></span>
+ </label>
+
+ <nav class="md-nav" data-md-level="4" aria-labelledby="__nav_4_4_4_6_label" aria-expanded="false">
+ <label class="md-nav__title" for="__nav_4_4_4_6">
+ <span class="md-nav__icon md-icon"></span>
+ Kafka
+ </label>
+ <ul class="md-nav__list" data-md-scrollfix>
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../kafka/kafka_consumer/" class="md-nav__link">
+ Kafka consumer
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../kafka/kafka_message_fetcher/" class="md-nav__link">
Kafka message fetcher
</a>
</li>
@@ -1139,28 +1241,89 @@
<li class="md-nav__item">
- <a href="../nats_broker/" class="md-nav__link">
- Nats broker
+ <a href="../kafka/kafka_publisher/" class="md-nav__link">
+ Kafka publisher
</a>
</li>
+ </ul>
+ </nav>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item md-nav__item--nested">
+
+
+
+
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_4_4_7" >
+
+
+
+
+
+
+
+
+
+ <label class="md-nav__link" for="__nav_4_4_4_7" id="__nav_4_4_4_7_label" tabindex="0">
+ Nats
+ <span class="md-nav__icon md-icon"></span>
+ </label>
+
+ <nav class="md-nav" data-md-level="4" aria-labelledby="__nav_4_4_4_7_label" aria-expanded="false">
+ <label class="md-nav__title" for="__nav_4_4_4_7">
+ <span class="md-nav__icon md-icon"></span>
+ Nats
+ </label>
+ <ul class="md-nav__list" data-md-scrollfix>
+
<li class="md-nav__item">
- <a href="../output_collector/" class="md-nav__link">
- Output collector
+ <a href="../nats/nats_consumer/" class="md-nav__link">
+ Nats consumer
</a>
</li>
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../nats/nats_publisher/" class="md-nav__link">
+ Nats publisher
+ </a>
+ </li>
+
+
+
+
+ </ul>
+ </nav>
+ </li>
+
+
+
+
</ul>
</nav>
</li>
@@ -1345,6 +1508,8 @@
+
+
<label class="md-nav__link" for="__nav_4_5_2" id="__nav_4_5_2_label" tabindex="0">
@@ -1401,6 +1566,20 @@
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../../../model/container/versions/" class="md-nav__link">
+ Versions
+ </a>
+ </li>
+
+
+
+
</ul>
</nav>
</li>
@@ -1437,6 +1616,8 @@
+
+
<label class="md-nav__link" for="__nav_4_5_3" id="__nav_4_5_3_label" tabindex="0">
@@ -1549,6 +1730,20 @@
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../../../model/resource/version/" class="md-nav__link">
+ Version
+ </a>
+ </li>
+
+
+
+
</ul>
</nav>
</li>
@@ -1619,6 +1814,13 @@
get_broker()
</a>
+</li>
+
+ <li class="md-nav__item">
+ <a href="#streampipes.functions.broker.broker_handler.get_broker_description" class="md-nav__link">
+ get_broker_description()
+ </a>
+
</li>
</ul>
@@ -1703,7 +1905,7 @@
<h2 id="streampipes.functions.broker.broker_handler.UnsupportedBrokerError" class="doc doc-heading">
-<code class="highlight language-python"><span class="n">UnsupportedBrokerError</span><span class="p">(</span><span class="n">message</span><span class="p">)</span></code>
+<code class="highlight language-python"><span class="n">UnsupportedBrokerError</span><span class="p">(</span><span class="n">broker_name</span><span class="p">)</span></code>
<a href="#streampipes.functions.broker.broker_handler.UnsupportedBrokerError" class="headerlink" title="Permanent link">¶</a></h2>
@@ -1743,7 +1945,7 @@
<h2 id="streampipes.functions.broker.broker_handler.get_broker" class="doc doc-heading">
-<code class="highlight language-python"><span class="n">get_broker</span><span class="p">(</span><span class="n">data_stream</span><span class="p">)</span></code>
+<code class="highlight language-python"><span class="n">get_broker</span><span class="p">(</span><span class="n">data_stream</span><span class="p">,</span> <span class="n">is_publisher</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span></code>
<a href="#streampipes.functions.broker.broker_handler.get_broker" class="headerlink" title="Permanent link">¶</a></h2>
@@ -1825,6 +2027,93 @@
</div>
+<div class="doc doc-object doc-function">
+
+
+
+<h2 id="streampipes.functions.broker.broker_handler.get_broker_description" class="doc doc-heading">
+<code class="highlight language-python"><span class="n">get_broker_description</span><span class="p">(</span><span class="n">data_stream</span><span class="p">)</span></code>
+
+<a href="#streampipes.functions.broker.broker_handler.get_broker_description" class="headerlink" title="Permanent link">¶</a></h2>
+
+
+ <div class="doc doc-contents ">
+
+ <p>Derive the decription of the broker for the given data stream.</p>
+
+ <table>
+ <thead>
+ <tr>
+ <th><b>PARAMETER</b></th>
+ <th><b>DESCRIPTION</b></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><code>data_stream</code></td>
+ <td class="doc-param-details">
+ <p>Data stream instance from which the broker is inferred</p>
+ <p>
+ <span class="doc-param-annotation">
+ <b>TYPE:</b>
+ <code><a class="autorefs autorefs-internal" title="streampipes.model.resource.data_stream.DataStream" href="../../../model/resource/data_stream/#streampipes.model.resource.data_stream.DataStream">DataStream</a></code>
+ </span>
+ </p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+
+ <table>
+ <thead>
+ <tr>
+ <th><b>RETURNS</b></th>
+ <th><b>DESCRIPTION</b></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ <code>broker</code>
+ </td>
+ <td class="doc-returns-details">
+ <p>The corresponding broker description derived from data stream.</p>
+ <p>
+ <span class="doc-returns-annotation">
+ <b>TYPE:</b>
+ <code><a class="autorefs autorefs-internal" title="streampipes.functions.broker.broker_handler.SupportedBroker" href="#streampipes.functions.broker.broker_handler.SupportedBroker">SupportedBroker</a></code>
+ </span>
+ </p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+
+ <table>
+ <thead>
+ <tr>
+ <th><b>RAISES</b></th>
+ <th><b>DESCRIPTION</b></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ <span class="doc-raises-annotation">
+ <code><a class="autorefs autorefs-internal" title="streampipes.functions.broker.broker_handler.UnsupportedBrokerError" href="#streampipes.functions.broker.broker_handler.UnsupportedBrokerError">UnsupportedBrokerError</a></code>
+ </span>
+ </td>
+ <td class="doc-raises-details">
+ <p>Is raised when the given data stream belongs to a broker that is currently not supported by StreamPipes Python.</p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+
+ </div>
+
+</div>
+
</div>
diff --git a/docs-python/dev/reference/functions/broker/output_collector/index.html b/docs-python/dev/reference/functions/broker/consumer/index.html
similarity index 85%
copy from docs-python/dev/reference/functions/broker/output_collector/index.html
copy to docs-python/dev/reference/functions/broker/consumer/index.html
index 941baf21..f98a374a 100644
--- a/docs-python/dev/reference/functions/broker/output_collector/index.html
+++ b/docs-python/dev/reference/functions/broker/consumer/index.html
@@ -31,20 +31,20 @@
<meta name="author" content="Apache Software Foundation (ASF)">
- <link rel="canonical" href="https://streampipes.apache.org/docs/docs/python/latest/latest/reference/functions/broker/output_collector/">
+ <link rel="canonical" href="https://streampipes.apache.org/docs/docs/python/latest/latest/reference/functions/broker/consumer/">
- <link rel="prev" href="../nats_broker/">
+ <link rel="prev" href="../broker_handler/">
- <link rel="next" href="../../utils/async_iter_handler/">
+ <link rel="next" href="../output_collector/">
<link rel="icon" href="https://streampipes.apache.org/img/favicon/favicon.png">
<meta name="generator" content="mkdocs-1.4.2, mkdocs-material-9.1.3">
- <title>Output collector - Apache StreamPipes Python</title>
+ <title>Consumer - Apache StreamPipes Python</title>
@@ -136,7 +136,7 @@
<div data-md-component="skip">
- <a href="#streampipes.functions.broker.output_collector" class="md-skip">
+ <a href="#streampipes.functions.broker.consumer" class="md-skip">
Skip to content
</a>
@@ -174,7 +174,7 @@
<div class="md-header__topic" data-md-component="header-topic">
<span class="md-ellipsis">
- Output collector
+ Consumer
</span>
</div>
@@ -785,6 +785,8 @@
+
+
<label class="md-nav__link" for="__nav_4_2_3" id="__nav_4_2_3_label" tabindex="0">
@@ -827,6 +829,20 @@
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../../../endpoint/api/version/" class="md-nav__link">
+ Version
+ </a>
+ </li>
+
+
+
+
</ul>
</nav>
</li>
@@ -1005,6 +1021,8 @@
+
+
<label class="md-nav__link" for="__nav_4_4_4" id="__nav_4_4_4_label" tabindex="0">
@@ -1051,48 +1069,6 @@
-
- <li class="md-nav__item">
- <a href="../kafka_broker/" class="md-nav__link">
- Kafka broker
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../kafka_message_fetcher/" class="md-nav__link">
- Kafka message fetcher
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="md-nav__item">
- <a href="../nats_broker/" class="md-nav__link">
- Nats broker
- </a>
- </li>
-
-
-
-
-
-
-
-
@@ -1103,12 +1079,12 @@
<label class="md-nav__link md-nav__link--active" for="__toc">
- Output collector
+ Consumer
<span class="md-nav__icon md-icon"></span>
</label>
<a href="./" class="md-nav__link md-nav__link--active">
- Output collector
+ Consumer
</a>
@@ -1125,30 +1101,30 @@
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
- <a href="#streampipes.functions.broker.output_collector" class="md-nav__link">
- streampipes.functions.broker.output_collector
+ <a href="#streampipes.functions.broker.consumer" class="md-nav__link">
+ streampipes.functions.broker.consumer
</a>
</li>
<li class="md-nav__item">
- <a href="#streampipes.functions.broker.output_collector.OutputCollector" class="md-nav__link">
- OutputCollector
+ <a href="#streampipes.functions.broker.consumer.Consumer" class="md-nav__link">
+ Consumer
</a>
- <nav class="md-nav" aria-label="OutputCollector">
+ <nav class="md-nav" aria-label="Consumer">
<ul class="md-nav__list">
<li class="md-nav__item">
- <a href="#streampipes.functions.broker.output_collector.OutputCollector.collect" class="md-nav__link">
- collect()
+ <a href="#streampipes.functions.broker.consumer.Consumer.connect" class="md-nav__link">
+ connect()
</a>
</li>
<li class="md-nav__item">
- <a href="#streampipes.functions.broker.output_collector.OutputCollector.disconnect" class="md-nav__link">
- disconnect()
+ <a href="#streampipes.functions.broker.consumer.Consumer.get_message" class="md-nav__link">
+ get_message()
</a>
</li>
@@ -1167,6 +1143,186 @@
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../output_collector/" class="md-nav__link">
+ Output collector
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../publisher/" class="md-nav__link">
+ Publisher
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item md-nav__item--nested">
+
+
+
+
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_4_4_6" >
+
+
+
+
+
+
+
+
+
+
+
+ <label class="md-nav__link" for="__nav_4_4_4_6" id="__nav_4_4_4_6_label" tabindex="0">
+ Kafka
+ <span class="md-nav__icon md-icon"></span>
+ </label>
+
+ <nav class="md-nav" data-md-level="4" aria-labelledby="__nav_4_4_4_6_label" aria-expanded="false">
+ <label class="md-nav__title" for="__nav_4_4_4_6">
+ <span class="md-nav__icon md-icon"></span>
+ Kafka
+ </label>
+ <ul class="md-nav__list" data-md-scrollfix>
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../kafka/kafka_consumer/" class="md-nav__link">
+ Kafka consumer
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../kafka/kafka_message_fetcher/" class="md-nav__link">
+ Kafka message fetcher
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../kafka/kafka_publisher/" class="md-nav__link">
+ Kafka publisher
+ </a>
+ </li>
+
+
+
+
+ </ul>
+ </nav>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item md-nav__item--nested">
+
+
+
+
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_4_4_7" >
+
+
+
+
+
+
+
+
+
+ <label class="md-nav__link" for="__nav_4_4_4_7" id="__nav_4_4_4_7_label" tabindex="0">
+ Nats
+ <span class="md-nav__icon md-icon"></span>
+ </label>
+
+ <nav class="md-nav" data-md-level="4" aria-labelledby="__nav_4_4_4_7_label" aria-expanded="false">
+ <label class="md-nav__title" for="__nav_4_4_4_7">
+ <span class="md-nav__icon md-icon"></span>
+ Nats
+ </label>
+ <ul class="md-nav__list" data-md-scrollfix>
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../nats/nats_consumer/" class="md-nav__link">
+ Nats consumer
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../nats/nats_publisher/" class="md-nav__link">
+ Nats publisher
+ </a>
+ </li>
+
+
+
+
+ </ul>
+ </nav>
+ </li>
+
+
+
+
</ul>
</nav>
</li>
@@ -1351,6 +1507,8 @@
+
+
<label class="md-nav__link" for="__nav_4_5_2" id="__nav_4_5_2_label" tabindex="0">
@@ -1407,6 +1565,20 @@
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../../../model/container/versions/" class="md-nav__link">
+ Versions
+ </a>
+ </li>
+
+
+
+
</ul>
</nav>
</li>
@@ -1443,6 +1615,8 @@
+
+
<label class="md-nav__link" for="__nav_4_5_3" id="__nav_4_5_3_label" tabindex="0">
@@ -1555,6 +1729,20 @@
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../../../model/resource/version/" class="md-nav__link">
+ Version
+ </a>
+ </li>
+
+
+
+
</ul>
</nav>
</li>
@@ -1600,30 +1788,30 @@
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
- <a href="#streampipes.functions.broker.output_collector" class="md-nav__link">
- streampipes.functions.broker.output_collector
+ <a href="#streampipes.functions.broker.consumer" class="md-nav__link">
+ streampipes.functions.broker.consumer
</a>
</li>
<li class="md-nav__item">
- <a href="#streampipes.functions.broker.output_collector.OutputCollector" class="md-nav__link">
- OutputCollector
+ <a href="#streampipes.functions.broker.consumer.Consumer" class="md-nav__link">
+ Consumer
</a>
- <nav class="md-nav" aria-label="OutputCollector">
+ <nav class="md-nav" aria-label="Consumer">
<ul class="md-nav__list">
<li class="md-nav__item">
- <a href="#streampipes.functions.broker.output_collector.OutputCollector.collect" class="md-nav__link">
- collect()
+ <a href="#streampipes.functions.broker.consumer.Consumer.connect" class="md-nav__link">
+ connect()
</a>
</li>
<li class="md-nav__item">
- <a href="#streampipes.functions.broker.output_collector.OutputCollector.disconnect" class="md-nav__link">
- disconnect()
+ <a href="#streampipes.functions.broker.consumer.Consumer.get_message" class="md-nav__link">
+ get_message()
</a>
</li>
@@ -1651,12 +1839,12 @@
- <h1>Output collector</h1>
+ <h1>Consumer</h1>
<div class="doc doc-object doc-module">
-<a id="streampipes.functions.broker.output_collector"></a>
+<a id="streampipes.functions.broker.consumer"></a>
<div class="doc doc-contents first">
@@ -1674,63 +1862,20 @@
-<h2 id="streampipes.functions.broker.output_collector.OutputCollector" class="doc doc-heading">
-<code class="highlight language-python"><span class="n">OutputCollector</span><span class="p">(</span><span class="n">data_stream</span><span class="p">)</span></code>
+<h2 id="streampipes.functions.broker.consumer.Consumer" class="doc doc-heading">
+ <code>Consumer</code>
+
-<a href="#streampipes.functions.broker.output_collector.OutputCollector" class="headerlink" title="Permanent link">¶</a></h2>
+<a href="#streampipes.functions.broker.consumer.Consumer" class="headerlink" title="Permanent link">¶</a></h2>
<div class="doc doc-contents ">
+ <p class="doc doc-class-bases">
+ Bases: <code><a class="autorefs autorefs-internal" title="streampipes.functions.broker.Broker" href="../broker/#streampipes.functions.broker.broker.Broker">Broker</a></code></p>
- <p>Collector for output events. The events are published to an output data stream.
-Therefore, the output collector establishes a connection to the broker.</p>
-
- <table>
- <thead>
- <tr>
- <th><b>PARAMETER</b></th>
- <th><b>DESCRIPTION</b></th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><code>data_stream</code></td>
- <td class="doc-param-details">
- <p>The output data stream that will receive the events.</p>
- <p>
- <span class="doc-param-annotation">
- <b>TYPE:</b>
- <code><a class="autorefs autorefs-internal" title="streampipes.model.resource.data_stream.DataStream" href="../../../model/resource/data_stream/#streampipes.model.resource.data_stream.DataStream">DataStream</a></code>
- </span>
- </p>
- </td>
- </tr>
- </tbody>
- </table>
-
- <table>
- <thead>
- <tr>
- <th><b>ATTRIBUTE</b></th>
- <th><b>DESCRIPTION</b></th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><code>broker</code></td>
- <td class="doc-attribute-details">
- <p>The broker instance that sends the data to StreamPipes</p>
- <p>
- <span class="doc-attribute-annotation">
- <b>TYPE:</b>
- <code><a class="autorefs autorefs-internal" title="streampipes.functions.broker.broker.Broker" href="../broker/#streampipes.functions.broker.broker.Broker">Broker</a></code>
- </span>
- </p>
- </td>
- </tr>
- </tbody>
- </table>
+ <p>Abstract implementation a consumer for a broker.</p>
+<p>A consumer allows to subscribe to a data stream.</p>
@@ -1750,15 +1895,19 @@ Therefore, the output collector establishes a connection to the broker.</p>
-<h3 id="streampipes.functions.broker.output_collector.OutputCollector.collect" class="doc doc-heading">
-<code class="highlight language-python"><span class="n">collect</span><span class="p">(</span><span class="n">event</span><span class="p">)</span></code>
+<h3 id="streampipes.functions.broker.consumer.Consumer.connect" class="doc doc-heading">
+<code class="highlight language-python"><span class="n">connect</span><span class="p">(</span><span class="n">data_stream</span><span class="p">)</span></code>
+
+ <span class="doc doc-labels">
+ <small class="doc doc-label doc-label-async"><code>async</code></small>
+ </span>
-<a href="#streampipes.functions.broker.output_collector.OutputCollector.collect" class="headerlink" title="Permanent link">¶</a></h3>
+<a href="#streampipes.functions.broker.consumer.Consumer.connect" class="headerlink" title="Permanent link">¶</a></h3>
<div class="doc doc-contents ">
- <p>Publishes an event to the output stream.</p>
+ <p>Connects to the broker running in StreamPipes and creates a subscription.</p>
<table>
<thead>
@@ -1769,13 +1918,13 @@ Therefore, the output collector establishes a connection to the broker.</p>
</thead>
<tbody>
<tr>
- <td><code>event</code></td>
+ <td><code>data_stream</code></td>
<td class="doc-param-details">
- <p>The event to be published.</p>
+ <p>Contains the meta information (resources) for a data stream.</p>
<p>
<span class="doc-param-annotation">
<b>TYPE:</b>
- <code><span title="typing.Dict">Dict</span>[str, <span title="typing.Any">Any</span>]</code>
+ <code><a class="autorefs autorefs-internal" title="streampipes.model.resource.data_stream.DataStream" href="../../../model/resource/data_stream/#streampipes.model.resource.data_stream.DataStream">DataStream</a></code>
</span>
</p>
</td>
@@ -1812,15 +1961,19 @@ Therefore, the output collector establishes a connection to the broker.</p>
-<h3 id="streampipes.functions.broker.output_collector.OutputCollector.disconnect" class="doc doc-heading">
-<code class="highlight language-python"><span class="n">disconnect</span><span class="p">()</span></code>
+<h3 id="streampipes.functions.broker.consumer.Consumer.get_message" class="doc doc-heading">
+<code class="highlight language-python"><span class="n">get_message</span><span class="p">()</span></code>
+
+ <span class="doc doc-labels">
+ <small class="doc doc-label doc-label-abstractmethod"><code>abstractmethod</code></small>
+ </span>
-<a href="#streampipes.functions.broker.output_collector.OutputCollector.disconnect" class="headerlink" title="Permanent link">¶</a></h3>
+<a href="#streampipes.functions.broker.consumer.Consumer.get_message" class="headerlink" title="Permanent link">¶</a></h3>
<div class="doc doc-contents ">
- <p>Disconnects the broker of the output collector.</p>
+ <p>Get the published messages of the subscription.</p>
<table>
<thead>
@@ -1832,12 +1985,16 @@ Therefore, the output collector establishes a connection to the broker.</p>
<tbody>
<tr>
<td>
- <span class="doc-returns-annotation">
- <code>None</code>
- </span>
+ <code>iterator</code>
</td>
<td class="doc-returns-details">
-
+ <p>An async iterator for the messages.</p>
+ <p>
+ <span class="doc-returns-annotation">
+ <b>TYPE:</b>
+ <code><span title="typing.AsyncIterator">AsyncIterator</span></code>
+ </span>
+ </p>
</td>
</tr>
</tbody>
diff --git a/docs-python/dev/reference/functions/broker/output_collector/index.html b/docs-python/dev/reference/functions/broker/kafka/kafka_consumer/index.html
similarity index 76%
copy from docs-python/dev/reference/functions/broker/output_collector/index.html
copy to docs-python/dev/reference/functions/broker/kafka/kafka_consumer/index.html
index 941baf21..1629af37 100644
--- a/docs-python/dev/reference/functions/broker/output_collector/index.html
+++ b/docs-python/dev/reference/functions/broker/kafka/kafka_consumer/index.html
@@ -31,27 +31,27 @@
<meta name="author" content="Apache Software Foundation (ASF)">
- <link rel="canonical" href="https://streampipes.apache.org/docs/docs/python/latest/latest/reference/functions/broker/output_collector/">
+ <link rel="canonical" href="https://streampipes.apache.org/docs/docs/python/latest/latest/reference/functions/broker/kafka/kafka_consumer/">
- <link rel="prev" href="../nats_broker/">
+ <link rel="prev" href="../../publisher/">
- <link rel="next" href="../../utils/async_iter_handler/">
+ <link rel="next" href="../kafka_message_fetcher/">
<link rel="icon" href="https://streampipes.apache.org/img/favicon/favicon.png">
<meta name="generator" content="mkdocs-1.4.2, mkdocs-material-9.1.3">
- <title>Output collector - Apache StreamPipes Python</title>
+ <title>Kafka consumer - Apache StreamPipes Python</title>
- <link rel="stylesheet" href="../../../../assets/stylesheets/main.c4a75a56.min.css">
+ <link rel="stylesheet" href="../../../../../assets/stylesheets/main.c4a75a56.min.css">
- <link rel="stylesheet" href="../../../../assets/stylesheets/palette.a0c5b2b5.min.css">
+ <link rel="stylesheet" href="../../../../../assets/stylesheets/palette.a0c5b2b5.min.css">
@@ -61,11 +61,11 @@
- <link rel="stylesheet" href="../../../../assets/_mkdocstrings.css">
+ <link rel="stylesheet" href="../../../../../assets/_mkdocstrings.css">
- <link rel="stylesheet" href="../../../../stylesheets/extra.css">
+ <link rel="stylesheet" href="../../../../../stylesheets/extra.css">
- <script>__md_scope=new URL("../../../..",location),__md_hash=e=>[...e].reduce((e,_)=>(e<<5)-e+_.charCodeAt(0),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
+ <script>__md_scope=new URL("../../../../..",location),__md_hash=e=>[...e].reduce((e,_)=>(e<<5)-e+_.charCodeAt(0),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
@@ -136,7 +136,7 @@
<div data-md-component="skip">
- <a href="#streampipes.functions.broker.output_collector" class="md-skip">
+ <a href="#streampipes.functions.broker.kafka.kafka_consumer" class="md-skip">
Skip to content
</a>
@@ -174,7 +174,7 @@
<div class="md-header__topic" data-md-component="header-topic">
<span class="md-ellipsis">
- Output collector
+ Kafka consumer
</span>
</div>
@@ -263,7 +263,7 @@
<li class="md-tabs__item">
- <a href="../../../.." class="md-tabs__link">
+ <a href="../../../../.." class="md-tabs__link">
🏡 Home
</a>
</li>
@@ -278,7 +278,7 @@
<li class="md-tabs__item">
- <a href="../../../../getting-started/first-steps/" class="md-tabs__link">
+ <a href="../../../../../getting-started/first-steps/" class="md-tabs__link">
🚀 Getting Started
</a>
</li>
@@ -294,7 +294,7 @@
<li class="md-tabs__item">
- <a href="../../../../tutorials/1-introduction-to-streampipes-python-client/" class="md-tabs__link">
+ <a href="../../../../../tutorials/1-introduction-to-streampipes-python-client/" class="md-tabs__link">
🤓 Tutorials
</a>
</li>
@@ -317,7 +317,7 @@
<li class="md-tabs__item">
- <a href="../../../client/client/" class="md-tabs__link md-tabs__link--active">
+ <a href="../../../../client/client/" class="md-tabs__link md-tabs__link--active">
📚 Reference
</a>
</li>
@@ -383,7 +383,7 @@
<li class="md-nav__item">
- <a href="../../../.." class="md-nav__link">
+ <a href="../../../../.." class="md-nav__link">
🏡 Home
</a>
</li>
@@ -433,7 +433,7 @@
<li class="md-nav__item">
- <a href="../../../../getting-started/first-steps/" class="md-nav__link">
+ <a href="../../../../../getting-started/first-steps/" class="md-nav__link">
First Steps
</a>
</li>
@@ -447,7 +447,7 @@
<li class="md-nav__item">
- <a href="../../../../getting-started/developing/" class="md-nav__link">
+ <a href="../../../../../getting-started/developing/" class="md-nav__link">
Developing & Contributing
</a>
</li>
@@ -461,7 +461,7 @@
<li class="md-nav__item">
- <a href="../../../../getting-started/quickstart/" class="md-nav__link">
+ <a href="../../../../../getting-started/quickstart/" class="md-nav__link">
Quickstart
</a>
</li>
@@ -520,7 +520,7 @@
<li class="md-nav__item">
- <a href="../../../../tutorials/1-introduction-to-streampipes-python-client/" class="md-nav__link">
+ <a href="../../../../../tutorials/1-introduction-to-streampipes-python-client/" class="md-nav__link">
Introduction to StreamPipes Python
</a>
</li>
@@ -534,7 +534,7 @@
<li class="md-nav__item">
- <a href="../../../../tutorials/2-extracting-data-from-the-streampipes-data-lake/" class="md-nav__link">
+ <a href="../../../../../tutorials/2-extracting-data-from-the-streampipes-data-lake/" class="md-nav__link">
Extracting Data from the StreamPipes data lake
</a>
</li>
@@ -548,7 +548,7 @@
<li class="md-nav__item">
- <a href="../../../../tutorials/3-getting-live-data-from-the-streampipes-data-stream/" class="md-nav__link">
+ <a href="../../../../../tutorials/3-getting-live-data-from-the-streampipes-data-stream/" class="md-nav__link">
Getting live data from the StreamPipes data stream
</a>
</li>
@@ -562,7 +562,7 @@
<li class="md-nav__item">
- <a href="../../../../tutorials/4-using-online-machine-learning-on-a-streampipes-data-stream/" class="md-nav__link">
+ <a href="../../../../../tutorials/4-using-online-machine-learning-on-a-streampipes-data-stream/" class="md-nav__link">
Using Online Machine Learning on a StreamPipes data stream
</a>
</li>
@@ -660,7 +660,7 @@
<li class="md-nav__item">
- <a href="../../../client/client/" class="md-nav__link">
+ <a href="../../../../client/client/" class="md-nav__link">
Client
</a>
</li>
@@ -674,7 +674,7 @@
<li class="md-nav__item">
- <a href="../../../client/config/" class="md-nav__link">
+ <a href="../../../../client/config/" class="md-nav__link">
Config
</a>
</li>
@@ -688,7 +688,7 @@
<li class="md-nav__item">
- <a href="../../../client/credential_provider/" class="md-nav__link">
+ <a href="../../../../client/credential_provider/" class="md-nav__link">
Credential provider
</a>
</li>
@@ -744,7 +744,7 @@
<li class="md-nav__item">
- <a href="../../../endpoint/endpoint/" class="md-nav__link">
+ <a href="../../../../endpoint/endpoint/" class="md-nav__link">
Endpoint
</a>
</li>
@@ -758,7 +758,7 @@
<li class="md-nav__item">
- <a href="../../../endpoint/exceptions/" class="md-nav__link">
+ <a href="../../../../endpoint/exceptions/" class="md-nav__link">
Exceptions
</a>
</li>
@@ -785,6 +785,8 @@
+
+
<label class="md-nav__link" for="__nav_4_2_3" id="__nav_4_2_3_label" tabindex="0">
@@ -805,7 +807,7 @@
<li class="md-nav__item">
- <a href="../../../endpoint/api/data_lake_measure/" class="md-nav__link">
+ <a href="../../../../endpoint/api/data_lake_measure/" class="md-nav__link">
Data lake measure
</a>
</li>
@@ -819,7 +821,7 @@
<li class="md-nav__item">
- <a href="../../../endpoint/api/data_stream/" class="md-nav__link">
+ <a href="../../../../endpoint/api/data_stream/" class="md-nav__link">
Data stream
</a>
</li>
@@ -827,6 +829,20 @@
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../../../../endpoint/api/version/" class="md-nav__link">
+ Version
+ </a>
+ </li>
+
+
+
+
</ul>
</nav>
</li>
@@ -878,7 +894,7 @@
<li class="md-nav__item">
- <a href="../../../function_zoo/river_function/" class="md-nav__link">
+ <a href="../../../../function_zoo/river_function/" class="md-nav__link">
River function
</a>
</li>
@@ -940,7 +956,7 @@
<li class="md-nav__item">
- <a href="../../function_handler/" class="md-nav__link">
+ <a href="../../../function_handler/" class="md-nav__link">
Function handler
</a>
</li>
@@ -954,7 +970,7 @@
<li class="md-nav__item">
- <a href="../../registration/" class="md-nav__link">
+ <a href="../../../registration/" class="md-nav__link">
Registration
</a>
</li>
@@ -968,7 +984,7 @@
<li class="md-nav__item">
- <a href="../../streampipes_function/" class="md-nav__link">
+ <a href="../../../streampipes_function/" class="md-nav__link">
Streampipes function
</a>
</li>
@@ -1005,6 +1021,8 @@
+
+
<label class="md-nav__link" for="__nav_4_4_4" id="__nav_4_4_4_label" tabindex="0">
@@ -1025,7 +1043,7 @@
<li class="md-nav__item">
- <a href="../broker/" class="md-nav__link">
+ <a href="../../broker/" class="md-nav__link">
Broker
</a>
</li>
@@ -1039,7 +1057,7 @@
<li class="md-nav__item">
- <a href="../broker_handler/" class="md-nav__link">
+ <a href="../../broker_handler/" class="md-nav__link">
Broker handler
</a>
</li>
@@ -1053,8 +1071,8 @@
<li class="md-nav__item">
- <a href="../kafka_broker/" class="md-nav__link">
- Kafka broker
+ <a href="../../consumer/" class="md-nav__link">
+ Consumer
</a>
</li>
@@ -1067,8 +1085,8 @@
<li class="md-nav__item">
- <a href="../kafka_message_fetcher/" class="md-nav__link">
- Kafka message fetcher
+ <a href="../../output_collector/" class="md-nav__link">
+ Output collector
</a>
</li>
@@ -1081,8 +1099,8 @@
<li class="md-nav__item">
- <a href="../nats_broker/" class="md-nav__link">
- Nats broker
+ <a href="../../publisher/" class="md-nav__link">
+ Publisher
</a>
</li>
@@ -1096,6 +1114,43 @@
+
+ <li class="md-nav__item md-nav__item--active md-nav__item--nested">
+
+
+
+
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_4_4_6" checked>
+
+
+
+
+
+
+
+
+
+
+
+ <label class="md-nav__link" for="__nav_4_4_4_6" id="__nav_4_4_4_6_label" tabindex="0">
+ Kafka
+ <span class="md-nav__icon md-icon"></span>
+ </label>
+
+ <nav class="md-nav" data-md-level="4" aria-labelledby="__nav_4_4_4_6_label" aria-expanded="true">
+ <label class="md-nav__title" for="__nav_4_4_4_6">
+ <span class="md-nav__icon md-icon"></span>
+ Kafka
+ </label>
+ <ul class="md-nav__list" data-md-scrollfix>
+
+
+
+
+
+
+
+
<li class="md-nav__item md-nav__item--active">
<input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
@@ -1103,12 +1158,12 @@
<label class="md-nav__link md-nav__link--active" for="__toc">
- Output collector
+ Kafka consumer
<span class="md-nav__icon md-icon"></span>
</label>
<a href="./" class="md-nav__link md-nav__link--active">
- Output collector
+ Kafka consumer
</a>
@@ -1125,30 +1180,30 @@
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
- <a href="#streampipes.functions.broker.output_collector" class="md-nav__link">
- streampipes.functions.broker.output_collector
+ <a href="#streampipes.functions.broker.kafka.kafka_consumer" class="md-nav__link">
+ streampipes.functions.broker.kafka.kafka_consumer
</a>
</li>
<li class="md-nav__item">
- <a href="#streampipes.functions.broker.output_collector.OutputCollector" class="md-nav__link">
- OutputCollector
+ <a href="#streampipes.functions.broker.kafka.kafka_consumer.KafkaConsumer" class="md-nav__link">
+ KafkaConsumer
</a>
- <nav class="md-nav" aria-label="OutputCollector">
+ <nav class="md-nav" aria-label="KafkaConsumer">
<ul class="md-nav__list">
<li class="md-nav__item">
- <a href="#streampipes.functions.broker.output_collector.OutputCollector.collect" class="md-nav__link">
- collect()
+ <a href="#streampipes.functions.broker.kafka.kafka_consumer.KafkaConsumer.disconnect" class="md-nav__link">
+ disconnect()
</a>
</li>
<li class="md-nav__item">
- <a href="#streampipes.functions.broker.output_collector.OutputCollector.disconnect" class="md-nav__link">
- disconnect()
+ <a href="#streampipes.functions.broker.kafka.kafka_consumer.KafkaConsumer.get_message" class="md-nav__link">
+ get_message()
</a>
</li>
@@ -1167,6 +1222,109 @@
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../kafka_message_fetcher/" class="md-nav__link">
+ Kafka message fetcher
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../kafka_publisher/" class="md-nav__link">
+ Kafka publisher
+ </a>
+ </li>
+
+
+
+
+ </ul>
+ </nav>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item md-nav__item--nested">
+
+
+
+
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_4_4_7" >
+
+
+
+
+
+
+
+
+
+ <label class="md-nav__link" for="__nav_4_4_4_7" id="__nav_4_4_4_7_label" tabindex="0">
+ Nats
+ <span class="md-nav__icon md-icon"></span>
+ </label>
+
+ <nav class="md-nav" data-md-level="4" aria-labelledby="__nav_4_4_4_7_label" aria-expanded="false">
+ <label class="md-nav__title" for="__nav_4_4_4_7">
+ <span class="md-nav__icon md-icon"></span>
+ Nats
+ </label>
+ <ul class="md-nav__list" data-md-scrollfix>
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../../nats/nats_consumer/" class="md-nav__link">
+ Nats consumer
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../../nats/nats_publisher/" class="md-nav__link">
+ Nats publisher
+ </a>
+ </li>
+
+
+
+
+ </ul>
+ </nav>
+ </li>
+
+
+
+
</ul>
</nav>
</li>
@@ -1217,7 +1375,7 @@
<li class="md-nav__item">
- <a href="../../utils/async_iter_handler/" class="md-nav__link">
+ <a href="../../../utils/async_iter_handler/" class="md-nav__link">
Async iter handler
</a>
</li>
@@ -1231,7 +1389,7 @@
<li class="md-nav__item">
- <a href="../../utils/data_stream_context/" class="md-nav__link">
+ <a href="../../../utils/data_stream_context/" class="md-nav__link">
Data stream context
</a>
</li>
@@ -1245,7 +1403,7 @@
<li class="md-nav__item">
- <a href="../../utils/data_stream_generator/" class="md-nav__link">
+ <a href="../../../utils/data_stream_generator/" class="md-nav__link">
Data stream generator
</a>
</li>
@@ -1259,7 +1417,7 @@
<li class="md-nav__item">
- <a href="../../utils/function_context/" class="md-nav__link">
+ <a href="../../../utils/function_context/" class="md-nav__link">
Function context
</a>
</li>
@@ -1322,7 +1480,7 @@
<li class="md-nav__item">
- <a href="../../../model/common/" class="md-nav__link">
+ <a href="../../../../model/common/" class="md-nav__link">
Common
</a>
</li>
@@ -1351,6 +1509,8 @@
+
+
<label class="md-nav__link" for="__nav_4_5_2" id="__nav_4_5_2_label" tabindex="0">
@@ -1371,7 +1531,7 @@
<li class="md-nav__item">
- <a href="../../../model/container/data_lake_measures/" class="md-nav__link">
+ <a href="../../../../model/container/data_lake_measures/" class="md-nav__link">
Data lake measures
</a>
</li>
@@ -1385,7 +1545,7 @@
<li class="md-nav__item">
- <a href="../../../model/container/data_streams/" class="md-nav__link">
+ <a href="../../../../model/container/data_streams/" class="md-nav__link">
Data streams
</a>
</li>
@@ -1399,7 +1559,7 @@
<li class="md-nav__item">
- <a href="../../../model/container/resource_container/" class="md-nav__link">
+ <a href="../../../../model/container/resource_container/" class="md-nav__link">
Resource container
</a>
</li>
@@ -1407,6 +1567,20 @@
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../../../../model/container/versions/" class="md-nav__link">
+ Versions
+ </a>
+ </li>
+
+
+
+
</ul>
</nav>
</li>
@@ -1443,6 +1617,8 @@
+
+
<label class="md-nav__link" for="__nav_4_5_3" id="__nav_4_5_3_label" tabindex="0">
@@ -1463,7 +1639,7 @@
<li class="md-nav__item">
- <a href="../../../model/resource/data_lake_measure/" class="md-nav__link">
+ <a href="../../../../model/resource/data_lake_measure/" class="md-nav__link">
Data lake measure
</a>
</li>
@@ -1477,7 +1653,7 @@
<li class="md-nav__item">
- <a href="../../../model/resource/data_series/" class="md-nav__link">
+ <a href="../../../../model/resource/data_series/" class="md-nav__link">
Data series
</a>
</li>
@@ -1491,7 +1667,7 @@
<li class="md-nav__item">
- <a href="../../../model/resource/data_stream/" class="md-nav__link">
+ <a href="../../../../model/resource/data_stream/" class="md-nav__link">
Data stream
</a>
</li>
@@ -1505,7 +1681,7 @@
<li class="md-nav__item">
- <a href="../../../model/resource/exceptions/" class="md-nav__link">
+ <a href="../../../../model/resource/exceptions/" class="md-nav__link">
Exceptions
</a>
</li>
@@ -1519,7 +1695,7 @@
<li class="md-nav__item">
- <a href="../../../model/resource/function_definition/" class="md-nav__link">
+ <a href="../../../../model/resource/function_definition/" class="md-nav__link">
Function definition
</a>
</li>
@@ -1533,7 +1709,7 @@
<li class="md-nav__item">
- <a href="../../../model/resource/query_result/" class="md-nav__link">
+ <a href="../../../../model/resource/query_result/" class="md-nav__link">
Query result
</a>
</li>
@@ -1547,7 +1723,7 @@
<li class="md-nav__item">
- <a href="../../../model/resource/resource/" class="md-nav__link">
+ <a href="../../../../model/resource/resource/" class="md-nav__link">
Resource
</a>
</li>
@@ -1555,6 +1731,20 @@
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../../../../model/resource/version/" class="md-nav__link">
+ Version
+ </a>
+ </li>
+
+
+
+
</ul>
</nav>
</li>
@@ -1600,30 +1790,30 @@
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
- <a href="#streampipes.functions.broker.output_collector" class="md-nav__link">
- streampipes.functions.broker.output_collector
+ <a href="#streampipes.functions.broker.kafka.kafka_consumer" class="md-nav__link">
+ streampipes.functions.broker.kafka.kafka_consumer
</a>
</li>
<li class="md-nav__item">
- <a href="#streampipes.functions.broker.output_collector.OutputCollector" class="md-nav__link">
- OutputCollector
+ <a href="#streampipes.functions.broker.kafka.kafka_consumer.KafkaConsumer" class="md-nav__link">
+ KafkaConsumer
</a>
- <nav class="md-nav" aria-label="OutputCollector">
+ <nav class="md-nav" aria-label="KafkaConsumer">
<ul class="md-nav__list">
<li class="md-nav__item">
- <a href="#streampipes.functions.broker.output_collector.OutputCollector.collect" class="md-nav__link">
- collect()
+ <a href="#streampipes.functions.broker.kafka.kafka_consumer.KafkaConsumer.disconnect" class="md-nav__link">
+ disconnect()
</a>
</li>
<li class="md-nav__item">
- <a href="#streampipes.functions.broker.output_collector.OutputCollector.disconnect" class="md-nav__link">
- disconnect()
+ <a href="#streampipes.functions.broker.kafka.kafka_consumer.KafkaConsumer.get_message" class="md-nav__link">
+ get_message()
</a>
</li>
@@ -1651,12 +1841,12 @@
- <h1>Output collector</h1>
+ <h1>Kafka consumer</h1>
<div class="doc doc-object doc-module">
-<a id="streampipes.functions.broker.output_collector"></a>
+<a id="streampipes.functions.broker.kafka.kafka_consumer"></a>
<div class="doc doc-contents first">
@@ -1674,63 +1864,19 @@
-<h2 id="streampipes.functions.broker.output_collector.OutputCollector" class="doc doc-heading">
-<code class="highlight language-python"><span class="n">OutputCollector</span><span class="p">(</span><span class="n">data_stream</span><span class="p">)</span></code>
+<h2 id="streampipes.functions.broker.kafka.kafka_consumer.KafkaConsumer" class="doc doc-heading">
+ <code>KafkaConsumer</code>
-<a href="#streampipes.functions.broker.output_collector.OutputCollector" class="headerlink" title="Permanent link">¶</a></h2>
+
+<a href="#streampipes.functions.broker.kafka.kafka_consumer.KafkaConsumer" class="headerlink" title="Permanent link">¶</a></h2>
<div class="doc doc-contents ">
+ <p class="doc doc-class-bases">
+ Bases: <code><a class="autorefs autorefs-internal" title="streampipes.functions.broker.Consumer" href="../../consumer/#streampipes.functions.broker.consumer.Consumer">Consumer</a></code></p>
- <p>Collector for output events. The events are published to an output data stream.
-Therefore, the output collector establishes a connection to the broker.</p>
-
- <table>
- <thead>
- <tr>
- <th><b>PARAMETER</b></th>
- <th><b>DESCRIPTION</b></th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><code>data_stream</code></td>
- <td class="doc-param-details">
- <p>The output data stream that will receive the events.</p>
- <p>
- <span class="doc-param-annotation">
- <b>TYPE:</b>
- <code><a class="autorefs autorefs-internal" title="streampipes.model.resource.data_stream.DataStream" href="../../../model/resource/data_stream/#streampipes.model.resource.data_stream.DataStream">DataStream</a></code>
- </span>
- </p>
- </td>
- </tr>
- </tbody>
- </table>
-
- <table>
- <thead>
- <tr>
- <th><b>ATTRIBUTE</b></th>
- <th><b>DESCRIPTION</b></th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><code>broker</code></td>
- <td class="doc-attribute-details">
- <p>The broker instance that sends the data to StreamPipes</p>
- <p>
- <span class="doc-attribute-annotation">
- <b>TYPE:</b>
- <code><a class="autorefs autorefs-internal" title="streampipes.functions.broker.broker.Broker" href="../broker/#streampipes.functions.broker.broker.Broker">Broker</a></code>
- </span>
- </p>
- </td>
- </tr>
- </tbody>
- </table>
+ <p>Implementation of a consumer for Kafka</p>
@@ -1750,38 +1896,19 @@ Therefore, the output collector establishes a connection to the broker.</p>
-<h3 id="streampipes.functions.broker.output_collector.OutputCollector.collect" class="doc doc-heading">
-<code class="highlight language-python"><span class="n">collect</span><span class="p">(</span><span class="n">event</span><span class="p">)</span></code>
+<h3 id="streampipes.functions.broker.kafka.kafka_consumer.KafkaConsumer.disconnect" class="doc doc-heading">
+<code class="highlight language-python"><span class="n">disconnect</span><span class="p">()</span></code>
+
+ <span class="doc doc-labels">
+ <small class="doc doc-label doc-label-async"><code>async</code></small>
+ </span>
-<a href="#streampipes.functions.broker.output_collector.OutputCollector.collect" class="headerlink" title="Permanent link">¶</a></h3>
+<a href="#streampipes.functions.broker.kafka.kafka_consumer.KafkaConsumer.disconnect" class="headerlink" title="Permanent link">¶</a></h3>
<div class="doc doc-contents ">
- <p>Publishes an event to the output stream.</p>
-
- <table>
- <thead>
- <tr>
- <th><b>PARAMETER</b></th>
- <th><b>DESCRIPTION</b></th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><code>event</code></td>
- <td class="doc-param-details">
- <p>The event to be published.</p>
- <p>
- <span class="doc-param-annotation">
- <b>TYPE:</b>
- <code><span title="typing.Dict">Dict</span>[str, <span title="typing.Any">Any</span>]</code>
- </span>
- </p>
- </td>
- </tr>
- </tbody>
- </table>
+ <p>Closes the connection to the server.</p>
<table>
<thead>
@@ -1812,15 +1939,15 @@ Therefore, the output collector establishes a connection to the broker.</p>
-<h3 id="streampipes.functions.broker.output_collector.OutputCollector.disconnect" class="doc doc-heading">
-<code class="highlight language-python"><span class="n">disconnect</span><span class="p">()</span></code>
+<h3 id="streampipes.functions.broker.kafka.kafka_consumer.KafkaConsumer.get_message" class="doc doc-heading">
+<code class="highlight language-python"><span class="n">get_message</span><span class="p">()</span></code>
-<a href="#streampipes.functions.broker.output_collector.OutputCollector.disconnect" class="headerlink" title="Permanent link">¶</a></h3>
+<a href="#streampipes.functions.broker.kafka.kafka_consumer.KafkaConsumer.get_message" class="headerlink" title="Permanent link">¶</a></h3>
<div class="doc doc-contents ">
- <p>Disconnects the broker of the output collector.</p>
+ <p>Get the published messages of the subscription.</p>
<table>
<thead>
@@ -1832,12 +1959,16 @@ Therefore, the output collector establishes a connection to the broker.</p>
<tbody>
<tr>
<td>
- <span class="doc-returns-annotation">
- <code>None</code>
- </span>
+ <code>iterator</code>
</td>
<td class="doc-returns-details">
-
+ <p>An async iterator for the messages.</p>
+ <p>
+ <span class="doc-returns-annotation">
+ <b>TYPE:</b>
+ <code><span title="typing.AsyncIterator">AsyncIterator</span></code>
+ </span>
+ </p>
</td>
</tr>
</tbody>
@@ -1921,10 +2052,10 @@ Therefore, the output collector establishes a connection to the broker.</p>
<div class="md-dialog__inner md-typeset"></div>
</div>
- <script id="__config" type="application/json">{"base": "../../../..", "features": ["navigation.tabs", "navigation.tabs.sticky", "navigation.instant", "navigation.indexes", "navigation.tracking"], "search": "../../../../assets/javascripts/workers/search.208ed371.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.non [...]
+ <script id="__config" type="application/json">{"base": "../../../../..", "features": ["navigation.tabs", "navigation.tabs.sticky", "navigation.instant", "navigation.indexes", "navigation.tracking"], "search": "../../../../../assets/javascripts/workers/search.208ed371.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.resu [...]
- <script src="../../../../assets/javascripts/bundle.efa0ade1.min.js"></script>
+ <script src="../../../../../assets/javascripts/bundle.efa0ade1.min.js"></script>
</body>
diff --git a/docs-python/dev/reference/functions/broker/output_collector/index.html b/docs-python/dev/reference/functions/broker/kafka/kafka_message_fetcher/index.html
similarity index 77%
copy from docs-python/dev/reference/functions/broker/output_collector/index.html
copy to docs-python/dev/reference/functions/broker/kafka/kafka_message_fetcher/index.html
index 941baf21..c282e8c0 100644
--- a/docs-python/dev/reference/functions/broker/output_collector/index.html
+++ b/docs-python/dev/reference/functions/broker/kafka/kafka_message_fetcher/index.html
@@ -31,27 +31,27 @@
<meta name="author" content="Apache Software Foundation (ASF)">
- <link rel="canonical" href="https://streampipes.apache.org/docs/docs/python/latest/latest/reference/functions/broker/output_collector/">
+ <link rel="canonical" href="https://streampipes.apache.org/docs/docs/python/latest/latest/reference/functions/broker/kafka/kafka_message_fetcher/">
- <link rel="prev" href="../nats_broker/">
+ <link rel="prev" href="../kafka_consumer/">
- <link rel="next" href="../../utils/async_iter_handler/">
+ <link rel="next" href="../kafka_publisher/">
<link rel="icon" href="https://streampipes.apache.org/img/favicon/favicon.png">
<meta name="generator" content="mkdocs-1.4.2, mkdocs-material-9.1.3">
- <title>Output collector - Apache StreamPipes Python</title>
+ <title>Kafka message fetcher - Apache StreamPipes Python</title>
- <link rel="stylesheet" href="../../../../assets/stylesheets/main.c4a75a56.min.css">
+ <link rel="stylesheet" href="../../../../../assets/stylesheets/main.c4a75a56.min.css">
- <link rel="stylesheet" href="../../../../assets/stylesheets/palette.a0c5b2b5.min.css">
+ <link rel="stylesheet" href="../../../../../assets/stylesheets/palette.a0c5b2b5.min.css">
@@ -61,11 +61,11 @@
- <link rel="stylesheet" href="../../../../assets/_mkdocstrings.css">
+ <link rel="stylesheet" href="../../../../../assets/_mkdocstrings.css">
- <link rel="stylesheet" href="../../../../stylesheets/extra.css">
+ <link rel="stylesheet" href="../../../../../stylesheets/extra.css">
- <script>__md_scope=new URL("../../../..",location),__md_hash=e=>[...e].reduce((e,_)=>(e<<5)-e+_.charCodeAt(0),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
+ <script>__md_scope=new URL("../../../../..",location),__md_hash=e=>[...e].reduce((e,_)=>(e<<5)-e+_.charCodeAt(0),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
@@ -136,7 +136,7 @@
<div data-md-component="skip">
- <a href="#streampipes.functions.broker.output_collector" class="md-skip">
+ <a href="#streampipes.functions.broker.kafka.kafka_message_fetcher" class="md-skip">
Skip to content
</a>
@@ -174,7 +174,7 @@
<div class="md-header__topic" data-md-component="header-topic">
<span class="md-ellipsis">
- Output collector
+ Kafka message fetcher
</span>
</div>
@@ -263,7 +263,7 @@
<li class="md-tabs__item">
- <a href="../../../.." class="md-tabs__link">
+ <a href="../../../../.." class="md-tabs__link">
🏡 Home
</a>
</li>
@@ -278,7 +278,7 @@
<li class="md-tabs__item">
- <a href="../../../../getting-started/first-steps/" class="md-tabs__link">
+ <a href="../../../../../getting-started/first-steps/" class="md-tabs__link">
🚀 Getting Started
</a>
</li>
@@ -294,7 +294,7 @@
<li class="md-tabs__item">
- <a href="../../../../tutorials/1-introduction-to-streampipes-python-client/" class="md-tabs__link">
+ <a href="../../../../../tutorials/1-introduction-to-streampipes-python-client/" class="md-tabs__link">
🤓 Tutorials
</a>
</li>
@@ -317,7 +317,7 @@
<li class="md-tabs__item">
- <a href="../../../client/client/" class="md-tabs__link md-tabs__link--active">
+ <a href="../../../../client/client/" class="md-tabs__link md-tabs__link--active">
📚 Reference
</a>
</li>
@@ -383,7 +383,7 @@
<li class="md-nav__item">
- <a href="../../../.." class="md-nav__link">
+ <a href="../../../../.." class="md-nav__link">
🏡 Home
</a>
</li>
@@ -433,7 +433,7 @@
<li class="md-nav__item">
- <a href="../../../../getting-started/first-steps/" class="md-nav__link">
+ <a href="../../../../../getting-started/first-steps/" class="md-nav__link">
First Steps
</a>
</li>
@@ -447,7 +447,7 @@
<li class="md-nav__item">
- <a href="../../../../getting-started/developing/" class="md-nav__link">
+ <a href="../../../../../getting-started/developing/" class="md-nav__link">
Developing & Contributing
</a>
</li>
@@ -461,7 +461,7 @@
<li class="md-nav__item">
- <a href="../../../../getting-started/quickstart/" class="md-nav__link">
+ <a href="../../../../../getting-started/quickstart/" class="md-nav__link">
Quickstart
</a>
</li>
@@ -520,7 +520,7 @@
<li class="md-nav__item">
- <a href="../../../../tutorials/1-introduction-to-streampipes-python-client/" class="md-nav__link">
+ <a href="../../../../../tutorials/1-introduction-to-streampipes-python-client/" class="md-nav__link">
Introduction to StreamPipes Python
</a>
</li>
@@ -534,7 +534,7 @@
<li class="md-nav__item">
- <a href="../../../../tutorials/2-extracting-data-from-the-streampipes-data-lake/" class="md-nav__link">
+ <a href="../../../../../tutorials/2-extracting-data-from-the-streampipes-data-lake/" class="md-nav__link">
Extracting Data from the StreamPipes data lake
</a>
</li>
@@ -548,7 +548,7 @@
<li class="md-nav__item">
- <a href="../../../../tutorials/3-getting-live-data-from-the-streampipes-data-stream/" class="md-nav__link">
+ <a href="../../../../../tutorials/3-getting-live-data-from-the-streampipes-data-stream/" class="md-nav__link">
Getting live data from the StreamPipes data stream
</a>
</li>
@@ -562,7 +562,7 @@
<li class="md-nav__item">
- <a href="../../../../tutorials/4-using-online-machine-learning-on-a-streampipes-data-stream/" class="md-nav__link">
+ <a href="../../../../../tutorials/4-using-online-machine-learning-on-a-streampipes-data-stream/" class="md-nav__link">
Using Online Machine Learning on a StreamPipes data stream
</a>
</li>
@@ -660,7 +660,7 @@
<li class="md-nav__item">
- <a href="../../../client/client/" class="md-nav__link">
+ <a href="../../../../client/client/" class="md-nav__link">
Client
</a>
</li>
@@ -674,7 +674,7 @@
<li class="md-nav__item">
- <a href="../../../client/config/" class="md-nav__link">
+ <a href="../../../../client/config/" class="md-nav__link">
Config
</a>
</li>
@@ -688,7 +688,7 @@
<li class="md-nav__item">
- <a href="../../../client/credential_provider/" class="md-nav__link">
+ <a href="../../../../client/credential_provider/" class="md-nav__link">
Credential provider
</a>
</li>
@@ -744,7 +744,7 @@
<li class="md-nav__item">
- <a href="../../../endpoint/endpoint/" class="md-nav__link">
+ <a href="../../../../endpoint/endpoint/" class="md-nav__link">
Endpoint
</a>
</li>
@@ -758,7 +758,7 @@
<li class="md-nav__item">
- <a href="../../../endpoint/exceptions/" class="md-nav__link">
+ <a href="../../../../endpoint/exceptions/" class="md-nav__link">
Exceptions
</a>
</li>
@@ -785,6 +785,8 @@
+
+
<label class="md-nav__link" for="__nav_4_2_3" id="__nav_4_2_3_label" tabindex="0">
@@ -805,7 +807,7 @@
<li class="md-nav__item">
- <a href="../../../endpoint/api/data_lake_measure/" class="md-nav__link">
+ <a href="../../../../endpoint/api/data_lake_measure/" class="md-nav__link">
Data lake measure
</a>
</li>
@@ -819,7 +821,7 @@
<li class="md-nav__item">
- <a href="../../../endpoint/api/data_stream/" class="md-nav__link">
+ <a href="../../../../endpoint/api/data_stream/" class="md-nav__link">
Data stream
</a>
</li>
@@ -827,6 +829,20 @@
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../../../../endpoint/api/version/" class="md-nav__link">
+ Version
+ </a>
+ </li>
+
+
+
+
</ul>
</nav>
</li>
@@ -878,7 +894,7 @@
<li class="md-nav__item">
- <a href="../../../function_zoo/river_function/" class="md-nav__link">
+ <a href="../../../../function_zoo/river_function/" class="md-nav__link">
River function
</a>
</li>
@@ -940,7 +956,7 @@
<li class="md-nav__item">
- <a href="../../function_handler/" class="md-nav__link">
+ <a href="../../../function_handler/" class="md-nav__link">
Function handler
</a>
</li>
@@ -954,7 +970,7 @@
<li class="md-nav__item">
- <a href="../../registration/" class="md-nav__link">
+ <a href="../../../registration/" class="md-nav__link">
Registration
</a>
</li>
@@ -968,7 +984,7 @@
<li class="md-nav__item">
- <a href="../../streampipes_function/" class="md-nav__link">
+ <a href="../../../streampipes_function/" class="md-nav__link">
Streampipes function
</a>
</li>
@@ -1005,6 +1021,8 @@
+
+
<label class="md-nav__link" for="__nav_4_4_4" id="__nav_4_4_4_label" tabindex="0">
@@ -1025,7 +1043,7 @@
<li class="md-nav__item">
- <a href="../broker/" class="md-nav__link">
+ <a href="../../broker/" class="md-nav__link">
Broker
</a>
</li>
@@ -1039,7 +1057,7 @@
<li class="md-nav__item">
- <a href="../broker_handler/" class="md-nav__link">
+ <a href="../../broker_handler/" class="md-nav__link">
Broker handler
</a>
</li>
@@ -1053,8 +1071,8 @@
<li class="md-nav__item">
- <a href="../kafka_broker/" class="md-nav__link">
- Kafka broker
+ <a href="../../consumer/" class="md-nav__link">
+ Consumer
</a>
</li>
@@ -1067,8 +1085,22 @@
<li class="md-nav__item">
- <a href="../kafka_message_fetcher/" class="md-nav__link">
- Kafka message fetcher
+ <a href="../../output_collector/" class="md-nav__link">
+ Output collector
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../../publisher/" class="md-nav__link">
+ Publisher
</a>
</li>
@@ -1079,10 +1111,47 @@
+
+
+
+
+ <li class="md-nav__item md-nav__item--active md-nav__item--nested">
+
+
+
+
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_4_4_6" checked>
+
+
+
+
+
+
+
+
+
+
+
+ <label class="md-nav__link" for="__nav_4_4_4_6" id="__nav_4_4_4_6_label" tabindex="0">
+ Kafka
+ <span class="md-nav__icon md-icon"></span>
+ </label>
+
+ <nav class="md-nav" data-md-level="4" aria-labelledby="__nav_4_4_4_6_label" aria-expanded="true">
+ <label class="md-nav__title" for="__nav_4_4_4_6">
+ <span class="md-nav__icon md-icon"></span>
+ Kafka
+ </label>
+ <ul class="md-nav__list" data-md-scrollfix>
+
+
+
+
+
<li class="md-nav__item">
- <a href="../nats_broker/" class="md-nav__link">
- Nats broker
+ <a href="../kafka_consumer/" class="md-nav__link">
+ Kafka consumer
</a>
</li>
@@ -1103,12 +1172,12 @@
<label class="md-nav__link md-nav__link--active" for="__toc">
- Output collector
+ Kafka message fetcher
<span class="md-nav__icon md-icon"></span>
</label>
<a href="./" class="md-nav__link md-nav__link--active">
- Output collector
+ Kafka message fetcher
</a>
@@ -1125,37 +1194,24 @@
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
- <a href="#streampipes.functions.broker.output_collector" class="md-nav__link">
- streampipes.functions.broker.output_collector
+ <a href="#streampipes.functions.broker.kafka.kafka_message_fetcher" class="md-nav__link">
+ streampipes.functions.broker.kafka.kafka_message_fetcher
</a>
</li>
<li class="md-nav__item">
- <a href="#streampipes.functions.broker.output_collector.OutputCollector" class="md-nav__link">
- OutputCollector
- </a>
-
- <nav class="md-nav" aria-label="OutputCollector">
- <ul class="md-nav__list">
-
- <li class="md-nav__item">
- <a href="#streampipes.functions.broker.output_collector.OutputCollector.collect" class="md-nav__link">
- collect()
+ <a href="#streampipes.functions.broker.kafka.kafka_message_fetcher.KafkaMessage" class="md-nav__link">
+ KafkaMessage
</a>
</li>
-
- <li class="md-nav__item">
- <a href="#streampipes.functions.broker.output_collector.OutputCollector.disconnect" class="md-nav__link">
- disconnect()
+
+ <li class="md-nav__item">
+ <a href="#streampipes.functions.broker.kafka.kafka_message_fetcher.KafkaMessageFetcher" class="md-nav__link">
+ KafkaMessageFetcher
</a>
-</li>
-
- </ul>
- </nav>
-
</li>
</ul>
@@ -1167,6 +1223,95 @@
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../kafka_publisher/" class="md-nav__link">
+ Kafka publisher
+ </a>
+ </li>
+
+
+
+
+ </ul>
+ </nav>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item md-nav__item--nested">
+
+
+
+
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_4_4_7" >
+
+
+
+
+
+
+
+
+
+ <label class="md-nav__link" for="__nav_4_4_4_7" id="__nav_4_4_4_7_label" tabindex="0">
+ Nats
+ <span class="md-nav__icon md-icon"></span>
+ </label>
+
+ <nav class="md-nav" data-md-level="4" aria-labelledby="__nav_4_4_4_7_label" aria-expanded="false">
+ <label class="md-nav__title" for="__nav_4_4_4_7">
+ <span class="md-nav__icon md-icon"></span>
+ Nats
+ </label>
+ <ul class="md-nav__list" data-md-scrollfix>
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../../nats/nats_consumer/" class="md-nav__link">
+ Nats consumer
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../../nats/nats_publisher/" class="md-nav__link">
+ Nats publisher
+ </a>
+ </li>
+
+
+
+
+ </ul>
+ </nav>
+ </li>
+
+
+
+
</ul>
</nav>
</li>
@@ -1217,7 +1362,7 @@
<li class="md-nav__item">
- <a href="../../utils/async_iter_handler/" class="md-nav__link">
+ <a href="../../../utils/async_iter_handler/" class="md-nav__link">
Async iter handler
</a>
</li>
@@ -1231,7 +1376,7 @@
<li class="md-nav__item">
- <a href="../../utils/data_stream_context/" class="md-nav__link">
+ <a href="../../../utils/data_stream_context/" class="md-nav__link">
Data stream context
</a>
</li>
@@ -1245,7 +1390,7 @@
<li class="md-nav__item">
- <a href="../../utils/data_stream_generator/" class="md-nav__link">
+ <a href="../../../utils/data_stream_generator/" class="md-nav__link">
Data stream generator
</a>
</li>
@@ -1259,7 +1404,7 @@
<li class="md-nav__item">
- <a href="../../utils/function_context/" class="md-nav__link">
+ <a href="../../../utils/function_context/" class="md-nav__link">
Function context
</a>
</li>
@@ -1322,7 +1467,7 @@
<li class="md-nav__item">
- <a href="../../../model/common/" class="md-nav__link">
+ <a href="../../../../model/common/" class="md-nav__link">
Common
</a>
</li>
@@ -1351,6 +1496,8 @@
+
+
<label class="md-nav__link" for="__nav_4_5_2" id="__nav_4_5_2_label" tabindex="0">
@@ -1371,7 +1518,7 @@
<li class="md-nav__item">
- <a href="../../../model/container/data_lake_measures/" class="md-nav__link">
+ <a href="../../../../model/container/data_lake_measures/" class="md-nav__link">
Data lake measures
</a>
</li>
@@ -1385,7 +1532,7 @@
<li class="md-nav__item">
- <a href="../../../model/container/data_streams/" class="md-nav__link">
+ <a href="../../../../model/container/data_streams/" class="md-nav__link">
Data streams
</a>
</li>
@@ -1399,7 +1546,7 @@
<li class="md-nav__item">
- <a href="../../../model/container/resource_container/" class="md-nav__link">
+ <a href="../../../../model/container/resource_container/" class="md-nav__link">
Resource container
</a>
</li>
@@ -1407,6 +1554,20 @@
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../../../../model/container/versions/" class="md-nav__link">
+ Versions
+ </a>
+ </li>
+
+
+
+
</ul>
</nav>
</li>
@@ -1443,6 +1604,8 @@
+
+
<label class="md-nav__link" for="__nav_4_5_3" id="__nav_4_5_3_label" tabindex="0">
@@ -1463,7 +1626,7 @@
<li class="md-nav__item">
- <a href="../../../model/resource/data_lake_measure/" class="md-nav__link">
+ <a href="../../../../model/resource/data_lake_measure/" class="md-nav__link">
Data lake measure
</a>
</li>
@@ -1477,7 +1640,7 @@
<li class="md-nav__item">
- <a href="../../../model/resource/data_series/" class="md-nav__link">
+ <a href="../../../../model/resource/data_series/" class="md-nav__link">
Data series
</a>
</li>
@@ -1491,7 +1654,7 @@
<li class="md-nav__item">
- <a href="../../../model/resource/data_stream/" class="md-nav__link">
+ <a href="../../../../model/resource/data_stream/" class="md-nav__link">
Data stream
</a>
</li>
@@ -1505,7 +1668,7 @@
<li class="md-nav__item">
- <a href="../../../model/resource/exceptions/" class="md-nav__link">
+ <a href="../../../../model/resource/exceptions/" class="md-nav__link">
Exceptions
</a>
</li>
@@ -1519,7 +1682,7 @@
<li class="md-nav__item">
- <a href="../../../model/resource/function_definition/" class="md-nav__link">
+ <a href="../../../../model/resource/function_definition/" class="md-nav__link">
Function definition
</a>
</li>
@@ -1533,7 +1696,7 @@
<li class="md-nav__item">
- <a href="../../../model/resource/query_result/" class="md-nav__link">
+ <a href="../../../../model/resource/query_result/" class="md-nav__link">
Query result
</a>
</li>
@@ -1547,7 +1710,7 @@
<li class="md-nav__item">
- <a href="../../../model/resource/resource/" class="md-nav__link">
+ <a href="../../../../model/resource/resource/" class="md-nav__link">
Resource
</a>
</li>
@@ -1555,6 +1718,20 @@
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../../../../model/resource/version/" class="md-nav__link">
+ Version
+ </a>
+ </li>
+
+
+
+
</ul>
</nav>
</li>
@@ -1600,37 +1777,24 @@
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
- <a href="#streampipes.functions.broker.output_collector" class="md-nav__link">
- streampipes.functions.broker.output_collector
+ <a href="#streampipes.functions.broker.kafka.kafka_message_fetcher" class="md-nav__link">
+ streampipes.functions.broker.kafka.kafka_message_fetcher
</a>
</li>
<li class="md-nav__item">
- <a href="#streampipes.functions.broker.output_collector.OutputCollector" class="md-nav__link">
- OutputCollector
- </a>
-
- <nav class="md-nav" aria-label="OutputCollector">
- <ul class="md-nav__list">
-
- <li class="md-nav__item">
- <a href="#streampipes.functions.broker.output_collector.OutputCollector.collect" class="md-nav__link">
- collect()
+ <a href="#streampipes.functions.broker.kafka.kafka_message_fetcher.KafkaMessage" class="md-nav__link">
+ KafkaMessage
</a>
</li>
-
- <li class="md-nav__item">
- <a href="#streampipes.functions.broker.output_collector.OutputCollector.disconnect" class="md-nav__link">
- disconnect()
+
+ <li class="md-nav__item">
+ <a href="#streampipes.functions.broker.kafka.kafka_message_fetcher.KafkaMessageFetcher" class="md-nav__link">
+ KafkaMessageFetcher
</a>
-</li>
-
- </ul>
- </nav>
-
</li>
</ul>
@@ -1651,12 +1815,12 @@
- <h1>Output collector</h1>
+ <h1>Kafka message fetcher</h1>
<div class="doc doc-object doc-module">
-<a id="streampipes.functions.broker.output_collector"></a>
+<a id="streampipes.functions.broker.kafka.kafka_message_fetcher"></a>
<div class="doc doc-contents first">
@@ -1674,17 +1838,16 @@
-<h2 id="streampipes.functions.broker.output_collector.OutputCollector" class="doc doc-heading">
-<code class="highlight language-python"><span class="n">OutputCollector</span><span class="p">(</span><span class="n">data_stream</span><span class="p">)</span></code>
+<h2 id="streampipes.functions.broker.kafka.kafka_message_fetcher.KafkaMessage" class="doc doc-heading">
+<code class="highlight language-python"><span class="n">KafkaMessage</span><span class="p">(</span><span class="n">data</span><span class="p">)</span></code>
-<a href="#streampipes.functions.broker.output_collector.OutputCollector" class="headerlink" title="Permanent link">¶</a></h2>
+<a href="#streampipes.functions.broker.kafka.kafka_message_fetcher.KafkaMessage" class="headerlink" title="Permanent link">¶</a></h2>
<div class="doc doc-contents ">
- <p>Collector for output events. The events are published to an output data stream.
-Therefore, the output collector establishes a connection to the broker.</p>
+ <p>An internal representation of a Kafka message</p>
<table>
<thead>
@@ -1695,37 +1858,10 @@ Therefore, the output collector establishes a connection to the broker.</p>
</thead>
<tbody>
<tr>
- <td><code>data_stream</code></td>
+ <td><code>data</code></td>
<td class="doc-param-details">
- <p>The output data stream that will receive the events.</p>
- <p>
- <span class="doc-param-annotation">
- <b>TYPE:</b>
- <code><a class="autorefs autorefs-internal" title="streampipes.model.resource.data_stream.DataStream" href="../../../model/resource/data_stream/#streampipes.model.resource.data_stream.DataStream">DataStream</a></code>
- </span>
- </p>
- </td>
- </tr>
- </tbody>
- </table>
-
- <table>
- <thead>
- <tr>
- <th><b>ATTRIBUTE</b></th>
- <th><b>DESCRIPTION</b></th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><code>broker</code></td>
- <td class="doc-attribute-details">
- <p>The broker instance that sends the data to StreamPipes</p>
+ <p>The received Kafka message as byte array</p>
<p>
- <span class="doc-attribute-annotation">
- <b>TYPE:</b>
- <code><a class="autorefs autorefs-internal" title="streampipes.functions.broker.broker.Broker" href="../broker/#streampipes.functions.broker.broker.Broker">Broker</a></code>
- </span>
</p>
</td>
</tr>
@@ -1746,19 +1882,28 @@ Therefore, the output collector establishes a connection to the broker.</p>
-<div class="doc doc-object doc-function">
+ </div>
+
+ </div>
+
+</div>
+
+<div class="doc doc-object doc-class">
+
-<h3 id="streampipes.functions.broker.output_collector.OutputCollector.collect" class="doc doc-heading">
-<code class="highlight language-python"><span class="n">collect</span><span class="p">(</span><span class="n">event</span><span class="p">)</span></code>
-<a href="#streampipes.functions.broker.output_collector.OutputCollector.collect" class="headerlink" title="Permanent link">¶</a></h3>
+<h2 id="streampipes.functions.broker.kafka.kafka_message_fetcher.KafkaMessageFetcher" class="doc doc-heading">
+<code class="highlight language-python"><span class="n">KafkaMessageFetcher</span><span class="p">(</span><span class="n">consumer</span><span class="p">)</span></code>
+
+<a href="#streampipes.functions.broker.kafka.kafka_message_fetcher.KafkaMessageFetcher" class="headerlink" title="Permanent link">¶</a></h2>
<div class="doc doc-contents ">
+
- <p>Publishes an event to the output stream.</p>
+ <p>Fetches the next message from Kafka</p>
<table>
<thead>
@@ -1769,13 +1914,13 @@ Therefore, the output collector establishes a connection to the broker.</p>
</thead>
<tbody>
<tr>
- <td><code>event</code></td>
+ <td><code>consumer</code></td>
<td class="doc-param-details">
- <p>The event to be published.</p>
+ <p>The Kafka consumer</p>
<p>
<span class="doc-param-annotation">
<b>TYPE:</b>
- <code><span title="typing.Dict">Dict</span>[str, <span title="typing.Any">Any</span>]</code>
+ <code><span title="confluent_kafka.Consumer">Consumer</span></code>
</span>
</p>
</td>
@@ -1783,69 +1928,19 @@ Therefore, the output collector establishes a connection to the broker.</p>
</tbody>
</table>
- <table>
- <thead>
- <tr>
- <th><b>RETURNS</b></th>
- <th><b>DESCRIPTION</b></th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <span class="doc-returns-annotation">
- <code>None</code>
- </span>
- </td>
- <td class="doc-returns-details">
-
- </td>
- </tr>
- </tbody>
- </table>
- </div>
-</div>
+
-<div class="doc doc-object doc-function">
+ <div class="doc doc-children">
-<h3 id="streampipes.functions.broker.output_collector.OutputCollector.disconnect" class="doc doc-heading">
-<code class="highlight language-python"><span class="n">disconnect</span><span class="p">()</span></code>
-<a href="#streampipes.functions.broker.output_collector.OutputCollector.disconnect" class="headerlink" title="Permanent link">¶</a></h3>
- <div class="doc doc-contents ">
-
- <p>Disconnects the broker of the output collector.</p>
- <table>
- <thead>
- <tr>
- <th><b>RETURNS</b></th>
- <th><b>DESCRIPTION</b></th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <span class="doc-returns-annotation">
- <code>None</code>
- </span>
- </td>
- <td class="doc-returns-details">
-
- </td>
- </tr>
- </tbody>
- </table>
- </div>
-
-</div>
@@ -1921,10 +2016,10 @@ Therefore, the output collector establishes a connection to the broker.</p>
<div class="md-dialog__inner md-typeset"></div>
</div>
- <script id="__config" type="application/json">{"base": "../../../..", "features": ["navigation.tabs", "navigation.tabs.sticky", "navigation.instant", "navigation.indexes", "navigation.tracking"], "search": "../../../../assets/javascripts/workers/search.208ed371.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.non [...]
+ <script id="__config" type="application/json">{"base": "../../../../..", "features": ["navigation.tabs", "navigation.tabs.sticky", "navigation.instant", "navigation.indexes", "navigation.tracking"], "search": "../../../../../assets/javascripts/workers/search.208ed371.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.resu [...]
- <script src="../../../../assets/javascripts/bundle.efa0ade1.min.js"></script>
+ <script src="../../../../../assets/javascripts/bundle.efa0ade1.min.js"></script>
</body>
diff --git a/docs-python/dev/reference/functions/broker/output_collector/index.html b/docs-python/dev/reference/functions/broker/kafka/kafka_publisher/index.html
similarity index 76%
copy from docs-python/dev/reference/functions/broker/output_collector/index.html
copy to docs-python/dev/reference/functions/broker/kafka/kafka_publisher/index.html
index 941baf21..d348997e 100644
--- a/docs-python/dev/reference/functions/broker/output_collector/index.html
+++ b/docs-python/dev/reference/functions/broker/kafka/kafka_publisher/index.html
@@ -31,27 +31,27 @@
<meta name="author" content="Apache Software Foundation (ASF)">
- <link rel="canonical" href="https://streampipes.apache.org/docs/docs/python/latest/latest/reference/functions/broker/output_collector/">
+ <link rel="canonical" href="https://streampipes.apache.org/docs/docs/python/latest/latest/reference/functions/broker/kafka/kafka_publisher/">
- <link rel="prev" href="../nats_broker/">
+ <link rel="prev" href="../kafka_message_fetcher/">
- <link rel="next" href="../../utils/async_iter_handler/">
+ <link rel="next" href="../../nats/nats_consumer/">
<link rel="icon" href="https://streampipes.apache.org/img/favicon/favicon.png">
<meta name="generator" content="mkdocs-1.4.2, mkdocs-material-9.1.3">
- <title>Output collector - Apache StreamPipes Python</title>
+ <title>Kafka publisher - Apache StreamPipes Python</title>
- <link rel="stylesheet" href="../../../../assets/stylesheets/main.c4a75a56.min.css">
+ <link rel="stylesheet" href="../../../../../assets/stylesheets/main.c4a75a56.min.css">
- <link rel="stylesheet" href="../../../../assets/stylesheets/palette.a0c5b2b5.min.css">
+ <link rel="stylesheet" href="../../../../../assets/stylesheets/palette.a0c5b2b5.min.css">
@@ -61,11 +61,11 @@
- <link rel="stylesheet" href="../../../../assets/_mkdocstrings.css">
+ <link rel="stylesheet" href="../../../../../assets/_mkdocstrings.css">
- <link rel="stylesheet" href="../../../../stylesheets/extra.css">
+ <link rel="stylesheet" href="../../../../../stylesheets/extra.css">
- <script>__md_scope=new URL("../../../..",location),__md_hash=e=>[...e].reduce((e,_)=>(e<<5)-e+_.charCodeAt(0),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
+ <script>__md_scope=new URL("../../../../..",location),__md_hash=e=>[...e].reduce((e,_)=>(e<<5)-e+_.charCodeAt(0),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
@@ -136,7 +136,7 @@
<div data-md-component="skip">
- <a href="#streampipes.functions.broker.output_collector" class="md-skip">
+ <a href="#streampipes.functions.broker.kafka.kafka_publisher" class="md-skip">
Skip to content
</a>
@@ -174,7 +174,7 @@
<div class="md-header__topic" data-md-component="header-topic">
<span class="md-ellipsis">
- Output collector
+ Kafka publisher
</span>
</div>
@@ -263,7 +263,7 @@
<li class="md-tabs__item">
- <a href="../../../.." class="md-tabs__link">
+ <a href="../../../../.." class="md-tabs__link">
🏡 Home
</a>
</li>
@@ -278,7 +278,7 @@
<li class="md-tabs__item">
- <a href="../../../../getting-started/first-steps/" class="md-tabs__link">
+ <a href="../../../../../getting-started/first-steps/" class="md-tabs__link">
🚀 Getting Started
</a>
</li>
@@ -294,7 +294,7 @@
<li class="md-tabs__item">
- <a href="../../../../tutorials/1-introduction-to-streampipes-python-client/" class="md-tabs__link">
+ <a href="../../../../../tutorials/1-introduction-to-streampipes-python-client/" class="md-tabs__link">
🤓 Tutorials
</a>
</li>
@@ -317,7 +317,7 @@
<li class="md-tabs__item">
- <a href="../../../client/client/" class="md-tabs__link md-tabs__link--active">
+ <a href="../../../../client/client/" class="md-tabs__link md-tabs__link--active">
📚 Reference
</a>
</li>
@@ -383,7 +383,7 @@
<li class="md-nav__item">
- <a href="../../../.." class="md-nav__link">
+ <a href="../../../../.." class="md-nav__link">
🏡 Home
</a>
</li>
@@ -433,7 +433,7 @@
<li class="md-nav__item">
- <a href="../../../../getting-started/first-steps/" class="md-nav__link">
+ <a href="../../../../../getting-started/first-steps/" class="md-nav__link">
First Steps
</a>
</li>
@@ -447,7 +447,7 @@
<li class="md-nav__item">
- <a href="../../../../getting-started/developing/" class="md-nav__link">
+ <a href="../../../../../getting-started/developing/" class="md-nav__link">
Developing & Contributing
</a>
</li>
@@ -461,7 +461,7 @@
<li class="md-nav__item">
- <a href="../../../../getting-started/quickstart/" class="md-nav__link">
+ <a href="../../../../../getting-started/quickstart/" class="md-nav__link">
Quickstart
</a>
</li>
@@ -520,7 +520,7 @@
<li class="md-nav__item">
- <a href="../../../../tutorials/1-introduction-to-streampipes-python-client/" class="md-nav__link">
+ <a href="../../../../../tutorials/1-introduction-to-streampipes-python-client/" class="md-nav__link">
Introduction to StreamPipes Python
</a>
</li>
@@ -534,7 +534,7 @@
<li class="md-nav__item">
- <a href="../../../../tutorials/2-extracting-data-from-the-streampipes-data-lake/" class="md-nav__link">
+ <a href="../../../../../tutorials/2-extracting-data-from-the-streampipes-data-lake/" class="md-nav__link">
Extracting Data from the StreamPipes data lake
</a>
</li>
@@ -548,7 +548,7 @@
<li class="md-nav__item">
- <a href="../../../../tutorials/3-getting-live-data-from-the-streampipes-data-stream/" class="md-nav__link">
+ <a href="../../../../../tutorials/3-getting-live-data-from-the-streampipes-data-stream/" class="md-nav__link">
Getting live data from the StreamPipes data stream
</a>
</li>
@@ -562,7 +562,7 @@
<li class="md-nav__item">
- <a href="../../../../tutorials/4-using-online-machine-learning-on-a-streampipes-data-stream/" class="md-nav__link">
+ <a href="../../../../../tutorials/4-using-online-machine-learning-on-a-streampipes-data-stream/" class="md-nav__link">
Using Online Machine Learning on a StreamPipes data stream
</a>
</li>
@@ -660,7 +660,7 @@
<li class="md-nav__item">
- <a href="../../../client/client/" class="md-nav__link">
+ <a href="../../../../client/client/" class="md-nav__link">
Client
</a>
</li>
@@ -674,7 +674,7 @@
<li class="md-nav__item">
- <a href="../../../client/config/" class="md-nav__link">
+ <a href="../../../../client/config/" class="md-nav__link">
Config
</a>
</li>
@@ -688,7 +688,7 @@
<li class="md-nav__item">
- <a href="../../../client/credential_provider/" class="md-nav__link">
+ <a href="../../../../client/credential_provider/" class="md-nav__link">
Credential provider
</a>
</li>
@@ -744,7 +744,7 @@
<li class="md-nav__item">
- <a href="../../../endpoint/endpoint/" class="md-nav__link">
+ <a href="../../../../endpoint/endpoint/" class="md-nav__link">
Endpoint
</a>
</li>
@@ -758,7 +758,7 @@
<li class="md-nav__item">
- <a href="../../../endpoint/exceptions/" class="md-nav__link">
+ <a href="../../../../endpoint/exceptions/" class="md-nav__link">
Exceptions
</a>
</li>
@@ -785,6 +785,8 @@
+
+
<label class="md-nav__link" for="__nav_4_2_3" id="__nav_4_2_3_label" tabindex="0">
@@ -805,7 +807,7 @@
<li class="md-nav__item">
- <a href="../../../endpoint/api/data_lake_measure/" class="md-nav__link">
+ <a href="../../../../endpoint/api/data_lake_measure/" class="md-nav__link">
Data lake measure
</a>
</li>
@@ -819,7 +821,7 @@
<li class="md-nav__item">
- <a href="../../../endpoint/api/data_stream/" class="md-nav__link">
+ <a href="../../../../endpoint/api/data_stream/" class="md-nav__link">
Data stream
</a>
</li>
@@ -827,6 +829,20 @@
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../../../../endpoint/api/version/" class="md-nav__link">
+ Version
+ </a>
+ </li>
+
+
+
+
</ul>
</nav>
</li>
@@ -878,7 +894,7 @@
<li class="md-nav__item">
- <a href="../../../function_zoo/river_function/" class="md-nav__link">
+ <a href="../../../../function_zoo/river_function/" class="md-nav__link">
River function
</a>
</li>
@@ -940,7 +956,7 @@
<li class="md-nav__item">
- <a href="../../function_handler/" class="md-nav__link">
+ <a href="../../../function_handler/" class="md-nav__link">
Function handler
</a>
</li>
@@ -954,7 +970,7 @@
<li class="md-nav__item">
- <a href="../../registration/" class="md-nav__link">
+ <a href="../../../registration/" class="md-nav__link">
Registration
</a>
</li>
@@ -968,7 +984,7 @@
<li class="md-nav__item">
- <a href="../../streampipes_function/" class="md-nav__link">
+ <a href="../../../streampipes_function/" class="md-nav__link">
Streampipes function
</a>
</li>
@@ -1005,6 +1021,8 @@
+
+
<label class="md-nav__link" for="__nav_4_4_4" id="__nav_4_4_4_label" tabindex="0">
@@ -1025,7 +1043,7 @@
<li class="md-nav__item">
- <a href="../broker/" class="md-nav__link">
+ <a href="../../broker/" class="md-nav__link">
Broker
</a>
</li>
@@ -1039,7 +1057,7 @@
<li class="md-nav__item">
- <a href="../broker_handler/" class="md-nav__link">
+ <a href="../../broker_handler/" class="md-nav__link">
Broker handler
</a>
</li>
@@ -1053,8 +1071,8 @@
<li class="md-nav__item">
- <a href="../kafka_broker/" class="md-nav__link">
- Kafka broker
+ <a href="../../consumer/" class="md-nav__link">
+ Consumer
</a>
</li>
@@ -1067,8 +1085,8 @@
<li class="md-nav__item">
- <a href="../kafka_message_fetcher/" class="md-nav__link">
- Kafka message fetcher
+ <a href="../../output_collector/" class="md-nav__link">
+ Output collector
</a>
</li>
@@ -1081,8 +1099,73 @@
<li class="md-nav__item">
- <a href="../nats_broker/" class="md-nav__link">
- Nats broker
+ <a href="../../publisher/" class="md-nav__link">
+ Publisher
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item md-nav__item--active md-nav__item--nested">
+
+
+
+
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_4_4_6" checked>
+
+
+
+
+
+
+
+
+
+
+
+ <label class="md-nav__link" for="__nav_4_4_4_6" id="__nav_4_4_4_6_label" tabindex="0">
+ Kafka
+ <span class="md-nav__icon md-icon"></span>
+ </label>
+
+ <nav class="md-nav" data-md-level="4" aria-labelledby="__nav_4_4_4_6_label" aria-expanded="true">
+ <label class="md-nav__title" for="__nav_4_4_4_6">
+ <span class="md-nav__icon md-icon"></span>
+ Kafka
+ </label>
+ <ul class="md-nav__list" data-md-scrollfix>
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../kafka_consumer/" class="md-nav__link">
+ Kafka consumer
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../kafka_message_fetcher/" class="md-nav__link">
+ Kafka message fetcher
</a>
</li>
@@ -1103,12 +1186,12 @@
<label class="md-nav__link md-nav__link--active" for="__toc">
- Output collector
+ Kafka publisher
<span class="md-nav__icon md-icon"></span>
</label>
<a href="./" class="md-nav__link md-nav__link--active">
- Output collector
+ Kafka publisher
</a>
@@ -1125,30 +1208,30 @@
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
- <a href="#streampipes.functions.broker.output_collector" class="md-nav__link">
- streampipes.functions.broker.output_collector
+ <a href="#streampipes.functions.broker.kafka.kafka_publisher" class="md-nav__link">
+ streampipes.functions.broker.kafka.kafka_publisher
</a>
</li>
<li class="md-nav__item">
- <a href="#streampipes.functions.broker.output_collector.OutputCollector" class="md-nav__link">
- OutputCollector
+ <a href="#streampipes.functions.broker.kafka.kafka_publisher.KafkaPublisher" class="md-nav__link">
+ KafkaPublisher
</a>
- <nav class="md-nav" aria-label="OutputCollector">
+ <nav class="md-nav" aria-label="KafkaPublisher">
<ul class="md-nav__list">
<li class="md-nav__item">
- <a href="#streampipes.functions.broker.output_collector.OutputCollector.collect" class="md-nav__link">
- collect()
+ <a href="#streampipes.functions.broker.kafka.kafka_publisher.KafkaPublisher.disconnect" class="md-nav__link">
+ disconnect()
</a>
</li>
<li class="md-nav__item">
- <a href="#streampipes.functions.broker.output_collector.OutputCollector.disconnect" class="md-nav__link">
- disconnect()
+ <a href="#streampipes.functions.broker.kafka.kafka_publisher.KafkaPublisher.publish_event" class="md-nav__link">
+ publish_event()
</a>
</li>
@@ -1180,6 +1263,81 @@
+ <li class="md-nav__item md-nav__item--nested">
+
+
+
+
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_4_4_7" >
+
+
+
+
+
+
+
+
+
+ <label class="md-nav__link" for="__nav_4_4_4_7" id="__nav_4_4_4_7_label" tabindex="0">
+ Nats
+ <span class="md-nav__icon md-icon"></span>
+ </label>
+
+ <nav class="md-nav" data-md-level="4" aria-labelledby="__nav_4_4_4_7_label" aria-expanded="false">
+ <label class="md-nav__title" for="__nav_4_4_4_7">
+ <span class="md-nav__icon md-icon"></span>
+ Nats
+ </label>
+ <ul class="md-nav__list" data-md-scrollfix>
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../../nats/nats_consumer/" class="md-nav__link">
+ Nats consumer
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../../nats/nats_publisher/" class="md-nav__link">
+ Nats publisher
+ </a>
+ </li>
+
+
+
+
+ </ul>
+ </nav>
+ </li>
+
+
+
+
+ </ul>
+ </nav>
+ </li>
+
+
+
+
+
+
+
+
+
+
<li class="md-nav__item md-nav__item--nested">
@@ -1217,7 +1375,7 @@
<li class="md-nav__item">
- <a href="../../utils/async_iter_handler/" class="md-nav__link">
+ <a href="../../../utils/async_iter_handler/" class="md-nav__link">
Async iter handler
</a>
</li>
@@ -1231,7 +1389,7 @@
<li class="md-nav__item">
- <a href="../../utils/data_stream_context/" class="md-nav__link">
+ <a href="../../../utils/data_stream_context/" class="md-nav__link">
Data stream context
</a>
</li>
@@ -1245,7 +1403,7 @@
<li class="md-nav__item">
- <a href="../../utils/data_stream_generator/" class="md-nav__link">
+ <a href="../../../utils/data_stream_generator/" class="md-nav__link">
Data stream generator
</a>
</li>
@@ -1259,7 +1417,7 @@
<li class="md-nav__item">
- <a href="../../utils/function_context/" class="md-nav__link">
+ <a href="../../../utils/function_context/" class="md-nav__link">
Function context
</a>
</li>
@@ -1322,7 +1480,7 @@
<li class="md-nav__item">
- <a href="../../../model/common/" class="md-nav__link">
+ <a href="../../../../model/common/" class="md-nav__link">
Common
</a>
</li>
@@ -1351,6 +1509,8 @@
+
+
<label class="md-nav__link" for="__nav_4_5_2" id="__nav_4_5_2_label" tabindex="0">
@@ -1371,7 +1531,7 @@
<li class="md-nav__item">
- <a href="../../../model/container/data_lake_measures/" class="md-nav__link">
+ <a href="../../../../model/container/data_lake_measures/" class="md-nav__link">
Data lake measures
</a>
</li>
@@ -1385,7 +1545,7 @@
<li class="md-nav__item">
- <a href="../../../model/container/data_streams/" class="md-nav__link">
+ <a href="../../../../model/container/data_streams/" class="md-nav__link">
Data streams
</a>
</li>
@@ -1399,7 +1559,7 @@
<li class="md-nav__item">
- <a href="../../../model/container/resource_container/" class="md-nav__link">
+ <a href="../../../../model/container/resource_container/" class="md-nav__link">
Resource container
</a>
</li>
@@ -1407,6 +1567,20 @@
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../../../../model/container/versions/" class="md-nav__link">
+ Versions
+ </a>
+ </li>
+
+
+
+
</ul>
</nav>
</li>
@@ -1443,6 +1617,8 @@
+
+
<label class="md-nav__link" for="__nav_4_5_3" id="__nav_4_5_3_label" tabindex="0">
@@ -1463,7 +1639,7 @@
<li class="md-nav__item">
- <a href="../../../model/resource/data_lake_measure/" class="md-nav__link">
+ <a href="../../../../model/resource/data_lake_measure/" class="md-nav__link">
Data lake measure
</a>
</li>
@@ -1477,7 +1653,7 @@
<li class="md-nav__item">
- <a href="../../../model/resource/data_series/" class="md-nav__link">
+ <a href="../../../../model/resource/data_series/" class="md-nav__link">
Data series
</a>
</li>
@@ -1491,7 +1667,7 @@
<li class="md-nav__item">
- <a href="../../../model/resource/data_stream/" class="md-nav__link">
+ <a href="../../../../model/resource/data_stream/" class="md-nav__link">
Data stream
</a>
</li>
@@ -1505,7 +1681,7 @@
<li class="md-nav__item">
- <a href="../../../model/resource/exceptions/" class="md-nav__link">
+ <a href="../../../../model/resource/exceptions/" class="md-nav__link">
Exceptions
</a>
</li>
@@ -1519,7 +1695,7 @@
<li class="md-nav__item">
- <a href="../../../model/resource/function_definition/" class="md-nav__link">
+ <a href="../../../../model/resource/function_definition/" class="md-nav__link">
Function definition
</a>
</li>
@@ -1533,7 +1709,7 @@
<li class="md-nav__item">
- <a href="../../../model/resource/query_result/" class="md-nav__link">
+ <a href="../../../../model/resource/query_result/" class="md-nav__link">
Query result
</a>
</li>
@@ -1547,7 +1723,7 @@
<li class="md-nav__item">
- <a href="../../../model/resource/resource/" class="md-nav__link">
+ <a href="../../../../model/resource/resource/" class="md-nav__link">
Resource
</a>
</li>
@@ -1555,6 +1731,20 @@
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../../../../model/resource/version/" class="md-nav__link">
+ Version
+ </a>
+ </li>
+
+
+
+
</ul>
</nav>
</li>
@@ -1600,30 +1790,30 @@
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
- <a href="#streampipes.functions.broker.output_collector" class="md-nav__link">
- streampipes.functions.broker.output_collector
+ <a href="#streampipes.functions.broker.kafka.kafka_publisher" class="md-nav__link">
+ streampipes.functions.broker.kafka.kafka_publisher
</a>
</li>
<li class="md-nav__item">
- <a href="#streampipes.functions.broker.output_collector.OutputCollector" class="md-nav__link">
- OutputCollector
+ <a href="#streampipes.functions.broker.kafka.kafka_publisher.KafkaPublisher" class="md-nav__link">
+ KafkaPublisher
</a>
- <nav class="md-nav" aria-label="OutputCollector">
+ <nav class="md-nav" aria-label="KafkaPublisher">
<ul class="md-nav__list">
<li class="md-nav__item">
- <a href="#streampipes.functions.broker.output_collector.OutputCollector.collect" class="md-nav__link">
- collect()
+ <a href="#streampipes.functions.broker.kafka.kafka_publisher.KafkaPublisher.disconnect" class="md-nav__link">
+ disconnect()
</a>
</li>
<li class="md-nav__item">
- <a href="#streampipes.functions.broker.output_collector.OutputCollector.disconnect" class="md-nav__link">
- disconnect()
+ <a href="#streampipes.functions.broker.kafka.kafka_publisher.KafkaPublisher.publish_event" class="md-nav__link">
+ publish_event()
</a>
</li>
@@ -1651,12 +1841,12 @@
- <h1>Output collector</h1>
+ <h1>Kafka publisher</h1>
<div class="doc doc-object doc-module">
-<a id="streampipes.functions.broker.output_collector"></a>
+<a id="streampipes.functions.broker.kafka.kafka_publisher"></a>
<div class="doc doc-contents first">
@@ -1674,63 +1864,19 @@
-<h2 id="streampipes.functions.broker.output_collector.OutputCollector" class="doc doc-heading">
-<code class="highlight language-python"><span class="n">OutputCollector</span><span class="p">(</span><span class="n">data_stream</span><span class="p">)</span></code>
+<h2 id="streampipes.functions.broker.kafka.kafka_publisher.KafkaPublisher" class="doc doc-heading">
+ <code>KafkaPublisher</code>
+
-<a href="#streampipes.functions.broker.output_collector.OutputCollector" class="headerlink" title="Permanent link">¶</a></h2>
+<a href="#streampipes.functions.broker.kafka.kafka_publisher.KafkaPublisher" class="headerlink" title="Permanent link">¶</a></h2>
<div class="doc doc-contents ">
+ <p class="doc doc-class-bases">
+ Bases: <code><a class="autorefs autorefs-internal" title="streampipes.functions.broker.Publisher" href="../../publisher/#streampipes.functions.broker.publisher.Publisher">Publisher</a></code></p>
- <p>Collector for output events. The events are published to an output data stream.
-Therefore, the output collector establishes a connection to the broker.</p>
-
- <table>
- <thead>
- <tr>
- <th><b>PARAMETER</b></th>
- <th><b>DESCRIPTION</b></th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><code>data_stream</code></td>
- <td class="doc-param-details">
- <p>The output data stream that will receive the events.</p>
- <p>
- <span class="doc-param-annotation">
- <b>TYPE:</b>
- <code><a class="autorefs autorefs-internal" title="streampipes.model.resource.data_stream.DataStream" href="../../../model/resource/data_stream/#streampipes.model.resource.data_stream.DataStream">DataStream</a></code>
- </span>
- </p>
- </td>
- </tr>
- </tbody>
- </table>
-
- <table>
- <thead>
- <tr>
- <th><b>ATTRIBUTE</b></th>
- <th><b>DESCRIPTION</b></th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><code>broker</code></td>
- <td class="doc-attribute-details">
- <p>The broker instance that sends the data to StreamPipes</p>
- <p>
- <span class="doc-attribute-annotation">
- <b>TYPE:</b>
- <code><a class="autorefs autorefs-internal" title="streampipes.functions.broker.broker.Broker" href="../broker/#streampipes.functions.broker.broker.Broker">Broker</a></code>
- </span>
- </p>
- </td>
- </tr>
- </tbody>
- </table>
+ <p>Implementation of a publisher for Kafka</p>
@@ -1750,38 +1896,19 @@ Therefore, the output collector establishes a connection to the broker.</p>
-<h3 id="streampipes.functions.broker.output_collector.OutputCollector.collect" class="doc doc-heading">
-<code class="highlight language-python"><span class="n">collect</span><span class="p">(</span><span class="n">event</span><span class="p">)</span></code>
+<h3 id="streampipes.functions.broker.kafka.kafka_publisher.KafkaPublisher.disconnect" class="doc doc-heading">
+<code class="highlight language-python"><span class="n">disconnect</span><span class="p">()</span></code>
+
+ <span class="doc doc-labels">
+ <small class="doc doc-label doc-label-async"><code>async</code></small>
+ </span>
-<a href="#streampipes.functions.broker.output_collector.OutputCollector.collect" class="headerlink" title="Permanent link">¶</a></h3>
+<a href="#streampipes.functions.broker.kafka.kafka_publisher.KafkaPublisher.disconnect" class="headerlink" title="Permanent link">¶</a></h3>
<div class="doc doc-contents ">
- <p>Publishes an event to the output stream.</p>
-
- <table>
- <thead>
- <tr>
- <th><b>PARAMETER</b></th>
- <th><b>DESCRIPTION</b></th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><code>event</code></td>
- <td class="doc-param-details">
- <p>The event to be published.</p>
- <p>
- <span class="doc-param-annotation">
- <b>TYPE:</b>
- <code><span title="typing.Dict">Dict</span>[str, <span title="typing.Any">Any</span>]</code>
- </span>
- </p>
- </td>
- </tr>
- </tbody>
- </table>
+ <p>Closes the connection to the server.</p>
<table>
<thead>
@@ -1812,15 +1939,42 @@ Therefore, the output collector establishes a connection to the broker.</p>
-<h3 id="streampipes.functions.broker.output_collector.OutputCollector.disconnect" class="doc doc-heading">
-<code class="highlight language-python"><span class="n">disconnect</span><span class="p">()</span></code>
+<h3 id="streampipes.functions.broker.kafka.kafka_publisher.KafkaPublisher.publish_event" class="doc doc-heading">
+<code class="highlight language-python"><span class="n">publish_event</span><span class="p">(</span><span class="n">event</span><span class="p">)</span></code>
+
+ <span class="doc doc-labels">
+ <small class="doc doc-label doc-label-async"><code>async</code></small>
+ </span>
-<a href="#streampipes.functions.broker.output_collector.OutputCollector.disconnect" class="headerlink" title="Permanent link">¶</a></h3>
+<a href="#streampipes.functions.broker.kafka.kafka_publisher.KafkaPublisher.publish_event" class="headerlink" title="Permanent link">¶</a></h3>
<div class="doc doc-contents ">
- <p>Disconnects the broker of the output collector.</p>
+ <p>Publish an event to a connected data stream.</p>
+
+ <table>
+ <thead>
+ <tr>
+ <th><b>PARAMETER</b></th>
+ <th><b>DESCRIPTION</b></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><code>event</code></td>
+ <td class="doc-param-details">
+ <p>The event to be published.</p>
+ <p>
+ <span class="doc-param-annotation">
+ <b>TYPE:</b>
+ <code><span title="typing.Dict">Dict</span>[str, <span title="typing.Any">Any</span>]</code>
+ </span>
+ </p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
<table>
<thead>
@@ -1921,10 +2075,10 @@ Therefore, the output collector establishes a connection to the broker.</p>
<div class="md-dialog__inner md-typeset"></div>
</div>
- <script id="__config" type="application/json">{"base": "../../../..", "features": ["navigation.tabs", "navigation.tabs.sticky", "navigation.instant", "navigation.indexes", "navigation.tracking"], "search": "../../../../assets/javascripts/workers/search.208ed371.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.non [...]
+ <script id="__config" type="application/json">{"base": "../../../../..", "features": ["navigation.tabs", "navigation.tabs.sticky", "navigation.instant", "navigation.indexes", "navigation.tracking"], "search": "../../../../../assets/javascripts/workers/search.208ed371.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.resu [...]
- <script src="../../../../assets/javascripts/bundle.efa0ade1.min.js"></script>
+ <script src="../../../../../assets/javascripts/bundle.efa0ade1.min.js"></script>
</body>
diff --git a/docs-python/dev/reference/functions/broker/output_collector/index.html b/docs-python/dev/reference/functions/broker/nats/nats_consumer/index.html
similarity index 76%
copy from docs-python/dev/reference/functions/broker/output_collector/index.html
copy to docs-python/dev/reference/functions/broker/nats/nats_consumer/index.html
index 941baf21..866a6698 100644
--- a/docs-python/dev/reference/functions/broker/output_collector/index.html
+++ b/docs-python/dev/reference/functions/broker/nats/nats_consumer/index.html
@@ -31,27 +31,27 @@
<meta name="author" content="Apache Software Foundation (ASF)">
- <link rel="canonical" href="https://streampipes.apache.org/docs/docs/python/latest/latest/reference/functions/broker/output_collector/">
+ <link rel="canonical" href="https://streampipes.apache.org/docs/docs/python/latest/latest/reference/functions/broker/nats/nats_consumer/">
- <link rel="prev" href="../nats_broker/">
+ <link rel="prev" href="../../kafka/kafka_publisher/">
- <link rel="next" href="../../utils/async_iter_handler/">
+ <link rel="next" href="../nats_publisher/">
<link rel="icon" href="https://streampipes.apache.org/img/favicon/favicon.png">
<meta name="generator" content="mkdocs-1.4.2, mkdocs-material-9.1.3">
- <title>Output collector - Apache StreamPipes Python</title>
+ <title>Nats consumer - Apache StreamPipes Python</title>
- <link rel="stylesheet" href="../../../../assets/stylesheets/main.c4a75a56.min.css">
+ <link rel="stylesheet" href="../../../../../assets/stylesheets/main.c4a75a56.min.css">
- <link rel="stylesheet" href="../../../../assets/stylesheets/palette.a0c5b2b5.min.css">
+ <link rel="stylesheet" href="../../../../../assets/stylesheets/palette.a0c5b2b5.min.css">
@@ -61,11 +61,11 @@
- <link rel="stylesheet" href="../../../../assets/_mkdocstrings.css">
+ <link rel="stylesheet" href="../../../../../assets/_mkdocstrings.css">
- <link rel="stylesheet" href="../../../../stylesheets/extra.css">
+ <link rel="stylesheet" href="../../../../../stylesheets/extra.css">
- <script>__md_scope=new URL("../../../..",location),__md_hash=e=>[...e].reduce((e,_)=>(e<<5)-e+_.charCodeAt(0),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
+ <script>__md_scope=new URL("../../../../..",location),__md_hash=e=>[...e].reduce((e,_)=>(e<<5)-e+_.charCodeAt(0),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
@@ -136,7 +136,7 @@
<div data-md-component="skip">
- <a href="#streampipes.functions.broker.output_collector" class="md-skip">
+ <a href="#streampipes.functions.broker.nats.nats_consumer" class="md-skip">
Skip to content
</a>
@@ -174,7 +174,7 @@
<div class="md-header__topic" data-md-component="header-topic">
<span class="md-ellipsis">
- Output collector
+ Nats consumer
</span>
</div>
@@ -263,7 +263,7 @@
<li class="md-tabs__item">
- <a href="../../../.." class="md-tabs__link">
+ <a href="../../../../.." class="md-tabs__link">
🏡 Home
</a>
</li>
@@ -278,7 +278,7 @@
<li class="md-tabs__item">
- <a href="../../../../getting-started/first-steps/" class="md-tabs__link">
+ <a href="../../../../../getting-started/first-steps/" class="md-tabs__link">
🚀 Getting Started
</a>
</li>
@@ -294,7 +294,7 @@
<li class="md-tabs__item">
- <a href="../../../../tutorials/1-introduction-to-streampipes-python-client/" class="md-tabs__link">
+ <a href="../../../../../tutorials/1-introduction-to-streampipes-python-client/" class="md-tabs__link">
🤓 Tutorials
</a>
</li>
@@ -317,7 +317,7 @@
<li class="md-tabs__item">
- <a href="../../../client/client/" class="md-tabs__link md-tabs__link--active">
+ <a href="../../../../client/client/" class="md-tabs__link md-tabs__link--active">
📚 Reference
</a>
</li>
@@ -383,7 +383,7 @@
<li class="md-nav__item">
- <a href="../../../.." class="md-nav__link">
+ <a href="../../../../.." class="md-nav__link">
🏡 Home
</a>
</li>
@@ -433,7 +433,7 @@
<li class="md-nav__item">
- <a href="../../../../getting-started/first-steps/" class="md-nav__link">
+ <a href="../../../../../getting-started/first-steps/" class="md-nav__link">
First Steps
</a>
</li>
@@ -447,7 +447,7 @@
<li class="md-nav__item">
- <a href="../../../../getting-started/developing/" class="md-nav__link">
+ <a href="../../../../../getting-started/developing/" class="md-nav__link">
Developing & Contributing
</a>
</li>
@@ -461,7 +461,7 @@
<li class="md-nav__item">
- <a href="../../../../getting-started/quickstart/" class="md-nav__link">
+ <a href="../../../../../getting-started/quickstart/" class="md-nav__link">
Quickstart
</a>
... 11273 lines suppressed ...