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 2024/05/21 05:59:45 UTC
(streampipes-website) branch dev updated: chore(python-docs): update python doc assets to recent development state (#173)
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 b54a83864 chore(python-docs): update python doc assets to recent development state (#173)
b54a83864 is described below
commit b54a83864fb7d51202beabd1355a0e7cfca6cf63
Author: github-actions[bot] <41...@users.noreply.github.com>
AuthorDate: Tue May 21 07:59:39 2024 +0200
chore(python-docs): update python doc assets to recent development state (#173)
Co-authored-by: bossenti <bo...@users.noreply.github.com>
---
docs-python/dev/objects.inv | Bin 3039 -> 3074 bytes
.../client/credential_provider/index.html | 96 +++
.../endpoint/api/data_lake_measure/index.html | 211 ++++++
.../reference/endpoint/api/data_stream/index.html | 312 +++++++++
.../dev/reference/endpoint/api/version/index.html | 87 +++
.../function_zoo/river_function/index.html | 256 ++++++++
.../reference/functions/broker/consumer/index.html | 63 ++
.../broker/kafka/kafka_consumer/index.html | 89 +++
.../broker/kafka/kafka_publisher/index.html | 89 +++
.../functions/broker/nats/nats_consumer/index.html | 89 +++
.../broker/nats/nats_publisher/index.html | 89 +++
.../functions/broker/publisher/index.html | 152 +++++
docs-python/dev/reference/model/common/index.html | 727 ++++++++++++++++++++-
.../model/container/data_lake_measures/index.html | 358 ++++++++++
.../model/container/data_streams/index.html | 358 ++++++++++
.../reference/model/container/versions/index.html | 358 ++++++++++
.../model/resource/data_lake_measure/index.html | 143 ++++
.../model/resource/data_series/index.html | 143 ++++
.../model/resource/data_stream/index.html | 53 ++
.../model/resource/function_definition/index.html | 261 +++++++-
.../model/resource/query_result/index.html | 143 ++++
.../reference/model/resource/resource/index.html | 53 ++
.../reference/model/resource/version/index.html | 143 ++++
docs-python/dev/search/search_index.json | 2 +-
docs-python/dev/sitemap.xml | 101 ++-
docs-python/dev/sitemap.xml.gz | Bin 728 -> 712 bytes
26 files changed, 4291 insertions(+), 85 deletions(-)
diff --git a/docs-python/dev/objects.inv b/docs-python/dev/objects.inv
index fbaa9aa28..bd8fc87ed 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/credential_provider/index.html b/docs-python/dev/reference/client/credential_provider/index.html
index d165717b8..b92e050b2 100644
--- a/docs-python/dev/reference/client/credential_provider/index.html
+++ b/docs-python/dev/reference/client/credential_provider/index.html
@@ -912,6 +912,13 @@
from_env
</a>
+</li>
+
+ <li class="md-nav__item">
+ <a href="#streampipes.client.credential_provider.StreamPipesApiKeyCredentials.make_headers" class="md-nav__link">
+ make_headers
+ </a>
+
</li>
</ul>
@@ -2297,6 +2304,13 @@
from_env
</a>
+</li>
+
+ <li class="md-nav__item">
+ <a href="#streampipes.client.credential_provider.StreamPipesApiKeyCredentials.make_headers" class="md-nav__link">
+ make_headers
+ </a>
+
</li>
</ul>
@@ -2678,6 +2692,88 @@ If not passed, the api key is retrieved from environment variable <code>SP_API_K
</div>
+<div class="doc doc-object doc-function">
+
+
+
+<h3 id="streampipes.client.credential_provider.StreamPipesApiKeyCredentials.make_headers" class="doc doc-heading">
+ <code class="highlight language-python"><span class="n">make_headers</span><span class="p">(</span><span class="n">http_headers</span><span class="o">=</span><span class="kc">None</span><span class="p">)</span></code>
+
+<a href="#streampipes.client.credential_provider.StreamPipesApiKeyCredentials.make_headers" class="headerlink" title="Permanent link">¶</a></h3>
+
+
+ <div class="doc doc-contents ">
+
+ <p>Creates the HTTP headers for the specific credential provider.</p>
+<p>Concrete authentication headers must be defined in the implementation of a credential provider.</p>
+
+
+
+ <table>
+ <thead>
+ <tr>
+ <th><b>PARAMETER</b></th>
+ <th><b> DESCRIPTION</b></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><code>http_headers</code></td>
+ <td class="doc-param-details">
+ <div class="doc-md-description">
+ <p>Additional HTTP headers the generated headers are extended by.</p>
+ </div>
+ <p>
+ <span class="doc-param-annotation">
+ <b>TYPE:</b>
+ <code><span title="typing.Optional">Optional</span>[<span title="typing.Dict">Dict</span>[str, str]]</code>
+ </span>
+ <span class="doc-param-default">
+ <b>DEFAULT:</b>
+ <code>None</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>https_headers</code>
+ </td>
+ <td class="doc-returns-details">
+ <div class="doc-md-description">
+ <p>Dictionary with header information as string key-value pairs. <br>
+Contains all pairs given as parameter plus the header pairs for authentication
+determined by the credential provider.</p>
+ </div>
+ <p>
+ <span class="doc-returns-annotation">
+ <b>TYPE:</b>
+ <code><span title="typing.Dict">Dict</span>[str, str]</code>
+ </span>
+ </p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+
+ </div>
+
+</div>
+
+
</div>
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 9c6a343b8..57c118778 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
@@ -1041,11 +1041,32 @@
<nav class="md-nav" aria-label="DataLakeMeasureEndpoint">
<ul class="md-nav__list">
+ <li class="md-nav__item">
+ <a href="#streampipes.endpoint.api.data_lake_measure.DataLakeMeasureEndpoint.all" class="md-nav__link">
+ all
+ </a>
+
+</li>
+
+ <li class="md-nav__item">
+ <a href="#streampipes.endpoint.api.data_lake_measure.DataLakeMeasureEndpoint.build_url" class="md-nav__link">
+ build_url
+ </a>
+
+</li>
+
<li class="md-nav__item">
<a href="#streampipes.endpoint.api.data_lake_measure.DataLakeMeasureEndpoint.get" class="md-nav__link">
get
</a>
+</li>
+
+ <li class="md-nav__item">
+ <a href="#streampipes.endpoint.api.data_lake_measure.DataLakeMeasureEndpoint.post" class="md-nav__link">
+ post
+ </a>
+
</li>
</ul>
@@ -2288,11 +2309,32 @@
<nav class="md-nav" aria-label="DataLakeMeasureEndpoint">
<ul class="md-nav__list">
+ <li class="md-nav__item">
+ <a href="#streampipes.endpoint.api.data_lake_measure.DataLakeMeasureEndpoint.all" class="md-nav__link">
+ all
+ </a>
+
+</li>
+
+ <li class="md-nav__item">
+ <a href="#streampipes.endpoint.api.data_lake_measure.DataLakeMeasureEndpoint.build_url" class="md-nav__link">
+ build_url
+ </a>
+
+</li>
+
<li class="md-nav__item">
<a href="#streampipes.endpoint.api.data_lake_measure.DataLakeMeasureEndpoint.get" class="md-nav__link">
get
</a>
+</li>
+
+ <li class="md-nav__item">
+ <a href="#streampipes.endpoint.api.data_lake_measure.DataLakeMeasureEndpoint.post" class="md-nav__link">
+ post
+ </a>
+
</li>
</ul>
@@ -2471,6 +2513,104 @@ find them at <a class="autorefs autorefs-internal" href="#streampipes.endpoint.a
+<div class="doc doc-object doc-function">
+
+
+
+<h3 id="streampipes.endpoint.api.data_lake_measure.DataLakeMeasureEndpoint.all" class="doc doc-heading">
+ <code class="highlight language-python"><span class="nb">all</span><span class="p">()</span></code>
+
+<a href="#streampipes.endpoint.api.data_lake_measure.DataLakeMeasureEndpoint.all" class="headerlink" title="Permanent link">¶</a></h3>
+
+
+ <div class="doc doc-contents ">
+
+ <p>Get all resources of this endpoint provided by the StreamPipes API.</p>
+<p>Results are provided as an instance of a <code>ResourceContainer</code> that
+allows to handle the returned resources in a comfortable and pythonic way.</p>
+
+
+
+ <table>
+ <thead>
+ <tr>
+ <th><b>RETURNS</b></th>
+ <th><b>DESCRIPTION</b></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ <code>container</code>
+ </td>
+ <td class="doc-returns-details">
+ <div class="doc-md-description">
+ <p>container element that bundles the returned resources</p>
+ </div>
+ <p>
+ <span class="doc-returns-annotation">
+ <b>TYPE:</b>
+ <code><a class="autorefs autorefs-internal" title="streampipes.model.container.resource_container.ResourceContainer" href="../../../model/container/resource_container/#streampipes.model.container.resource_container.ResourceContainer">ResourceContainer</a></code>
+ </span>
+ </p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+
+ </div>
+
+</div>
+
+
+<div class="doc doc-object doc-function">
+
+
+
+<h3 id="streampipes.endpoint.api.data_lake_measure.DataLakeMeasureEndpoint.build_url" class="doc doc-heading">
+ <code class="highlight language-python"><span class="n">build_url</span><span class="p">()</span></code>
+
+<a href="#streampipes.endpoint.api.data_lake_measure.DataLakeMeasureEndpoint.build_url" class="headerlink" title="Permanent link">¶</a></h3>
+
+
+ <div class="doc doc-contents ">
+
+ <p>Builds the endpoint's URL of the API path.</p>
+
+
+
+ <table>
+ <thead>
+ <tr>
+ <th><b>RETURNS</b></th>
+ <th><b>DESCRIPTION</b></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ <code>url</code>
+ </td>
+ <td class="doc-returns-details">
+ <div class="doc-md-description">
+ <p>The URL of the endpoint</p>
+ </div>
+ <p>
+ <span class="doc-returns-annotation">
+ <b>TYPE:</b>
+ <code>str</code>
+ </span>
+ </p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+
+ </div>
+
+</div>
+
+
<div class="doc doc-object doc-function">
@@ -2574,6 +2714,77 @@ The available query parameters are defined by the
</div>
+<div class="doc doc-object doc-function">
+
+
+
+<h3 id="streampipes.endpoint.api.data_lake_measure.DataLakeMeasureEndpoint.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.endpoint.api.data_lake_measure.DataLakeMeasureEndpoint.post" class="headerlink" title="Permanent link">¶</a></h3>
+
+
+ <div class="doc doc-contents ">
+
+ <p>Allows to post a resource to the StreamPipes API.</p>
+
+
+
+ <table>
+ <thead>
+ <tr>
+ <th><b>PARAMETER</b></th>
+ <th><b> DESCRIPTION</b></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><code>resource</code></td>
+ <td class="doc-param-details">
+ <div class="doc-md-description">
+ <p>The resource to be posted.</p>
+ </div>
+ <p>
+ <span class="doc-param-annotation">
+ <b>TYPE:</b>
+ <code><a class="autorefs autorefs-internal" title="streampipes.model.resource.resource.Resource" href="../../../model/resource/resource/#streampipes.model.resource.resource.Resource">Resource</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">
+ <div class="doc-md-description">
+
+ </div>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+
+ </div>
+
+</div>
+
+
</div>
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 cb3074615..75fe78791 100644
--- a/docs-python/dev/reference/endpoint/api/data_stream/index.html
+++ b/docs-python/dev/reference/endpoint/api/data_stream/index.html
@@ -1058,6 +1058,40 @@
DataStreamEndpoint
</a>
+ <nav class="md-nav" aria-label="DataStreamEndpoint">
+ <ul class="md-nav__list">
+
+ <li class="md-nav__item">
+ <a href="#streampipes.endpoint.api.data_stream.DataStreamEndpoint.all" class="md-nav__link">
+ all
+ </a>
+
+</li>
+
+ <li class="md-nav__item">
+ <a href="#streampipes.endpoint.api.data_stream.DataStreamEndpoint.build_url" class="md-nav__link">
+ build_url
+ </a>
+
+</li>
+
+ <li class="md-nav__item">
+ <a href="#streampipes.endpoint.api.data_stream.DataStreamEndpoint.get" class="md-nav__link">
+ get
+ </a>
+
+</li>
+
+ <li class="md-nav__item">
+ <a href="#streampipes.endpoint.api.data_stream.DataStreamEndpoint.post" class="md-nav__link">
+ post
+ </a>
+
+</li>
+
+ </ul>
+ </nav>
+
</li>
</ul>
@@ -2238,6 +2272,40 @@
DataStreamEndpoint
</a>
+ <nav class="md-nav" aria-label="DataStreamEndpoint">
+ <ul class="md-nav__list">
+
+ <li class="md-nav__item">
+ <a href="#streampipes.endpoint.api.data_stream.DataStreamEndpoint.all" class="md-nav__link">
+ all
+ </a>
+
+</li>
+
+ <li class="md-nav__item">
+ <a href="#streampipes.endpoint.api.data_stream.DataStreamEndpoint.build_url" class="md-nav__link">
+ build_url
+ </a>
+
+</li>
+
+ <li class="md-nav__item">
+ <a href="#streampipes.endpoint.api.data_stream.DataStreamEndpoint.get" class="md-nav__link">
+ get
+ </a>
+
+</li>
+
+ <li class="md-nav__item">
+ <a href="#streampipes.endpoint.api.data_stream.DataStreamEndpoint.post" class="md-nav__link">
+ post
+ </a>
+
+</li>
+
+ </ul>
+ </nav>
+
</li>
</ul>
@@ -2335,6 +2403,250 @@ The metadata is returned as an instance of <a class="autorefs autorefs-internal"
+<div class="doc doc-object doc-function">
+
+
+
+<h3 id="streampipes.endpoint.api.data_stream.DataStreamEndpoint.all" class="doc doc-heading">
+ <code class="highlight language-python"><span class="nb">all</span><span class="p">()</span></code>
+
+<a href="#streampipes.endpoint.api.data_stream.DataStreamEndpoint.all" class="headerlink" title="Permanent link">¶</a></h3>
+
+
+ <div class="doc doc-contents ">
+
+ <p>Get all resources of this endpoint provided by the StreamPipes API.</p>
+<p>Results are provided as an instance of a <code>ResourceContainer</code> that
+allows to handle the returned resources in a comfortable and pythonic way.</p>
+
+
+
+ <table>
+ <thead>
+ <tr>
+ <th><b>RETURNS</b></th>
+ <th><b>DESCRIPTION</b></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ <code>container</code>
+ </td>
+ <td class="doc-returns-details">
+ <div class="doc-md-description">
+ <p>container element that bundles the returned resources</p>
+ </div>
+ <p>
+ <span class="doc-returns-annotation">
+ <b>TYPE:</b>
+ <code><a class="autorefs autorefs-internal" title="streampipes.model.container.resource_container.ResourceContainer" href="../../../model/container/resource_container/#streampipes.model.container.resource_container.ResourceContainer">ResourceContainer</a></code>
+ </span>
+ </p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+
+ </div>
+
+</div>
+
+
+<div class="doc doc-object doc-function">
+
+
+
+<h3 id="streampipes.endpoint.api.data_stream.DataStreamEndpoint.build_url" class="doc doc-heading">
+ <code class="highlight language-python"><span class="n">build_url</span><span class="p">()</span></code>
+
+<a href="#streampipes.endpoint.api.data_stream.DataStreamEndpoint.build_url" class="headerlink" title="Permanent link">¶</a></h3>
+
+
+ <div class="doc doc-contents ">
+
+ <p>Builds the endpoint's URL of the API path.</p>
+
+
+
+ <table>
+ <thead>
+ <tr>
+ <th><b>RETURNS</b></th>
+ <th><b>DESCRIPTION</b></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ <code>url</code>
+ </td>
+ <td class="doc-returns-details">
+ <div class="doc-md-description">
+ <p>The URL of the endpoint</p>
+ </div>
+ <p>
+ <span class="doc-returns-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.endpoint.api.data_stream.DataStreamEndpoint.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.endpoint.api.data_stream.DataStreamEndpoint.get" class="headerlink" title="Permanent link">¶</a></h3>
+
+
+ <div class="doc doc-contents ">
+
+ <p>Queries the specified resource from the API endpoint.</p>
+
+
+
+ <table>
+ <thead>
+ <tr>
+ <th><b>PARAMETER</b></th>
+ <th><b> DESCRIPTION</b></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><code>identifier</code></td>
+ <td class="doc-param-details">
+ <div class="doc-md-description">
+ <p>The identifier of the resource to be queried.</p>
+ </div>
+ <p>
+ <span class="doc-param-annotation">
+ <b>TYPE:</b>
+ <code>str</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>resource</code>
+ </td>
+ <td class="doc-returns-details">
+ <div class="doc-md-description">
+ <p>The specified resource as an instance of the corresponding model class.</p>
+ </div>
+ <p>
+ <span class="doc-returns-annotation">
+ <b>TYPE:</b>
+ <code><a class="autorefs autorefs-internal" title="streampipes.model.resource.resource.Resource" href="../../../model/resource/resource/#streampipes.model.resource.resource.Resource">Resource</a></code>
+ </span>
+ </p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+
+ </div>
+
+</div>
+
+
+<div class="doc doc-object doc-function">
+
+
+
+<h3 id="streampipes.endpoint.api.data_stream.DataStreamEndpoint.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.endpoint.api.data_stream.DataStreamEndpoint.post" class="headerlink" title="Permanent link">¶</a></h3>
+
+
+ <div class="doc doc-contents ">
+
+ <p>Allows to post a resource to the StreamPipes API.</p>
+
+
+
+ <table>
+ <thead>
+ <tr>
+ <th><b>PARAMETER</b></th>
+ <th><b> DESCRIPTION</b></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><code>resource</code></td>
+ <td class="doc-param-details">
+ <div class="doc-md-description">
+ <p>The resource to be posted.</p>
+ </div>
+ <p>
+ <span class="doc-param-annotation">
+ <b>TYPE:</b>
+ <code><a class="autorefs autorefs-internal" title="streampipes.model.resource.resource.Resource" href="../../../model/resource/resource/#streampipes.model.resource.resource.Resource">Resource</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">
+ <div class="doc-md-description">
+
+ </div>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+
+ </div>
+
+</div>
+
+
</div>
diff --git a/docs-python/dev/reference/endpoint/api/version/index.html b/docs-python/dev/reference/endpoint/api/version/index.html
index 0a04df041..cc3feb234 100644
--- a/docs-python/dev/reference/endpoint/api/version/index.html
+++ b/docs-python/dev/reference/endpoint/api/version/index.html
@@ -1086,6 +1086,13 @@
all
</a>
+</li>
+
+ <li class="md-nav__item">
+ <a href="#streampipes.endpoint.api.version.VersionEndpoint.build_url" class="md-nav__link">
+ build_url
+ </a>
+
</li>
<li class="md-nav__item">
@@ -2273,6 +2280,13 @@
all
</a>
+</li>
+
+ <li class="md-nav__item">
+ <a href="#streampipes.endpoint.api.version.VersionEndpoint.build_url" class="md-nav__link">
+ build_url
+ </a>
+
</li>
<li class="md-nav__item">
@@ -2463,6 +2477,54 @@ However, this endpoint does not support this kind of operation.</p>
+<h3 id="streampipes.endpoint.api.version.VersionEndpoint.build_url" class="doc doc-heading">
+ <code class="highlight language-python"><span class="n">build_url</span><span class="p">()</span></code>
+
+<a href="#streampipes.endpoint.api.version.VersionEndpoint.build_url" class="headerlink" title="Permanent link">¶</a></h3>
+
+
+ <div class="doc doc-contents ">
+
+ <p>Builds the endpoint's URL of the API path.</p>
+
+
+
+ <table>
+ <thead>
+ <tr>
+ <th><b>RETURNS</b></th>
+ <th><b>DESCRIPTION</b></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ <code>url</code>
+ </td>
+ <td class="doc-returns-details">
+ <div class="doc-md-description">
+ <p>The URL of the endpoint</p>
+ </div>
+ <p>
+ <span class="doc-returns-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.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>
@@ -2503,6 +2565,31 @@ However, this endpoint does not support this kind of operation.</p>
+ <table>
+ <thead>
+ <tr>
+ <th><b>RAISES</b></th>
+ <th><b>DESCRIPTION</b></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ <span class="doc-raises-annotation">
+ <code>ValueError</code>
+ </span>
+ </td>
+ <td class="doc-raises-details">
+ <div class="doc-md-description">
+ <p>Non-empty <code>identifier</code> is not supported by this endpoint. Please set <code>identifier</code> to an empty string or <code>None</code>.</p>
+ </div>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+
+
+
<table>
<thead>
<tr>
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 b5c30fad3..1612e480d 100644
--- a/docs-python/dev/reference/function_zoo/river_function/index.html
+++ b/docs-python/dev/reference/function_zoo/river_function/index.html
@@ -1187,6 +1187,20 @@
<nav class="md-nav" aria-label="RiverFunction">
<ul class="md-nav__list">
+ <li class="md-nav__item">
+ <a href="#streampipes.function_zoo.river_function.RiverFunction.add_output" class="md-nav__link">
+ add_output
+ </a>
+
+</li>
+
+ <li class="md-nav__item">
+ <a href="#streampipes.function_zoo.river_function.RiverFunction.getFunctionId" class="md-nav__link">
+ getFunctionId
+ </a>
+
+</li>
+
<li class="md-nav__item">
<a href="#streampipes.function_zoo.river_function.RiverFunction.onEvent" class="md-nav__link">
onEvent
@@ -1206,6 +1220,20 @@
onServiceStopped
</a>
+</li>
+
+ <li class="md-nav__item">
+ <a href="#streampipes.function_zoo.river_function.RiverFunction.requiredStreamIds" class="md-nav__link">
+ requiredStreamIds
+ </a>
+
+</li>
+
+ <li class="md-nav__item">
+ <a href="#streampipes.function_zoo.river_function.RiverFunction.stop" class="md-nav__link">
+ stop
+ </a>
+
</li>
</ul>
@@ -2334,6 +2362,20 @@
<nav class="md-nav" aria-label="RiverFunction">
<ul class="md-nav__list">
+ <li class="md-nav__item">
+ <a href="#streampipes.function_zoo.river_function.RiverFunction.add_output" class="md-nav__link">
+ add_output
+ </a>
+
+</li>
+
+ <li class="md-nav__item">
+ <a href="#streampipes.function_zoo.river_function.RiverFunction.getFunctionId" class="md-nav__link">
+ getFunctionId
+ </a>
+
+</li>
+
<li class="md-nav__item">
<a href="#streampipes.function_zoo.river_function.RiverFunction.onEvent" class="md-nav__link">
onEvent
@@ -2353,6 +2395,20 @@
onServiceStopped
</a>
+</li>
+
+ <li class="md-nav__item">
+ <a href="#streampipes.function_zoo.river_function.RiverFunction.requiredStreamIds" class="md-nav__link">
+ requiredStreamIds
+ </a>
+
+</li>
+
+ <li class="md-nav__item">
+ <a href="#streampipes.function_zoo.river_function.RiverFunction.stop" class="md-nav__link">
+ stop
+ </a>
+
</li>
</ul>
@@ -2831,6 +2887,139 @@ but can be every model with a 'learn_one' and 'predict_one' method.</p>
+<div class="doc doc-object doc-function">
+
+
+
+<h3 id="streampipes.function_zoo.river_function.RiverFunction.add_output" class="doc doc-heading">
+ <code class="highlight language-python"><span class="n">add_output</span><span class="p">(</span><span class="n">stream_id</span><span class="p">,</span> <span class="n">event</span><span class="p">)</span></code>
+
+<a href="#streampipes.function_zoo.river_function.RiverFunction.add_output" class="headerlink" title="Permanent link">¶</a></h3>
+
+
+ <div class="doc doc-contents ">
+
+ <p>Send an event via an output data stream to StreamPipes</p>
+
+
+
+ <table>
+ <thead>
+ <tr>
+ <th><b>PARAMETER</b></th>
+ <th><b> DESCRIPTION</b></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><code>stream_id</code></td>
+ <td class="doc-param-details">
+ <div class="doc-md-description">
+ <p>The id of the output data stream</p>
+ </div>
+ <p>
+ <span class="doc-param-annotation">
+ <b>TYPE:</b>
+ <code>str</code>
+ </span>
+ </p>
+ </td>
+ </tr>
+ <tr>
+ <td><code>event</code></td>
+ <td class="doc-param-details">
+ <div class="doc-md-description">
+ <p>The event which should be sent</p>
+ </div>
+ <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">
+ <div class="doc-md-description">
+
+ </div>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+
+ </div>
+
+</div>
+
+
+<div class="doc doc-object doc-function">
+
+
+
+<h3 id="streampipes.function_zoo.river_function.RiverFunction.getFunctionId" class="doc doc-heading">
+ <code class="highlight language-python"><span class="n">getFunctionId</span><span class="p">()</span></code>
+
+<a href="#streampipes.function_zoo.river_function.RiverFunction.getFunctionId" class="headerlink" title="Permanent link">¶</a></h3>
+
+
+ <div class="doc doc-contents ">
+
+ <p>Returns the id of the function.</p>
+
+
+
+ <table>
+ <thead>
+ <tr>
+ <th><b>RETURNS</b></th>
+ <th><b>DESCRIPTION</b></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ <code>function_id</code>
+ </td>
+ <td class="doc-returns-details">
+ <div class="doc-md-description">
+ <p>Identification object of the StreamPipes function</p>
+ </div>
+ <p>
+ <span class="doc-returns-annotation">
+ <b>TYPE:</b>
+ <code><a class="autorefs autorefs-internal" title="streampipes.model.resource.function_definition.FunctionId" href="../../model/resource/function_definition/#streampipes.model.resource.function_definition.FunctionId">FunctionId</a></code>
+ </span>
+ </p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+
+ </div>
+
+</div>
+
+
<div class="doc doc-object doc-function">
@@ -3006,6 +3195,73 @@ but can be every model with a 'learn_one' and 'predict_one' method.</p>
</div>
+<div class="doc doc-object doc-function">
+
+
+
+<h3 id="streampipes.function_zoo.river_function.RiverFunction.requiredStreamIds" class="doc doc-heading">
+ <code class="highlight language-python"><span class="n">requiredStreamIds</span><span class="p">()</span></code>
+
+<a href="#streampipes.function_zoo.river_function.RiverFunction.requiredStreamIds" class="headerlink" title="Permanent link">¶</a></h3>
+
+
+ <div class="doc doc-contents ">
+
+ <p>Get the ids of the streams needed by the function.</p>
+
+
+
+ <table>
+ <thead>
+ <tr>
+ <th><b>RETURNS</b></th>
+ <th><b>DESCRIPTION</b></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ <code>stream_ids</code>
+ </td>
+ <td class="doc-returns-details">
+ <div class="doc-md-description">
+ <p>List of the stream ids</p>
+ </div>
+ <p>
+ <span class="doc-returns-annotation">
+ <b>TYPE:</b>
+ <code><span title="typing.List">List</span>[str]</code>
+ </span>
+ </p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+
+ </div>
+
+</div>
+
+
+<div class="doc doc-object doc-function">
+
+
+
+<h3 id="streampipes.function_zoo.river_function.RiverFunction.stop" class="doc doc-heading">
+ <code class="highlight language-python"><span class="n">stop</span><span class="p">()</span></code>
+
+<a href="#streampipes.function_zoo.river_function.RiverFunction.stop" class="headerlink" title="Permanent link">¶</a></h3>
+
+
+ <div class="doc doc-contents ">
+
+ <p>Stops the function and disconnects from the output streams</p>
+
+ </div>
+
+</div>
+
+
</div>
diff --git a/docs-python/dev/reference/functions/broker/consumer/index.html b/docs-python/dev/reference/functions/broker/consumer/index.html
index c14696609..bd731ed32 100644
--- a/docs-python/dev/reference/functions/broker/consumer/index.html
+++ b/docs-python/dev/reference/functions/broker/consumer/index.html
@@ -1384,6 +1384,13 @@
connect
</a>
+</li>
+
+ <li class="md-nav__item">
+ <a href="#streampipes.functions.broker.consumer.Consumer.disconnect" class="md-nav__link">
+ disconnect
+ </a>
+
</li>
<li class="md-nav__item">
@@ -2266,6 +2273,13 @@
connect
</a>
+</li>
+
+ <li class="md-nav__item">
+ <a href="#streampipes.functions.broker.consumer.Consumer.disconnect" class="md-nav__link">
+ disconnect
+ </a>
+
</li>
<li class="md-nav__item">
@@ -2430,6 +2444,55 @@
+<h3 id="streampipes.functions.broker.consumer.Consumer.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-abstractmethod"><code>abstractmethod</code></small>
+ <small class="doc doc-label doc-label-async"><code>async</code></small>
+ </span>
+
+<a href="#streampipes.functions.broker.consumer.Consumer.disconnect" class="headerlink" title="Permanent link">¶</a></h3>
+
+
+ <div class="doc doc-contents ">
+
+ <p>Closes the connection to the server.</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">
+ <div class="doc-md-description">
+
+ </div>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+
+ </div>
+
+</div>
+
+
+<div class="doc doc-object doc-function">
+
+
+
<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>
diff --git a/docs-python/dev/reference/functions/broker/kafka/kafka_consumer/index.html b/docs-python/dev/reference/functions/broker/kafka/kafka_consumer/index.html
index a40765a39..bfe82991f 100644
--- a/docs-python/dev/reference/functions/broker/kafka/kafka_consumer/index.html
+++ b/docs-python/dev/reference/functions/broker/kafka/kafka_consumer/index.html
@@ -1483,6 +1483,13 @@
<nav class="md-nav" aria-label="KafkaConsumer">
<ul class="md-nav__list">
+ <li class="md-nav__item">
+ <a href="#streampipes.functions.broker.kafka.kafka_consumer.KafkaConsumer.connect" class="md-nav__link">
+ connect
+ </a>
+
+</li>
+
<li class="md-nav__item">
<a href="#streampipes.functions.broker.kafka.kafka_consumer.KafkaConsumer.disconnect" class="md-nav__link">
disconnect
@@ -2263,6 +2270,13 @@
<nav class="md-nav" aria-label="KafkaConsumer">
<ul class="md-nav__list">
+ <li class="md-nav__item">
+ <a href="#streampipes.functions.broker.kafka.kafka_consumer.KafkaConsumer.connect" class="md-nav__link">
+ connect
+ </a>
+
+</li>
+
<li class="md-nav__item">
<a href="#streampipes.functions.broker.kafka.kafka_consumer.KafkaConsumer.disconnect" class="md-nav__link">
disconnect
@@ -2352,6 +2366,81 @@
+<div class="doc doc-object doc-function">
+
+
+
+<h3 id="streampipes.functions.broker.kafka.kafka_consumer.KafkaConsumer.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.kafka.kafka_consumer.KafkaConsumer.connect" class="headerlink" title="Permanent link">¶</a></h3>
+
+
+ <div class="doc doc-contents ">
+
+ <p>Connects to the broker running in StreamPipes and creates a subscription.</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">
+ <div class="doc-md-description">
+ <p>Contains the meta information (resources) for a data stream.</p>
+ </div>
+ <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">
+ <div class="doc-md-description">
+
+ </div>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+
+ </div>
+
+</div>
+
+
<div class="doc doc-object doc-function">
diff --git a/docs-python/dev/reference/functions/broker/kafka/kafka_publisher/index.html b/docs-python/dev/reference/functions/broker/kafka/kafka_publisher/index.html
index bf08d1f15..fd66191f4 100644
--- a/docs-python/dev/reference/functions/broker/kafka/kafka_publisher/index.html
+++ b/docs-python/dev/reference/functions/broker/kafka/kafka_publisher/index.html
@@ -1523,6 +1523,13 @@
<nav class="md-nav" aria-label="KafkaPublisher">
<ul class="md-nav__list">
+ <li class="md-nav__item">
+ <a href="#streampipes.functions.broker.kafka.kafka_publisher.KafkaPublisher.connect" class="md-nav__link">
+ connect
+ </a>
+
+</li>
+
<li class="md-nav__item">
<a href="#streampipes.functions.broker.kafka.kafka_publisher.KafkaPublisher.disconnect" class="md-nav__link">
disconnect
@@ -2263,6 +2270,13 @@
<nav class="md-nav" aria-label="KafkaPublisher">
<ul class="md-nav__list">
+ <li class="md-nav__item">
+ <a href="#streampipes.functions.broker.kafka.kafka_publisher.KafkaPublisher.connect" class="md-nav__link">
+ connect
+ </a>
+
+</li>
+
<li class="md-nav__item">
<a href="#streampipes.functions.broker.kafka.kafka_publisher.KafkaPublisher.disconnect" class="md-nav__link">
disconnect
@@ -2352,6 +2366,81 @@
+<div class="doc doc-object doc-function">
+
+
+
+<h3 id="streampipes.functions.broker.kafka.kafka_publisher.KafkaPublisher.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.kafka.kafka_publisher.KafkaPublisher.connect" class="headerlink" title="Permanent link">¶</a></h3>
+
+
+ <div class="doc doc-contents ">
+
+ <p>Connects to the broker running in StreamPipes.</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">
+ <div class="doc-md-description">
+ <p>Contains the meta information (resources) for a data stream.</p>
+ </div>
+ <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">
+ <div class="doc-md-description">
+
+ </div>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+
+ </div>
+
+</div>
+
+
<div class="doc doc-object doc-function">
diff --git a/docs-python/dev/reference/functions/broker/nats/nats_consumer/index.html b/docs-python/dev/reference/functions/broker/nats/nats_consumer/index.html
index 847449530..43c9a10fc 100644
--- a/docs-python/dev/reference/functions/broker/nats/nats_consumer/index.html
+++ b/docs-python/dev/reference/functions/broker/nats/nats_consumer/index.html
@@ -1591,6 +1591,13 @@
<nav class="md-nav" aria-label="NatsConsumer">
<ul class="md-nav__list">
+ <li class="md-nav__item">
+ <a href="#streampipes.functions.broker.nats.nats_consumer.NatsConsumer.connect" class="md-nav__link">
+ connect
+ </a>
+
+</li>
+
<li class="md-nav__item">
<a href="#streampipes.functions.broker.nats.nats_consumer.NatsConsumer.disconnect" class="md-nav__link">
disconnect
@@ -2263,6 +2270,13 @@
<nav class="md-nav" aria-label="NatsConsumer">
<ul class="md-nav__list">
+ <li class="md-nav__item">
+ <a href="#streampipes.functions.broker.nats.nats_consumer.NatsConsumer.connect" class="md-nav__link">
+ connect
+ </a>
+
+</li>
+
<li class="md-nav__item">
<a href="#streampipes.functions.broker.nats.nats_consumer.NatsConsumer.disconnect" class="md-nav__link">
disconnect
@@ -2352,6 +2366,81 @@
+<div class="doc doc-object doc-function">
+
+
+
+<h3 id="streampipes.functions.broker.nats.nats_consumer.NatsConsumer.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.nats.nats_consumer.NatsConsumer.connect" class="headerlink" title="Permanent link">¶</a></h3>
+
+
+ <div class="doc doc-contents ">
+
+ <p>Connects to the broker running in StreamPipes and creates a subscription.</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">
+ <div class="doc-md-description">
+ <p>Contains the meta information (resources) for a data stream.</p>
+ </div>
+ <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">
+ <div class="doc-md-description">
+
+ </div>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+
+ </div>
+
+</div>
+
+
<div class="doc doc-object doc-function">
diff --git a/docs-python/dev/reference/functions/broker/nats/nats_publisher/index.html b/docs-python/dev/reference/functions/broker/nats/nats_publisher/index.html
index f2fba686e..776955ced 100644
--- a/docs-python/dev/reference/functions/broker/nats/nats_publisher/index.html
+++ b/docs-python/dev/reference/functions/broker/nats/nats_publisher/index.html
@@ -1611,6 +1611,13 @@
<nav class="md-nav" aria-label="NatsPublisher">
<ul class="md-nav__list">
+ <li class="md-nav__item">
+ <a href="#streampipes.functions.broker.nats.nats_publisher.NatsPublisher.connect" class="md-nav__link">
+ connect
+ </a>
+
+</li>
+
<li class="md-nav__item">
<a href="#streampipes.functions.broker.nats.nats_publisher.NatsPublisher.disconnect" class="md-nav__link">
disconnect
@@ -2263,6 +2270,13 @@
<nav class="md-nav" aria-label="NatsPublisher">
<ul class="md-nav__list">
+ <li class="md-nav__item">
+ <a href="#streampipes.functions.broker.nats.nats_publisher.NatsPublisher.connect" class="md-nav__link">
+ connect
+ </a>
+
+</li>
+
<li class="md-nav__item">
<a href="#streampipes.functions.broker.nats.nats_publisher.NatsPublisher.disconnect" class="md-nav__link">
disconnect
@@ -2352,6 +2366,81 @@
+<div class="doc doc-object doc-function">
+
+
+
+<h3 id="streampipes.functions.broker.nats.nats_publisher.NatsPublisher.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.nats.nats_publisher.NatsPublisher.connect" class="headerlink" title="Permanent link">¶</a></h3>
+
+
+ <div class="doc doc-contents ">
+
+ <p>Connects to the broker running in StreamPipes.</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">
+ <div class="doc-md-description">
+ <p>Contains the meta information (resources) for a data stream.</p>
+ </div>
+ <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">
+ <div class="doc-md-description">
+
+ </div>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+
+ </div>
+
+</div>
+
+
<div class="doc doc-object doc-function">
diff --git a/docs-python/dev/reference/functions/broker/publisher/index.html b/docs-python/dev/reference/functions/broker/publisher/index.html
index c90e7aabe..131f65e6a 100644
--- a/docs-python/dev/reference/functions/broker/publisher/index.html
+++ b/docs-python/dev/reference/functions/broker/publisher/index.html
@@ -1419,6 +1419,20 @@
<nav class="md-nav" aria-label="Publisher">
<ul class="md-nav__list">
+ <li class="md-nav__item">
+ <a href="#streampipes.functions.broker.publisher.Publisher.connect" class="md-nav__link">
+ connect
+ </a>
+
+</li>
+
+ <li class="md-nav__item">
+ <a href="#streampipes.functions.broker.publisher.Publisher.disconnect" class="md-nav__link">
+ disconnect
+ </a>
+
+</li>
+
<li class="md-nav__item">
<a href="#streampipes.functions.broker.publisher.Publisher.publish_event" class="md-nav__link">
publish_event
@@ -2254,6 +2268,20 @@
<nav class="md-nav" aria-label="Publisher">
<ul class="md-nav__list">
+ <li class="md-nav__item">
+ <a href="#streampipes.functions.broker.publisher.Publisher.connect" class="md-nav__link">
+ connect
+ </a>
+
+</li>
+
+ <li class="md-nav__item">
+ <a href="#streampipes.functions.broker.publisher.Publisher.disconnect" class="md-nav__link">
+ disconnect
+ </a>
+
+</li>
+
<li class="md-nav__item">
<a href="#streampipes.functions.broker.publisher.Publisher.publish_event" class="md-nav__link">
publish_event
@@ -2337,6 +2365,130 @@
+<div class="doc doc-object doc-function">
+
+
+
+<h3 id="streampipes.functions.broker.publisher.Publisher.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.publisher.Publisher.connect" class="headerlink" title="Permanent link">¶</a></h3>
+
+
+ <div class="doc doc-contents ">
+
+ <p>Connects to the broker running in StreamPipes.</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">
+ <div class="doc-md-description">
+ <p>Contains the meta information (resources) for a data stream.</p>
+ </div>
+ <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">
+ <div class="doc-md-description">
+
+ </div>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+
+ </div>
+
+</div>
+
+
+<div class="doc doc-object doc-function">
+
+
+
+<h3 id="streampipes.functions.broker.publisher.Publisher.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-abstractmethod"><code>abstractmethod</code></small>
+ <small class="doc doc-label doc-label-async"><code>async</code></small>
+ </span>
+
+<a href="#streampipes.functions.broker.publisher.Publisher.disconnect" class="headerlink" title="Permanent link">¶</a></h3>
+
+
+ <div class="doc doc-contents ">
+
+ <p>Closes the connection to the server.</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">
+ <div class="doc-md-description">
+
+ </div>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+
+ </div>
+
+</div>
+
+
<div class="doc doc-object doc-function">
diff --git a/docs-python/dev/reference/model/common/index.html b/docs-python/dev/reference/model/common/index.html
index 32fd9e49b..e45700795 100644
--- a/docs-python/dev/reference/model/common/index.html
+++ b/docs-python/dev/reference/model/common/index.html
@@ -1822,6 +1822,19 @@
ApplicationLink
</a>
+ <nav class="md-nav" aria-label="ApplicationLink">
+ <ul class="md-nav__list">
+
+ <li class="md-nav__item">
+ <a href="#streampipes.model.common.ApplicationLink.Config" class="md-nav__link">
+ Config
+ </a>
+
+</li>
+
+ </ul>
+ </nav>
+
</li>
<li class="md-nav__item">
@@ -1829,6 +1842,19 @@
BaseElement
</a>
+ <nav class="md-nav" aria-label="BaseElement">
+ <ul class="md-nav__list">
+
+ <li class="md-nav__item">
+ <a href="#streampipes.model.common.BaseElement.Config" class="md-nav__link">
+ Config
+ </a>
+
+</li>
+
+ </ul>
+ </nav>
+
</li>
<li class="md-nav__item">
@@ -1856,6 +1882,19 @@
EventGrounding
</a>
+ <nav class="md-nav" aria-label="EventGrounding">
+ <ul class="md-nav__list">
+
+ <li class="md-nav__item">
+ <a href="#streampipes.model.common.EventGrounding.Config" class="md-nav__link">
+ Config
+ </a>
+
+</li>
+
+ </ul>
+ </nav>
+
</li>
<li class="md-nav__item">
@@ -1863,6 +1902,19 @@
EventProperty
</a>
+ <nav class="md-nav" aria-label="EventProperty">
+ <ul class="md-nav__list">
+
+ <li class="md-nav__item">
+ <a href="#streampipes.model.common.EventProperty.Config" class="md-nav__link">
+ Config
+ </a>
+
+</li>
+
+ </ul>
+ </nav>
+
</li>
<li class="md-nav__item">
@@ -1870,6 +1922,19 @@
EventSchema
</a>
+ <nav class="md-nav" aria-label="EventSchema">
+ <ul class="md-nav__list">
+
+ <li class="md-nav__item">
+ <a href="#streampipes.model.common.EventSchema.Config" class="md-nav__link">
+ Config
+ </a>
+
+</li>
+
+ </ul>
+ </nav>
+
</li>
<li class="md-nav__item">
@@ -1877,6 +1942,19 @@
MeasurementCapability
</a>
+ <nav class="md-nav" aria-label="MeasurementCapability">
+ <ul class="md-nav__list">
+
+ <li class="md-nav__item">
+ <a href="#streampipes.model.common.MeasurementCapability.Config" class="md-nav__link">
+ Config
+ </a>
+
+</li>
+
+ </ul>
+ </nav>
+
</li>
<li class="md-nav__item">
@@ -1884,6 +1962,19 @@
MeasurementObject
</a>
+ <nav class="md-nav" aria-label="MeasurementObject">
+ <ul class="md-nav__list">
+
+ <li class="md-nav__item">
+ <a href="#streampipes.model.common.MeasurementObject.Config" class="md-nav__link">
+ Config
+ </a>
+
+</li>
+
+ </ul>
+ </nav>
+
</li>
<li class="md-nav__item">
@@ -1891,6 +1982,19 @@
TopicDefinition
</a>
+ <nav class="md-nav" aria-label="TopicDefinition">
+ <ul class="md-nav__list">
+
+ <li class="md-nav__item">
+ <a href="#streampipes.model.common.TopicDefinition.Config" class="md-nav__link">
+ Config
+ </a>
+
+</li>
+
+ </ul>
+ </nav>
+
</li>
<li class="md-nav__item">
@@ -1898,6 +2002,19 @@
TransportFormat
</a>
+ <nav class="md-nav" aria-label="TransportFormat">
+ <ul class="md-nav__list">
+
+ <li class="md-nav__item">
+ <a href="#streampipes.model.common.TransportFormat.Config" class="md-nav__link">
+ Config
+ </a>
+
+</li>
+
+ </ul>
+ </nav>
+
</li>
<li class="md-nav__item">
@@ -1905,6 +2022,19 @@
TransportProtocol
</a>
+ <nav class="md-nav" aria-label="TransportProtocol">
+ <ul class="md-nav__list">
+
+ <li class="md-nav__item">
+ <a href="#streampipes.model.common.TransportProtocol.Config" class="md-nav__link">
+ Config
+ </a>
+
+</li>
+
+ </ul>
+ </nav>
+
</li>
<li class="md-nav__item">
@@ -1912,6 +2042,19 @@
ValueSpecification
</a>
+ <nav class="md-nav" aria-label="ValueSpecification">
+ <ul class="md-nav__list">
+
+ <li class="md-nav__item">
+ <a href="#streampipes.model.common.ValueSpecification.Config" class="md-nav__link">
+ Config
+ </a>
+
+</li>
+
+ </ul>
+ </nav>
+
</li>
<li class="md-nav__item">
@@ -2333,6 +2476,19 @@
ApplicationLink
</a>
+ <nav class="md-nav" aria-label="ApplicationLink">
+ <ul class="md-nav__list">
+
+ <li class="md-nav__item">
+ <a href="#streampipes.model.common.ApplicationLink.Config" class="md-nav__link">
+ Config
+ </a>
+
+</li>
+
+ </ul>
+ </nav>
+
</li>
<li class="md-nav__item">
@@ -2340,6 +2496,19 @@
BaseElement
</a>
+ <nav class="md-nav" aria-label="BaseElement">
+ <ul class="md-nav__list">
+
+ <li class="md-nav__item">
+ <a href="#streampipes.model.common.BaseElement.Config" class="md-nav__link">
+ Config
+ </a>
+
+</li>
+
+ </ul>
+ </nav>
+
</li>
<li class="md-nav__item">
@@ -2367,6 +2536,19 @@
EventGrounding
</a>
+ <nav class="md-nav" aria-label="EventGrounding">
+ <ul class="md-nav__list">
+
+ <li class="md-nav__item">
+ <a href="#streampipes.model.common.EventGrounding.Config" class="md-nav__link">
+ Config
+ </a>
+
+</li>
+
+ </ul>
+ </nav>
+
</li>
<li class="md-nav__item">
@@ -2374,6 +2556,19 @@
EventProperty
</a>
+ <nav class="md-nav" aria-label="EventProperty">
+ <ul class="md-nav__list">
+
+ <li class="md-nav__item">
+ <a href="#streampipes.model.common.EventProperty.Config" class="md-nav__link">
+ Config
+ </a>
+
+</li>
+
+ </ul>
+ </nav>
+
</li>
<li class="md-nav__item">
@@ -2381,6 +2576,19 @@
EventSchema
</a>
+ <nav class="md-nav" aria-label="EventSchema">
+ <ul class="md-nav__list">
+
+ <li class="md-nav__item">
+ <a href="#streampipes.model.common.EventSchema.Config" class="md-nav__link">
+ Config
+ </a>
+
+</li>
+
+ </ul>
+ </nav>
+
</li>
<li class="md-nav__item">
@@ -2388,6 +2596,19 @@
MeasurementCapability
</a>
+ <nav class="md-nav" aria-label="MeasurementCapability">
+ <ul class="md-nav__list">
+
+ <li class="md-nav__item">
+ <a href="#streampipes.model.common.MeasurementCapability.Config" class="md-nav__link">
+ Config
+ </a>
+
+</li>
+
+ </ul>
+ </nav>
+
</li>
<li class="md-nav__item">
@@ -2395,6 +2616,19 @@
MeasurementObject
</a>
+ <nav class="md-nav" aria-label="MeasurementObject">
+ <ul class="md-nav__list">
+
+ <li class="md-nav__item">
+ <a href="#streampipes.model.common.MeasurementObject.Config" class="md-nav__link">
+ Config
+ </a>
+
+</li>
+
+ </ul>
+ </nav>
+
</li>
<li class="md-nav__item">
@@ -2402,6 +2636,19 @@
TopicDefinition
</a>
+ <nav class="md-nav" aria-label="TopicDefinition">
+ <ul class="md-nav__list">
+
+ <li class="md-nav__item">
+ <a href="#streampipes.model.common.TopicDefinition.Config" class="md-nav__link">
+ Config
+ </a>
+
+</li>
+
+ </ul>
+ </nav>
+
</li>
<li class="md-nav__item">
@@ -2409,6 +2656,19 @@
TransportFormat
</a>
+ <nav class="md-nav" aria-label="TransportFormat">
+ <ul class="md-nav__list">
+
+ <li class="md-nav__item">
+ <a href="#streampipes.model.common.TransportFormat.Config" class="md-nav__link">
+ Config
+ </a>
+
+</li>
+
+ </ul>
+ </nav>
+
</li>
<li class="md-nav__item">
@@ -2416,6 +2676,19 @@
TransportProtocol
</a>
+ <nav class="md-nav" aria-label="TransportProtocol">
+ <ul class="md-nav__list">
+
+ <li class="md-nav__item">
+ <a href="#streampipes.model.common.TransportProtocol.Config" class="md-nav__link">
+ Config
+ </a>
+
+</li>
+
+ </ul>
+ </nav>
+
</li>
<li class="md-nav__item">
@@ -2423,6 +2696,19 @@
ValueSpecification
</a>
+ <nav class="md-nav" aria-label="ValueSpecification">
+ <ul class="md-nav__list">
+
+ <li class="md-nav__item">
+ <a href="#streampipes.model.common.ValueSpecification.Config" class="md-nav__link">
+ Config
+ </a>
+
+</li>
+
+ </ul>
+ </nav>
+
</li>
<li class="md-nav__item">
@@ -2502,22 +2788,61 @@
+<div class="doc doc-object doc-class">
- </div>
+<h3 id="streampipes.model.common.ApplicationLink.Config" class="doc doc-heading">
+ <code>Config</code>
- </div>
+<a href="#streampipes.model.common.ApplicationLink.Config" class="headerlink" title="Permanent link">¶</a></h3>
-</div>
-<div class="doc doc-object doc-class">
+ <div class="doc doc-contents ">
+
+ <p>Configuration class for Pydantic.
+Defines alias generator to convert field names from camelCase (API) to snake_case (Python codebase).</p>
-<h2 id="streampipes.model.common.BaseElement" class="doc doc-heading">
- <code>BaseElement</code>
+
+
+ <div class="doc doc-children">
+
+
+
+
+
+
+
+
+
+
+
+ </div>
+
+ </div>
+
+
+</div>
+
+
+
+
+ </div>
+
+ </div>
+
+
+</div>
+
+<div class="doc doc-object doc-class">
+
+
+
+<h2 id="streampipes.model.common.BaseElement" class="doc doc-heading">
+ <code>BaseElement</code>
<a href="#streampipes.model.common.BaseElement" class="headerlink" title="Permanent link">¶</a></h2>
@@ -2542,6 +2867,45 @@
+<div class="doc doc-object doc-class">
+
+
+
+<h3 id="streampipes.model.common.BaseElement.Config" class="doc doc-heading">
+ <code>Config</code>
+
+
+<a href="#streampipes.model.common.BaseElement.Config" class="headerlink" title="Permanent link">¶</a></h3>
+
+
+ <div class="doc doc-contents ">
+
+
+ <p>Configuration class for Pydantic.
+Defines alias generator to convert field names from camelCase (API) to snake_case (Python codebase).</p>
+
+
+
+
+ <div class="doc doc-children">
+
+
+
+
+
+
+
+
+
+
+
+ </div>
+
+ </div>
+
+
+</div>
+
@@ -2661,6 +3025,45 @@ Defines alias generator to convert field names from camelCase (API) to snake_cas
+<div class="doc doc-object doc-class">
+
+
+
+<h3 id="streampipes.model.common.EventGrounding.Config" class="doc doc-heading">
+ <code>Config</code>
+
+
+<a href="#streampipes.model.common.EventGrounding.Config" class="headerlink" title="Permanent link">¶</a></h3>
+
+
+ <div class="doc doc-contents ">
+
+
+ <p>Configuration class for Pydantic.
+Defines alias generator to convert field names from camelCase (API) to snake_case (Python codebase).</p>
+
+
+
+
+ <div class="doc doc-children">
+
+
+
+
+
+
+
+
+
+
+
+ </div>
+
+ </div>
+
+
+</div>
+
@@ -2701,6 +3104,45 @@ Defines alias generator to convert field names from camelCase (API) to snake_cas
+<div class="doc doc-object doc-class">
+
+
+
+<h3 id="streampipes.model.common.EventProperty.Config" class="doc doc-heading">
+ <code>Config</code>
+
+
+<a href="#streampipes.model.common.EventProperty.Config" class="headerlink" title="Permanent link">¶</a></h3>
+
+
+ <div class="doc doc-contents ">
+
+
+ <p>Configuration class for Pydantic.
+Defines alias generator to convert field names from camelCase (API) to snake_case (Python codebase).</p>
+
+
+
+
+ <div class="doc doc-children">
+
+
+
+
+
+
+
+
+
+
+
+ </div>
+
+ </div>
+
+
+</div>
+
@@ -2741,6 +3183,45 @@ Defines alias generator to convert field names from camelCase (API) to snake_cas
+<div class="doc doc-object doc-class">
+
+
+
+<h3 id="streampipes.model.common.EventSchema.Config" class="doc doc-heading">
+ <code>Config</code>
+
+
+<a href="#streampipes.model.common.EventSchema.Config" class="headerlink" title="Permanent link">¶</a></h3>
+
+
+ <div class="doc doc-contents ">
+
+
+ <p>Configuration class for Pydantic.
+Defines alias generator to convert field names from camelCase (API) to snake_case (Python codebase).</p>
+
+
+
+
+ <div class="doc doc-children">
+
+
+
+
+
+
+
+
+
+
+
+ </div>
+
+ </div>
+
+
+</div>
+
@@ -2781,6 +3262,45 @@ Defines alias generator to convert field names from camelCase (API) to snake_cas
+<div class="doc doc-object doc-class">
+
+
+
+<h3 id="streampipes.model.common.MeasurementCapability.Config" class="doc doc-heading">
+ <code>Config</code>
+
+
+<a href="#streampipes.model.common.MeasurementCapability.Config" class="headerlink" title="Permanent link">¶</a></h3>
+
+
+ <div class="doc doc-contents ">
+
+
+ <p>Configuration class for Pydantic.
+Defines alias generator to convert field names from camelCase (API) to snake_case (Python codebase).</p>
+
+
+
+
+ <div class="doc doc-children">
+
+
+
+
+
+
+
+
+
+
+
+ </div>
+
+ </div>
+
+
+</div>
+
@@ -2821,6 +3341,45 @@ Defines alias generator to convert field names from camelCase (API) to snake_cas
+<div class="doc doc-object doc-class">
+
+
+
+<h3 id="streampipes.model.common.MeasurementObject.Config" class="doc doc-heading">
+ <code>Config</code>
+
+
+<a href="#streampipes.model.common.MeasurementObject.Config" class="headerlink" title="Permanent link">¶</a></h3>
+
+
+ <div class="doc doc-contents ">
+
+
+ <p>Configuration class for Pydantic.
+Defines alias generator to convert field names from camelCase (API) to snake_case (Python codebase).</p>
+
+
+
+
+ <div class="doc doc-children">
+
+
+
+
+
+
+
+
+
+
+
+ </div>
+
+ </div>
+
+
+</div>
+
@@ -2861,6 +3420,45 @@ Defines alias generator to convert field names from camelCase (API) to snake_cas
+<div class="doc doc-object doc-class">
+
+
+
+<h3 id="streampipes.model.common.TopicDefinition.Config" class="doc doc-heading">
+ <code>Config</code>
+
+
+<a href="#streampipes.model.common.TopicDefinition.Config" class="headerlink" title="Permanent link">¶</a></h3>
+
+
+ <div class="doc doc-contents ">
+
+
+ <p>Configuration class for Pydantic.
+Defines alias generator to convert field names from camelCase (API) to snake_case (Python codebase).</p>
+
+
+
+
+ <div class="doc doc-children">
+
+
+
+
+
+
+
+
+
+
+
+ </div>
+
+ </div>
+
+
+</div>
+
@@ -2901,6 +3499,45 @@ Defines alias generator to convert field names from camelCase (API) to snake_cas
+<div class="doc doc-object doc-class">
+
+
+
+<h3 id="streampipes.model.common.TransportFormat.Config" class="doc doc-heading">
+ <code>Config</code>
+
+
+<a href="#streampipes.model.common.TransportFormat.Config" class="headerlink" title="Permanent link">¶</a></h3>
+
+
+ <div class="doc doc-contents ">
+
+
+ <p>Configuration class for Pydantic.
+Defines alias generator to convert field names from camelCase (API) to snake_case (Python codebase).</p>
+
+
+
+
+ <div class="doc doc-children">
+
+
+
+
+
+
+
+
+
+
+
+ </div>
+
+ </div>
+
+
+</div>
+
@@ -2941,6 +3578,45 @@ Defines alias generator to convert field names from camelCase (API) to snake_cas
+<div class="doc doc-object doc-class">
+
+
+
+<h3 id="streampipes.model.common.TransportProtocol.Config" class="doc doc-heading">
+ <code>Config</code>
+
+
+<a href="#streampipes.model.common.TransportProtocol.Config" class="headerlink" title="Permanent link">¶</a></h3>
+
+
+ <div class="doc doc-contents ">
+
+
+ <p>Configuration class for Pydantic.
+Defines alias generator to convert field names from camelCase (API) to snake_case (Python codebase).</p>
+
+
+
+
+ <div class="doc doc-children">
+
+
+
+
+
+
+
+
+
+
+
+ </div>
+
+ </div>
+
+
+</div>
+
@@ -2981,6 +3657,45 @@ Defines alias generator to convert field names from camelCase (API) to snake_cas
+<div class="doc doc-object doc-class">
+
+
+
+<h3 id="streampipes.model.common.ValueSpecification.Config" class="doc doc-heading">
+ <code>Config</code>
+
+
+<a href="#streampipes.model.common.ValueSpecification.Config" class="headerlink" title="Permanent link">¶</a></h3>
+
+
+ <div class="doc doc-contents ">
+
+
+ <p>Configuration class for Pydantic.
+Defines alias generator to convert field names from camelCase (API) to snake_case (Python codebase).</p>
+
+
+
+
+ <div class="doc doc-children">
+
+
+
+
+
+
+
+
+
+
+
+ </div>
+
+ </div>
+
+
+</div>
+
diff --git a/docs-python/dev/reference/model/container/data_lake_measures/index.html b/docs-python/dev/reference/model/container/data_lake_measures/index.html
index 5bce072e5..e4bf42a5c 100644
--- a/docs-python/dev/reference/model/container/data_lake_measures/index.html
+++ b/docs-python/dev/reference/model/container/data_lake_measures/index.html
@@ -1888,6 +1888,40 @@
DataLakeMeasures
</a>
+ <nav class="md-nav" aria-label="DataLakeMeasures">
+ <ul class="md-nav__list">
+
+ <li class="md-nav__item">
+ <a href="#streampipes.model.container.data_lake_measures.DataLakeMeasures.from_json" class="md-nav__link">
+ from_json
+ </a>
+
+</li>
+
+ <li class="md-nav__item">
+ <a href="#streampipes.model.container.data_lake_measures.DataLakeMeasures.to_dicts" class="md-nav__link">
+ to_dicts
+ </a>
+
+</li>
+
+ <li class="md-nav__item">
+ <a href="#streampipes.model.container.data_lake_measures.DataLakeMeasures.to_json" class="md-nav__link">
+ to_json
+ </a>
+
+</li>
+
+ <li class="md-nav__item">
+ <a href="#streampipes.model.container.data_lake_measures.DataLakeMeasures.to_pandas" class="md-nav__link">
+ to_pandas
+ </a>
+
+</li>
+
+ </ul>
+ </nav>
+
</li>
</ul>
@@ -2238,6 +2272,40 @@
DataLakeMeasures
</a>
+ <nav class="md-nav" aria-label="DataLakeMeasures">
+ <ul class="md-nav__list">
+
+ <li class="md-nav__item">
+ <a href="#streampipes.model.container.data_lake_measures.DataLakeMeasures.from_json" class="md-nav__link">
+ from_json
+ </a>
+
+</li>
+
+ <li class="md-nav__item">
+ <a href="#streampipes.model.container.data_lake_measures.DataLakeMeasures.to_dicts" class="md-nav__link">
+ to_dicts
+ </a>
+
+</li>
+
+ <li class="md-nav__item">
+ <a href="#streampipes.model.container.data_lake_measures.DataLakeMeasures.to_json" class="md-nav__link">
+ to_json
+ </a>
+
+</li>
+
+ <li class="md-nav__item">
+ <a href="#streampipes.model.container.data_lake_measures.DataLakeMeasures.to_pandas" class="md-nav__link">
+ to_pandas
+ </a>
+
+</li>
+
+ </ul>
+ </nav>
+
</li>
</ul>
@@ -2314,6 +2382,296 @@ Furthermore, the resource container makes them accessible in a pythonic manner.<
+<div class="doc doc-object doc-function">
+
+
+
+<h3 id="streampipes.model.container.data_lake_measures.DataLakeMeasures.from_json" class="doc doc-heading">
+ <code class="highlight language-python"><span class="n">from_json</span><span class="p">(</span><span class="n">json_string</span><span class="p">)</span></code>
+
+ <span class="doc doc-labels">
+ <small class="doc doc-label doc-label-classmethod"><code>classmethod</code></small>
+ </span>
+
+<a href="#streampipes.model.container.data_lake_measures.DataLakeMeasures.from_json" class="headerlink" title="Permanent link">¶</a></h3>
+
+
+ <div class="doc doc-contents ">
+
+ <p>Creates a <code>ResourceContainer</code> from the given JSON string.</p>
+
+
+
+ <table>
+ <thead>
+ <tr>
+ <th><b>PARAMETER</b></th>
+ <th><b> DESCRIPTION</b></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><code>json_string</code></td>
+ <td class="doc-param-details">
+ <div class="doc-md-description">
+ <p>The JSON string returned from the StreamPipes API.</p>
+ </div>
+ <p>
+ <span class="doc-param-annotation">
+ <b>TYPE:</b>
+ <code>str</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>container</code>
+ </td>
+ <td class="doc-returns-details">
+ <div class="doc-md-description">
+ <p>instance of the container derived from the JSON definition</p>
+ </div>
+ <p>
+ <span class="doc-returns-annotation">
+ <b>TYPE:</b>
+ <code><a class="autorefs autorefs-internal" title="streampipes.model.container.resource_container.ResourceContainer" href="../resource_container/#streampipes.model.container.resource_container.ResourceContainer">ResourceContainer</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.model.container.resource_container.StreamPipesDataModelError" href="../resource_container/#streampipes.model.container.resource_container.StreamPipesDataModelError">StreamPipesDataModelError</a></code>
+ </span>
+ </td>
+ <td class="doc-raises-details">
+ <div class="doc-md-description">
+ <p>If a resource cannot be mapped to the corresponding Python data model.</p>
+ </div>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <span class="doc-raises-annotation">
+ <code><a class="autorefs autorefs-internal" title="streampipes.model.container.resource_container.StreamPipesResourceContainerJSONError" href="../resource_container/#streampipes.model.container.resource_container.StreamPipesResourceContainerJSONError">StreamPipesResourceContainerJSONError</a></code>
+ </span>
+ </td>
+ <td class="doc-raises-details">
+ <div class="doc-md-description">
+ <p>If JSON response cannot be parsed to a <code>ResourceContainer</code>.</p>
+ </div>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+
+ </div>
+
+</div>
+
+
+<div class="doc doc-object doc-function">
+
+
+
+<h3 id="streampipes.model.container.data_lake_measures.DataLakeMeasures.to_dicts" class="doc doc-heading">
+ <code class="highlight language-python"><span class="n">to_dicts</span><span class="p">(</span><span class="n">use_source_names</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span></code>
+
+<a href="#streampipes.model.container.data_lake_measures.DataLakeMeasures.to_dicts" class="headerlink" title="Permanent link">¶</a></h3>
+
+
+ <div class="doc doc-contents ">
+
+ <p>Returns the contained resources as list of dictionaries.</p>
+
+
+
+ <table>
+ <thead>
+ <tr>
+ <th><b>PARAMETER</b></th>
+ <th><b> DESCRIPTION</b></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><code>use_source_names</code></td>
+ <td class="doc-param-details">
+ <div class="doc-md-description">
+ <p>Determines whether the field names are named in Python style (=<code>False</code>) or
+as originally named by StreamPipes (=<code>True</code>).</p>
+ </div>
+ <p>
+ <span class="doc-param-annotation">
+ <b>TYPE:</b>
+ <code>bool</code>
+ </span>
+ <span class="doc-param-default">
+ <b>DEFAULT:</b>
+ <code>False</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>dictionary_list</code>
+ </td>
+ <td class="doc-returns-details">
+ <div class="doc-md-description">
+ <p>List of resources in dictionary representation.
+If <code>use_source_names</code> equals <code>True</code> the keys are named as in the StreamPipes backend.</p>
+ </div>
+ <p>
+ <span class="doc-returns-annotation">
+ <b>TYPE:</b>
+ <code><span title="typing.List">List</span>[<span title="typing.Dict">Dict</span>[str, Any]]</code>
+ </span>
+ </p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+
+ </div>
+
+</div>
+
+
+<div class="doc doc-object doc-function">
+
+
+
+<h3 id="streampipes.model.container.data_lake_measures.DataLakeMeasures.to_json" class="doc doc-heading">
+ <code class="highlight language-python"><span class="n">to_json</span><span class="p">()</span></code>
+
+<a href="#streampipes.model.container.data_lake_measures.DataLakeMeasures.to_json" class="headerlink" title="Permanent link">¶</a></h3>
+
+
+ <div class="doc doc-contents ">
+
+ <p>Returns the resource container in the StreamPipes JSON representation.</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> json_string: str</code>
+ </span>
+ </td>
+ <td class="doc-returns-details">
+ <div class="doc-md-description">
+ <p>JSON representation of the resource container where key names are equal to
+keys used in the StreamPipes backend</p>
+ </div>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+
+ </div>
+
+</div>
+
+
+<div class="doc doc-object doc-function">
+
+
+
+<h3 id="streampipes.model.container.data_lake_measures.DataLakeMeasures.to_pandas" class="doc doc-heading">
+ <code class="highlight language-python"><span class="n">to_pandas</span><span class="p">()</span></code>
+
+<a href="#streampipes.model.container.data_lake_measures.DataLakeMeasures.to_pandas" class="headerlink" title="Permanent link">¶</a></h3>
+
+
+ <div class="doc doc-contents ">
+
+ <p>Returns the resource container in representation of a Pandas Dataframe.</p>
+
+
+
+ <table>
+ <thead>
+ <tr>
+ <th><b>RETURNS</b></th>
+ <th><b>DESCRIPTION</b></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ <code>resource_container_df</code>
+ </td>
+ <td class="doc-returns-details">
+ <div class="doc-md-description">
+ <p>Representation of the resource container as pandas DataFrame</p>
+ </div>
+ <p>
+ <span class="doc-returns-annotation">
+ <b>TYPE:</b>
+ <code><span title="pandas.DataFrame">DataFrame</span></code>
+ </span>
+ </p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+
+ </div>
+
+</div>
+
+
</div>
diff --git a/docs-python/dev/reference/model/container/data_streams/index.html b/docs-python/dev/reference/model/container/data_streams/index.html
index 6e41481d7..c3bc853e0 100644
--- a/docs-python/dev/reference/model/container/data_streams/index.html
+++ b/docs-python/dev/reference/model/container/data_streams/index.html
@@ -1908,6 +1908,40 @@
DataStreams
</a>
+ <nav class="md-nav" aria-label="DataStreams">
+ <ul class="md-nav__list">
+
+ <li class="md-nav__item">
+ <a href="#streampipes.model.container.data_streams.DataStreams.from_json" class="md-nav__link">
+ from_json
+ </a>
+
+</li>
+
+ <li class="md-nav__item">
+ <a href="#streampipes.model.container.data_streams.DataStreams.to_dicts" class="md-nav__link">
+ to_dicts
+ </a>
+
+</li>
+
+ <li class="md-nav__item">
+ <a href="#streampipes.model.container.data_streams.DataStreams.to_json" class="md-nav__link">
+ to_json
+ </a>
+
+</li>
+
+ <li class="md-nav__item">
+ <a href="#streampipes.model.container.data_streams.DataStreams.to_pandas" class="md-nav__link">
+ to_pandas
+ </a>
+
+</li>
+
+ </ul>
+ </nav>
+
</li>
</ul>
@@ -2238,6 +2272,40 @@
DataStreams
</a>
+ <nav class="md-nav" aria-label="DataStreams">
+ <ul class="md-nav__list">
+
+ <li class="md-nav__item">
+ <a href="#streampipes.model.container.data_streams.DataStreams.from_json" class="md-nav__link">
+ from_json
+ </a>
+
+</li>
+
+ <li class="md-nav__item">
+ <a href="#streampipes.model.container.data_streams.DataStreams.to_dicts" class="md-nav__link">
+ to_dicts
+ </a>
+
+</li>
+
+ <li class="md-nav__item">
+ <a href="#streampipes.model.container.data_streams.DataStreams.to_json" class="md-nav__link">
+ to_json
+ </a>
+
+</li>
+
+ <li class="md-nav__item">
+ <a href="#streampipes.model.container.data_streams.DataStreams.to_pandas" class="md-nav__link">
+ to_pandas
+ </a>
+
+</li>
+
+ </ul>
+ </nav>
+
</li>
</ul>
@@ -2314,6 +2382,296 @@ Furthermore, the resource container makes them accessible in a pythonic manner.<
+<div class="doc doc-object doc-function">
+
+
+
+<h3 id="streampipes.model.container.data_streams.DataStreams.from_json" class="doc doc-heading">
+ <code class="highlight language-python"><span class="n">from_json</span><span class="p">(</span><span class="n">json_string</span><span class="p">)</span></code>
+
+ <span class="doc doc-labels">
+ <small class="doc doc-label doc-label-classmethod"><code>classmethod</code></small>
+ </span>
+
+<a href="#streampipes.model.container.data_streams.DataStreams.from_json" class="headerlink" title="Permanent link">¶</a></h3>
+
+
+ <div class="doc doc-contents ">
+
+ <p>Creates a <code>ResourceContainer</code> from the given JSON string.</p>
+
+
+
+ <table>
+ <thead>
+ <tr>
+ <th><b>PARAMETER</b></th>
+ <th><b> DESCRIPTION</b></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><code>json_string</code></td>
+ <td class="doc-param-details">
+ <div class="doc-md-description">
+ <p>The JSON string returned from the StreamPipes API.</p>
+ </div>
+ <p>
+ <span class="doc-param-annotation">
+ <b>TYPE:</b>
+ <code>str</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>container</code>
+ </td>
+ <td class="doc-returns-details">
+ <div class="doc-md-description">
+ <p>instance of the container derived from the JSON definition</p>
+ </div>
+ <p>
+ <span class="doc-returns-annotation">
+ <b>TYPE:</b>
+ <code><a class="autorefs autorefs-internal" title="streampipes.model.container.resource_container.ResourceContainer" href="../resource_container/#streampipes.model.container.resource_container.ResourceContainer">ResourceContainer</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.model.container.resource_container.StreamPipesDataModelError" href="../resource_container/#streampipes.model.container.resource_container.StreamPipesDataModelError">StreamPipesDataModelError</a></code>
+ </span>
+ </td>
+ <td class="doc-raises-details">
+ <div class="doc-md-description">
+ <p>If a resource cannot be mapped to the corresponding Python data model.</p>
+ </div>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <span class="doc-raises-annotation">
+ <code><a class="autorefs autorefs-internal" title="streampipes.model.container.resource_container.StreamPipesResourceContainerJSONError" href="../resource_container/#streampipes.model.container.resource_container.StreamPipesResourceContainerJSONError">StreamPipesResourceContainerJSONError</a></code>
+ </span>
+ </td>
+ <td class="doc-raises-details">
+ <div class="doc-md-description">
+ <p>If JSON response cannot be parsed to a <code>ResourceContainer</code>.</p>
+ </div>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+
+ </div>
+
+</div>
+
+
+<div class="doc doc-object doc-function">
+
+
+
+<h3 id="streampipes.model.container.data_streams.DataStreams.to_dicts" class="doc doc-heading">
+ <code class="highlight language-python"><span class="n">to_dicts</span><span class="p">(</span><span class="n">use_source_names</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span></code>
+
+<a href="#streampipes.model.container.data_streams.DataStreams.to_dicts" class="headerlink" title="Permanent link">¶</a></h3>
+
+
+ <div class="doc doc-contents ">
+
+ <p>Returns the contained resources as list of dictionaries.</p>
+
+
+
+ <table>
+ <thead>
+ <tr>
+ <th><b>PARAMETER</b></th>
+ <th><b> DESCRIPTION</b></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><code>use_source_names</code></td>
+ <td class="doc-param-details">
+ <div class="doc-md-description">
+ <p>Determines whether the field names are named in Python style (=<code>False</code>) or
+as originally named by StreamPipes (=<code>True</code>).</p>
+ </div>
+ <p>
+ <span class="doc-param-annotation">
+ <b>TYPE:</b>
+ <code>bool</code>
+ </span>
+ <span class="doc-param-default">
+ <b>DEFAULT:</b>
+ <code>False</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>dictionary_list</code>
+ </td>
+ <td class="doc-returns-details">
+ <div class="doc-md-description">
+ <p>List of resources in dictionary representation.
+If <code>use_source_names</code> equals <code>True</code> the keys are named as in the StreamPipes backend.</p>
+ </div>
+ <p>
+ <span class="doc-returns-annotation">
+ <b>TYPE:</b>
+ <code><span title="typing.List">List</span>[<span title="typing.Dict">Dict</span>[str, Any]]</code>
+ </span>
+ </p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+
+ </div>
+
+</div>
+
+
+<div class="doc doc-object doc-function">
+
+
+
+<h3 id="streampipes.model.container.data_streams.DataStreams.to_json" class="doc doc-heading">
+ <code class="highlight language-python"><span class="n">to_json</span><span class="p">()</span></code>
+
+<a href="#streampipes.model.container.data_streams.DataStreams.to_json" class="headerlink" title="Permanent link">¶</a></h3>
+
+
+ <div class="doc doc-contents ">
+
+ <p>Returns the resource container in the StreamPipes JSON representation.</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> json_string: str</code>
+ </span>
+ </td>
+ <td class="doc-returns-details">
+ <div class="doc-md-description">
+ <p>JSON representation of the resource container where key names are equal to
+keys used in the StreamPipes backend</p>
+ </div>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+
+ </div>
+
+</div>
+
+
+<div class="doc doc-object doc-function">
+
+
+
+<h3 id="streampipes.model.container.data_streams.DataStreams.to_pandas" class="doc doc-heading">
+ <code class="highlight language-python"><span class="n">to_pandas</span><span class="p">()</span></code>
+
+<a href="#streampipes.model.container.data_streams.DataStreams.to_pandas" class="headerlink" title="Permanent link">¶</a></h3>
+
+
+ <div class="doc doc-contents ">
+
+ <p>Returns the resource container in representation of a Pandas Dataframe.</p>
+
+
+
+ <table>
+ <thead>
+ <tr>
+ <th><b>RETURNS</b></th>
+ <th><b>DESCRIPTION</b></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ <code>resource_container_df</code>
+ </td>
+ <td class="doc-returns-details">
+ <div class="doc-md-description">
+ <p>Representation of the resource container as pandas DataFrame</p>
+ </div>
+ <p>
+ <span class="doc-returns-annotation">
+ <b>TYPE:</b>
+ <code><span title="pandas.DataFrame">DataFrame</span></code>
+ </span>
+ </p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+
+ </div>
+
+</div>
+
+
</div>
diff --git a/docs-python/dev/reference/model/container/versions/index.html b/docs-python/dev/reference/model/container/versions/index.html
index 61ce7432d..4767cc974 100644
--- a/docs-python/dev/reference/model/container/versions/index.html
+++ b/docs-python/dev/reference/model/container/versions/index.html
@@ -1948,6 +1948,40 @@
Versions
</a>
+ <nav class="md-nav" aria-label="Versions">
+ <ul class="md-nav__list">
+
+ <li class="md-nav__item">
+ <a href="#streampipes.model.container.versions.Versions.from_json" class="md-nav__link">
+ from_json
+ </a>
+
+</li>
+
+ <li class="md-nav__item">
+ <a href="#streampipes.model.container.versions.Versions.to_dicts" class="md-nav__link">
+ to_dicts
+ </a>
+
+</li>
+
+ <li class="md-nav__item">
+ <a href="#streampipes.model.container.versions.Versions.to_json" class="md-nav__link">
+ to_json
+ </a>
+
+</li>
+
+ <li class="md-nav__item">
+ <a href="#streampipes.model.container.versions.Versions.to_pandas" class="md-nav__link">
+ to_pandas
+ </a>
+
+</li>
+
+ </ul>
+ </nav>
+
</li>
</ul>
@@ -2238,6 +2272,40 @@
Versions
</a>
+ <nav class="md-nav" aria-label="Versions">
+ <ul class="md-nav__list">
+
+ <li class="md-nav__item">
+ <a href="#streampipes.model.container.versions.Versions.from_json" class="md-nav__link">
+ from_json
+ </a>
+
+</li>
+
+ <li class="md-nav__item">
+ <a href="#streampipes.model.container.versions.Versions.to_dicts" class="md-nav__link">
+ to_dicts
+ </a>
+
+</li>
+
+ <li class="md-nav__item">
+ <a href="#streampipes.model.container.versions.Versions.to_json" class="md-nav__link">
+ to_json
+ </a>
+
+</li>
+
+ <li class="md-nav__item">
+ <a href="#streampipes.model.container.versions.Versions.to_pandas" class="md-nav__link">
+ to_pandas
+ </a>
+
+</li>
+
+ </ul>
+ </nav>
+
</li>
</ul>
@@ -2341,6 +2409,296 @@ Furthermore, the resource container makes them accessible in a pythonic manner.<
+<div class="doc doc-object doc-function">
+
+
+
+<h3 id="streampipes.model.container.versions.Versions.from_json" class="doc doc-heading">
+ <code class="highlight language-python"><span class="n">from_json</span><span class="p">(</span><span class="n">json_string</span><span class="p">)</span></code>
+
+ <span class="doc doc-labels">
+ <small class="doc doc-label doc-label-classmethod"><code>classmethod</code></small>
+ </span>
+
+<a href="#streampipes.model.container.versions.Versions.from_json" class="headerlink" title="Permanent link">¶</a></h3>
+
+
+ <div class="doc doc-contents ">
+
+ <p>Creates a <code>ResourceContainer</code> from the given JSON string.</p>
+
+
+
+ <table>
+ <thead>
+ <tr>
+ <th><b>PARAMETER</b></th>
+ <th><b> DESCRIPTION</b></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><code>json_string</code></td>
+ <td class="doc-param-details">
+ <div class="doc-md-description">
+ <p>The JSON string returned from the StreamPipes API.</p>
+ </div>
+ <p>
+ <span class="doc-param-annotation">
+ <b>TYPE:</b>
+ <code>str</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>container</code>
+ </td>
+ <td class="doc-returns-details">
+ <div class="doc-md-description">
+ <p>instance of the container derived from the JSON definition</p>
+ </div>
+ <p>
+ <span class="doc-returns-annotation">
+ <b>TYPE:</b>
+ <code><a class="autorefs autorefs-internal" title="streampipes.model.container.resource_container.ResourceContainer" href="../resource_container/#streampipes.model.container.resource_container.ResourceContainer">ResourceContainer</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.model.container.resource_container.StreamPipesDataModelError" href="../resource_container/#streampipes.model.container.resource_container.StreamPipesDataModelError">StreamPipesDataModelError</a></code>
+ </span>
+ </td>
+ <td class="doc-raises-details">
+ <div class="doc-md-description">
+ <p>If a resource cannot be mapped to the corresponding Python data model.</p>
+ </div>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <span class="doc-raises-annotation">
+ <code><a class="autorefs autorefs-internal" title="streampipes.model.container.resource_container.StreamPipesResourceContainerJSONError" href="../resource_container/#streampipes.model.container.resource_container.StreamPipesResourceContainerJSONError">StreamPipesResourceContainerJSONError</a></code>
+ </span>
+ </td>
+ <td class="doc-raises-details">
+ <div class="doc-md-description">
+ <p>If JSON response cannot be parsed to a <code>ResourceContainer</code>.</p>
+ </div>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+
+ </div>
+
+</div>
+
+
+<div class="doc doc-object doc-function">
+
+
+
+<h3 id="streampipes.model.container.versions.Versions.to_dicts" class="doc doc-heading">
+ <code class="highlight language-python"><span class="n">to_dicts</span><span class="p">(</span><span class="n">use_source_names</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span></code>
+
+<a href="#streampipes.model.container.versions.Versions.to_dicts" class="headerlink" title="Permanent link">¶</a></h3>
+
+
+ <div class="doc doc-contents ">
+
+ <p>Returns the contained resources as list of dictionaries.</p>
+
+
+
+ <table>
+ <thead>
+ <tr>
+ <th><b>PARAMETER</b></th>
+ <th><b> DESCRIPTION</b></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><code>use_source_names</code></td>
+ <td class="doc-param-details">
+ <div class="doc-md-description">
+ <p>Determines whether the field names are named in Python style (=<code>False</code>) or
+as originally named by StreamPipes (=<code>True</code>).</p>
+ </div>
+ <p>
+ <span class="doc-param-annotation">
+ <b>TYPE:</b>
+ <code>bool</code>
+ </span>
+ <span class="doc-param-default">
+ <b>DEFAULT:</b>
+ <code>False</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>dictionary_list</code>
+ </td>
+ <td class="doc-returns-details">
+ <div class="doc-md-description">
+ <p>List of resources in dictionary representation.
+If <code>use_source_names</code> equals <code>True</code> the keys are named as in the StreamPipes backend.</p>
+ </div>
+ <p>
+ <span class="doc-returns-annotation">
+ <b>TYPE:</b>
+ <code><span title="typing.List">List</span>[<span title="typing.Dict">Dict</span>[str, Any]]</code>
+ </span>
+ </p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+
+ </div>
+
+</div>
+
+
+<div class="doc doc-object doc-function">
+
+
+
+<h3 id="streampipes.model.container.versions.Versions.to_json" class="doc doc-heading">
+ <code class="highlight language-python"><span class="n">to_json</span><span class="p">()</span></code>
+
+<a href="#streampipes.model.container.versions.Versions.to_json" class="headerlink" title="Permanent link">¶</a></h3>
+
+
+ <div class="doc doc-contents ">
+
+ <p>Returns the resource container in the StreamPipes JSON representation.</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> json_string: str</code>
+ </span>
+ </td>
+ <td class="doc-returns-details">
+ <div class="doc-md-description">
+ <p>JSON representation of the resource container where key names are equal to
+keys used in the StreamPipes backend</p>
+ </div>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+
+ </div>
+
+</div>
+
+
+<div class="doc doc-object doc-function">
+
+
+
+<h3 id="streampipes.model.container.versions.Versions.to_pandas" class="doc doc-heading">
+ <code class="highlight language-python"><span class="n">to_pandas</span><span class="p">()</span></code>
+
+<a href="#streampipes.model.container.versions.Versions.to_pandas" class="headerlink" title="Permanent link">¶</a></h3>
+
+
+ <div class="doc doc-contents ">
+
+ <p>Returns the resource container in representation of a Pandas Dataframe.</p>
+
+
+
+ <table>
+ <thead>
+ <tr>
+ <th><b>RETURNS</b></th>
+ <th><b>DESCRIPTION</b></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ <code>resource_container_df</code>
+ </td>
+ <td class="doc-returns-details">
+ <div class="doc-md-description">
+ <p>Representation of the resource container as pandas DataFrame</p>
+ </div>
+ <p>
+ <span class="doc-returns-annotation">
+ <b>TYPE:</b>
+ <code><span title="pandas.DataFrame">DataFrame</span></code>
+ </span>
+ </p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+
+ </div>
+
+</div>
+
+
</div>
diff --git a/docs-python/dev/reference/model/resource/data_lake_measure/index.html b/docs-python/dev/reference/model/resource/data_lake_measure/index.html
index 3a5d82a6e..922de8bb6 100644
--- a/docs-python/dev/reference/model/resource/data_lake_measure/index.html
+++ b/docs-python/dev/reference/model/resource/data_lake_measure/index.html
@@ -2031,11 +2031,25 @@
<nav class="md-nav" aria-label="DataLakeMeasure">
<ul class="md-nav__list">
+ <li class="md-nav__item">
+ <a href="#streampipes.model.resource.data_lake_measure.DataLakeMeasure.Config" class="md-nav__link">
+ Config
+ </a>
+
+</li>
+
<li class="md-nav__item">
<a href="#streampipes.model.resource.data_lake_measure.DataLakeMeasure.convert_to_pandas_representation" class="md-nav__link">
convert_to_pandas_representation
</a>
+</li>
+
+ <li class="md-nav__item">
+ <a href="#streampipes.model.resource.data_lake_measure.DataLakeMeasure.to_dict" class="md-nav__link">
+ to_dict
+ </a>
+
</li>
</ul>
@@ -2254,11 +2268,25 @@
<nav class="md-nav" aria-label="DataLakeMeasure">
<ul class="md-nav__list">
+ <li class="md-nav__item">
+ <a href="#streampipes.model.resource.data_lake_measure.DataLakeMeasure.Config" class="md-nav__link">
+ Config
+ </a>
+
+</li>
+
<li class="md-nav__item">
<a href="#streampipes.model.resource.data_lake_measure.DataLakeMeasure.convert_to_pandas_representation" class="md-nav__link">
convert_to_pandas_representation
</a>
+</li>
+
+ <li class="md-nav__item">
+ <a href="#streampipes.model.resource.data_lake_measure.DataLakeMeasure.to_dict" class="md-nav__link">
+ to_dict
+ </a>
+
</li>
</ul>
@@ -2338,6 +2366,45 @@ the Python representation (both serialized and deserialized) and Java representa
+<div class="doc doc-object doc-class">
+
+
+
+<h3 id="streampipes.model.resource.data_lake_measure.DataLakeMeasure.Config" class="doc doc-heading">
+ <code>Config</code>
+
+
+<a href="#streampipes.model.resource.data_lake_measure.DataLakeMeasure.Config" class="headerlink" title="Permanent link">¶</a></h3>
+
+
+ <div class="doc doc-contents ">
+
+
+ <p>Configuration class for Pydantic.
+Defines alias generator to convert field names from camelCase (API) to snake_case (Python codebase).</p>
+
+
+
+
+ <div class="doc doc-children">
+
+
+
+
+
+
+
+
+
+
+
+ </div>
+
+ </div>
+
+
+</div>
+
<div class="doc doc-object doc-function">
@@ -2393,6 +2460,82 @@ to create a data frame from a collection of resources.</p>
</div>
+<div class="doc doc-object doc-function">
+
+
+
+<h3 id="streampipes.model.resource.data_lake_measure.DataLakeMeasure.to_dict" class="doc doc-heading">
+ <code class="highlight language-python"><span class="n">to_dict</span><span class="p">(</span><span class="n">use_source_names</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span></code>
+
+<a href="#streampipes.model.resource.data_lake_measure.DataLakeMeasure.to_dict" class="headerlink" title="Permanent link">¶</a></h3>
+
+
+ <div class="doc doc-contents ">
+
+ <p>Returns the resource in dictionary representation.</p>
+
+
+
+ <table>
+ <thead>
+ <tr>
+ <th><b>PARAMETER</b></th>
+ <th><b> DESCRIPTION</b></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><code>use_source_names</code></td>
+ <td class="doc-param-details">
+ <div class="doc-md-description">
+ <p>Indicates if the dictionary keys are in python representation or
+equally named to the StreamPipes backend</p>
+ </div>
+ <p>
+ <span class="doc-param-default">
+ <b>DEFAULT:</b>
+ <code>True</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>resource</code>
+ </td>
+ <td class="doc-returns-details">
+ <div class="doc-md-description">
+ <p>The resource as dictionary representation</p>
+ </div>
+ <p>
+ <span class="doc-returns-annotation">
+ <b>TYPE:</b>
+ <code><span title="typing.Dict">Dict</span>[str, Any]</code>
+ </span>
+ </p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+
+ </div>
+
+</div>
+
+
</div>
diff --git a/docs-python/dev/reference/model/resource/data_series/index.html b/docs-python/dev/reference/model/resource/data_series/index.html
index c26696d1b..9952f211f 100644
--- a/docs-python/dev/reference/model/resource/data_series/index.html
+++ b/docs-python/dev/reference/model/resource/data_series/index.html
@@ -2051,6 +2051,13 @@
<nav class="md-nav" aria-label="DataSeries">
<ul class="md-nav__list">
+ <li class="md-nav__item">
+ <a href="#streampipes.model.resource.data_series.DataSeries.Config" class="md-nav__link">
+ Config
+ </a>
+
+</li>
+
<li class="md-nav__item">
<a href="#streampipes.model.resource.data_series.DataSeries.convert_to_pandas_representation" class="md-nav__link">
convert_to_pandas_representation
@@ -2063,6 +2070,13 @@
from_json
</a>
+</li>
+
+ <li class="md-nav__item">
+ <a href="#streampipes.model.resource.data_series.DataSeries.to_dict" class="md-nav__link">
+ to_dict
+ </a>
+
</li>
<li class="md-nav__item">
@@ -2268,6 +2282,13 @@
<nav class="md-nav" aria-label="DataSeries">
<ul class="md-nav__list">
+ <li class="md-nav__item">
+ <a href="#streampipes.model.resource.data_series.DataSeries.Config" class="md-nav__link">
+ Config
+ </a>
+
+</li>
+
<li class="md-nav__item">
<a href="#streampipes.model.resource.data_series.DataSeries.convert_to_pandas_representation" class="md-nav__link">
convert_to_pandas_representation
@@ -2280,6 +2301,13 @@
from_json
</a>
+</li>
+
+ <li class="md-nav__item">
+ <a href="#streampipes.model.resource.data_series.DataSeries.to_dict" class="md-nav__link">
+ to_dict
+ </a>
+
</li>
<li class="md-nav__item">
@@ -2372,6 +2400,45 @@ there are some inconsistencies in the StreamPipes API.
+<div class="doc doc-object doc-class">
+
+
+
+<h3 id="streampipes.model.resource.data_series.DataSeries.Config" class="doc doc-heading">
+ <code>Config</code>
+
+
+<a href="#streampipes.model.resource.data_series.DataSeries.Config" class="headerlink" title="Permanent link">¶</a></h3>
+
+
+ <div class="doc doc-contents ">
+
+
+ <p>Configuration class for Pydantic.
+Defines alias generator to convert field names from camelCase (API) to snake_case (Python codebase).</p>
+
+
+
+
+ <div class="doc doc-children">
+
+
+
+
+
+
+
+
+
+
+
+ </div>
+
+ </div>
+
+
+</div>
+
<div class="doc doc-object doc-function">
@@ -2532,6 +2599,82 @@ with the current version of the Python client.</p>
+<h3 id="streampipes.model.resource.data_series.DataSeries.to_dict" class="doc doc-heading">
+ <code class="highlight language-python"><span class="n">to_dict</span><span class="p">(</span><span class="n">use_source_names</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span></code>
+
+<a href="#streampipes.model.resource.data_series.DataSeries.to_dict" class="headerlink" title="Permanent link">¶</a></h3>
+
+
+ <div class="doc doc-contents ">
+
+ <p>Returns the resource in dictionary representation.</p>
+
+
+
+ <table>
+ <thead>
+ <tr>
+ <th><b>PARAMETER</b></th>
+ <th><b> DESCRIPTION</b></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><code>use_source_names</code></td>
+ <td class="doc-param-details">
+ <div class="doc-md-description">
+ <p>Indicates if the dictionary keys are in python representation or
+equally named to the StreamPipes backend</p>
+ </div>
+ <p>
+ <span class="doc-param-default">
+ <b>DEFAULT:</b>
+ <code>True</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>resource</code>
+ </td>
+ <td class="doc-returns-details">
+ <div class="doc-md-description">
+ <p>The resource as dictionary representation</p>
+ </div>
+ <p>
+ <span class="doc-returns-annotation">
+ <b>TYPE:</b>
+ <code><span title="typing.Dict">Dict</span>[str, Any]</code>
+ </span>
+ </p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+
+ </div>
+
+</div>
+
+
+<div class="doc doc-object doc-function">
+
+
+
<h3 id="streampipes.model.resource.data_series.DataSeries.to_pandas" class="doc doc-heading">
<code class="highlight language-python"><span class="n">to_pandas</span><span class="p">()</span></code>
diff --git a/docs-python/dev/reference/model/resource/data_stream/index.html b/docs-python/dev/reference/model/resource/data_stream/index.html
index 136bd4e07..97b169a06 100644
--- a/docs-python/dev/reference/model/resource/data_stream/index.html
+++ b/docs-python/dev/reference/model/resource/data_stream/index.html
@@ -2071,6 +2071,13 @@
<nav class="md-nav" aria-label="DataStream">
<ul class="md-nav__list">
+ <li class="md-nav__item">
+ <a href="#streampipes.model.resource.data_stream.DataStream.Config" class="md-nav__link">
+ Config
+ </a>
+
+</li>
+
<li class="md-nav__item">
<a href="#streampipes.model.resource.data_stream.DataStream.convert_to_pandas_representation" class="md-nav__link">
convert_to_pandas_representation
@@ -2261,6 +2268,13 @@
<nav class="md-nav" aria-label="DataStream">
<ul class="md-nav__list">
+ <li class="md-nav__item">
+ <a href="#streampipes.model.resource.data_stream.DataStream.Config" class="md-nav__link">
+ Config
+ </a>
+
+</li>
+
<li class="md-nav__item">
<a href="#streampipes.model.resource.data_stream.DataStream.convert_to_pandas_representation" class="md-nav__link">
convert_to_pandas_representation
@@ -2351,6 +2365,45 @@ the Python representation (both serialized and deserialized) and Java representa
+<div class="doc doc-object doc-class">
+
+
+
+<h3 id="streampipes.model.resource.data_stream.DataStream.Config" class="doc doc-heading">
+ <code>Config</code>
+
+
+<a href="#streampipes.model.resource.data_stream.DataStream.Config" class="headerlink" title="Permanent link">¶</a></h3>
+
+
+ <div class="doc doc-contents ">
+
+
+ <p>Configuration class for Pydantic.
+Defines alias generator to convert field names from camelCase (API) to snake_case (Python codebase).</p>
+
+
+
+
+ <div class="doc doc-children">
+
+
+
+
+
+
+
+
+
+
+
+ </div>
+
+ </div>
+
+
+</div>
+
<div class="doc doc-object doc-function">
diff --git a/docs-python/dev/reference/model/resource/function_definition/index.html b/docs-python/dev/reference/model/resource/function_definition/index.html
index 7aa8a2fcc..87c292b6c 100644
--- a/docs-python/dev/reference/model/resource/function_definition/index.html
+++ b/docs-python/dev/reference/model/resource/function_definition/index.html
@@ -2111,6 +2111,13 @@
<nav class="md-nav" aria-label="FunctionDefinition">
<ul class="md-nav__list">
+ <li class="md-nav__item">
+ <a href="#streampipes.model.resource.function_definition.FunctionDefinition.Config" class="md-nav__link">
+ Config
+ </a>
+
+</li>
+
<li class="md-nav__item">
<a href="#streampipes.model.resource.function_definition.FunctionDefinition.add_output_data_stream" class="md-nav__link">
add_output_data_stream
@@ -2137,6 +2144,13 @@
get_output_stream_ids
</a>
+</li>
+
+ <li class="md-nav__item">
+ <a href="#streampipes.model.resource.function_definition.FunctionDefinition.to_dict" class="md-nav__link">
+ to_dict
+ </a>
+
</li>
</ul>
@@ -2149,6 +2163,19 @@
FunctionId
</a>
+ <nav class="md-nav" aria-label="FunctionId">
+ <ul class="md-nav__list">
+
+ <li class="md-nav__item">
+ <a href="#streampipes.model.resource.function_definition.FunctionId.Config" class="md-nav__link">
+ Config
+ </a>
+
+</li>
+
+ </ul>
+ </nav>
+
</li>
</ul>
@@ -2282,6 +2309,13 @@
<nav class="md-nav" aria-label="FunctionDefinition">
<ul class="md-nav__list">
+ <li class="md-nav__item">
+ <a href="#streampipes.model.resource.function_definition.FunctionDefinition.Config" class="md-nav__link">
+ Config
+ </a>
+
+</li>
+
<li class="md-nav__item">
<a href="#streampipes.model.resource.function_definition.FunctionDefinition.add_output_data_stream" class="md-nav__link">
add_output_data_stream
@@ -2308,6 +2342,13 @@
get_output_stream_ids
</a>
+</li>
+
+ <li class="md-nav__item">
+ <a href="#streampipes.model.resource.function_definition.FunctionDefinition.to_dict" class="md-nav__link">
+ to_dict
+ </a>
+
</li>
</ul>
@@ -2320,6 +2361,19 @@
FunctionId
</a>
+ <nav class="md-nav" aria-label="FunctionId">
+ <ul class="md-nav__list">
+
+ <li class="md-nav__item">
+ <a href="#streampipes.model.resource.function_definition.FunctionId.Config" class="md-nav__link">
+ Config
+ </a>
+
+</li>
+
+ </ul>
+ </nav>
+
</li>
</ul>
@@ -2385,44 +2439,39 @@ It contains all metadata that are required to register a function at the StreamP
<table>
<thead>
<tr>
- <th><b>PARAMETER</b></th>
- <th><b> DESCRIPTION</b></th>
+ <th><b>ATTRIBUTE</b></th>
+ <th><b>DESCRIPTION</b></th>
</tr>
</thead>
<tbody>
<tr>
- <td><code>consumed_streams</code></td>
- <td class="doc-param-details">
+ <td><code><span title="streampipes.model.resource.function_definition.FunctionDefinition.consumed_streams">consumed_streams</span></code></td>
+ <td class="doc-attribute-details">
<div class="doc-md-description">
<p>List of data streams the function is consuming from</p>
</div>
<p>
+ <span class="doc-attribute-annotation">
+ <b>TYPE:</b>
+ <code><span title="typing.List">List</span>[str]</code>
+ </span>
</p>
</td>
</tr>
<tr>
- <td><code>function_id</code></td>
- <td class="doc-param-details">
+ <td><code><span title="streampipes.model.resource.function_definition.FunctionDefinition.function_id">function_id</span></code></td>
+ <td class="doc-attribute-details">
<div class="doc-md-description">
<p>identifier object of a StreamPipes function</p>
</div>
<p>
+ <span class="doc-attribute-annotation">
+ <b>TYPE:</b>
+ <code><a class="autorefs autorefs-internal" title="streampipes.model.resource.function_definition.FunctionId" href="#streampipes.model.resource.function_definition.FunctionId">FunctionId</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><span title="streampipes.model.resource.function_definition.FunctionDefinition.output_data_streams">output_data_streams</span></code></td>
<td class="doc-attribute-details">
@@ -2452,6 +2501,45 @@ It contains all metadata that are required to register a function at the StreamP
+<div class="doc doc-object doc-class">
+
+
+
+<h3 id="streampipes.model.resource.function_definition.FunctionDefinition.Config" class="doc doc-heading">
+ <code>Config</code>
+
+
+<a href="#streampipes.model.resource.function_definition.FunctionDefinition.Config" class="headerlink" title="Permanent link">¶</a></h3>
+
+
+ <div class="doc doc-contents ">
+
+
+ <p>Configuration class for Pydantic.
+Defines alias generator to convert field names from camelCase (API) to snake_case (Python codebase).</p>
+
+
+
+
+ <div class="doc doc-children">
+
+
+
+
+
+
+
+
+
+
+
+ </div>
+
+ </div>
+
+
+</div>
+
<div class="doc doc-object doc-function">
@@ -2675,6 +2763,82 @@ to create a data frame from a collection of resources.</p>
</div>
+<div class="doc doc-object doc-function">
+
+
+
+<h3 id="streampipes.model.resource.function_definition.FunctionDefinition.to_dict" class="doc doc-heading">
+ <code class="highlight language-python"><span class="n">to_dict</span><span class="p">(</span><span class="n">use_source_names</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span></code>
+
+<a href="#streampipes.model.resource.function_definition.FunctionDefinition.to_dict" class="headerlink" title="Permanent link">¶</a></h3>
+
+
+ <div class="doc doc-contents ">
+
+ <p>Returns the resource in dictionary representation.</p>
+
+
+
+ <table>
+ <thead>
+ <tr>
+ <th><b>PARAMETER</b></th>
+ <th><b> DESCRIPTION</b></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><code>use_source_names</code></td>
+ <td class="doc-param-details">
+ <div class="doc-md-description">
+ <p>Indicates if the dictionary keys are in python representation or
+equally named to the StreamPipes backend</p>
+ </div>
+ <p>
+ <span class="doc-param-default">
+ <b>DEFAULT:</b>
+ <code>True</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>resource</code>
+ </td>
+ <td class="doc-returns-details">
+ <div class="doc-md-description">
+ <p>The resource as dictionary representation</p>
+ </div>
+ <p>
+ <span class="doc-returns-annotation">
+ <b>TYPE:</b>
+ <code><span title="typing.Dict">Dict</span>[str, Any]</code>
+ </span>
+ </p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+
+ </div>
+
+</div>
+
+
</div>
@@ -2707,28 +2871,36 @@ to create a data frame from a collection of resources.</p>
<table>
<thead>
<tr>
- <th><b>PARAMETER</b></th>
- <th><b> DESCRIPTION</b></th>
+ <th><b>ATTRIBUTE</b></th>
+ <th><b>DESCRIPTION</b></th>
</tr>
</thead>
<tbody>
<tr>
- <td><code>id</code></td>
- <td class="doc-param-details">
+ <td><code><span title="streampipes.model.resource.function_definition.FunctionId.id">id</span></code></td>
+ <td class="doc-attribute-details">
<div class="doc-md-description">
<p>unique identifier of the function instance</p>
</div>
<p>
+ <span class="doc-attribute-annotation">
+ <b>TYPE:</b>
+ <code>str</code>
+ </span>
</p>
</td>
</tr>
<tr>
- <td><code>version</code></td>
- <td class="doc-param-details">
+ <td><code><span title="streampipes.model.resource.function_definition.FunctionId.version">version</span></code></td>
+ <td class="doc-attribute-details">
<div class="doc-md-description">
<p>version of the corresponding function</p>
</div>
<p>
+ <span class="doc-attribute-annotation">
+ <b>TYPE:</b>
+ <code>int</code>
+ </span>
</p>
</td>
</tr>
@@ -2747,6 +2919,45 @@ to create a data frame from a collection of resources.</p>
+<div class="doc doc-object doc-class">
+
+
+
+<h3 id="streampipes.model.resource.function_definition.FunctionId.Config" class="doc doc-heading">
+ <code>Config</code>
+
+
+<a href="#streampipes.model.resource.function_definition.FunctionId.Config" class="headerlink" title="Permanent link">¶</a></h3>
+
+
+ <div class="doc doc-contents ">
+
+
+ <p>Configuration class for Pydantic.
+Defines alias generator to convert field names from camelCase (API) to snake_case (Python codebase).</p>
+
+
+
+
+ <div class="doc doc-children">
+
+
+
+
+
+
+
+
+
+
+
+ </div>
+
+ </div>
+
+
+</div>
+
diff --git a/docs-python/dev/reference/model/resource/query_result/index.html b/docs-python/dev/reference/model/resource/query_result/index.html
index 1c6b363a9..a1b1e67dd 100644
--- a/docs-python/dev/reference/model/resource/query_result/index.html
+++ b/docs-python/dev/reference/model/resource/query_result/index.html
@@ -2131,11 +2131,25 @@
<nav class="md-nav" aria-label="QueryResult">
<ul class="md-nav__list">
+ <li class="md-nav__item">
+ <a href="#streampipes.model.resource.query_result.QueryResult.Config" class="md-nav__link">
+ Config
+ </a>
+
+</li>
+
<li class="md-nav__item">
<a href="#streampipes.model.resource.query_result.QueryResult.convert_to_pandas_representation" class="md-nav__link">
convert_to_pandas_representation
</a>
+</li>
+
+ <li class="md-nav__item">
+ <a href="#streampipes.model.resource.query_result.QueryResult.to_dict" class="md-nav__link">
+ to_dict
+ </a>
+
</li>
<li class="md-nav__item">
@@ -2261,11 +2275,25 @@
<nav class="md-nav" aria-label="QueryResult">
<ul class="md-nav__list">
+ <li class="md-nav__item">
+ <a href="#streampipes.model.resource.query_result.QueryResult.Config" class="md-nav__link">
+ Config
+ </a>
+
+</li>
+
<li class="md-nav__item">
<a href="#streampipes.model.resource.query_result.QueryResult.convert_to_pandas_representation" class="md-nav__link">
convert_to_pandas_representation
</a>
+</li>
+
+ <li class="md-nav__item">
+ <a href="#streampipes.model.resource.query_result.QueryResult.to_dict" class="md-nav__link">
+ to_dict
+ </a>
+
</li>
<li class="md-nav__item">
@@ -2352,6 +2380,45 @@ the Python representation (both serialized and deserialized) and Java representa
+<div class="doc doc-object doc-class">
+
+
+
+<h3 id="streampipes.model.resource.query_result.QueryResult.Config" class="doc doc-heading">
+ <code>Config</code>
+
+
+<a href="#streampipes.model.resource.query_result.QueryResult.Config" class="headerlink" title="Permanent link">¶</a></h3>
+
+
+ <div class="doc doc-contents ">
+
+
+ <p>Configuration class for Pydantic.
+Defines alias generator to convert field names from camelCase (API) to snake_case (Python codebase).</p>
+
+
+
+
+ <div class="doc doc-children">
+
+
+
+
+
+
+
+
+
+
+
+ </div>
+
+ </div>
+
+
+</div>
+
<div class="doc doc-object doc-function">
@@ -2429,6 +2496,82 @@ to be used when creating a pandas Dataframe.</p>
+<h3 id="streampipes.model.resource.query_result.QueryResult.to_dict" class="doc doc-heading">
+ <code class="highlight language-python"><span class="n">to_dict</span><span class="p">(</span><span class="n">use_source_names</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span></code>
+
+<a href="#streampipes.model.resource.query_result.QueryResult.to_dict" class="headerlink" title="Permanent link">¶</a></h3>
+
+
+ <div class="doc doc-contents ">
+
+ <p>Returns the resource in dictionary representation.</p>
+
+
+
+ <table>
+ <thead>
+ <tr>
+ <th><b>PARAMETER</b></th>
+ <th><b> DESCRIPTION</b></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><code>use_source_names</code></td>
+ <td class="doc-param-details">
+ <div class="doc-md-description">
+ <p>Indicates if the dictionary keys are in python representation or
+equally named to the StreamPipes backend</p>
+ </div>
+ <p>
+ <span class="doc-param-default">
+ <b>DEFAULT:</b>
+ <code>True</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>resource</code>
+ </td>
+ <td class="doc-returns-details">
+ <div class="doc-md-description">
+ <p>The resource as dictionary representation</p>
+ </div>
+ <p>
+ <span class="doc-returns-annotation">
+ <b>TYPE:</b>
+ <code><span title="typing.Dict">Dict</span>[str, Any]</code>
+ </span>
+ </p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+
+ </div>
+
+</div>
+
+
+<div class="doc doc-object doc-function">
+
+
+
<h3 id="streampipes.model.resource.query_result.QueryResult.to_pandas" class="doc doc-heading">
<code class="highlight language-python"><span class="n">to_pandas</span><span class="p">()</span></code>
diff --git a/docs-python/dev/reference/model/resource/resource/index.html b/docs-python/dev/reference/model/resource/resource/index.html
index 5aa152460..40ada5190 100644
--- a/docs-python/dev/reference/model/resource/resource/index.html
+++ b/docs-python/dev/reference/model/resource/resource/index.html
@@ -2151,6 +2151,13 @@
<nav class="md-nav" aria-label="Resource">
<ul class="md-nav__list">
+ <li class="md-nav__item">
+ <a href="#streampipes.model.resource.resource.Resource.Config" class="md-nav__link">
+ Config
+ </a>
+
+</li>
+
<li class="md-nav__item">
<a href="#streampipes.model.resource.resource.Resource.convert_to_pandas_representation" class="md-nav__link">
convert_to_pandas_representation
@@ -2261,6 +2268,13 @@
<nav class="md-nav" aria-label="Resource">
<ul class="md-nav__list">
+ <li class="md-nav__item">
+ <a href="#streampipes.model.resource.resource.Resource.Config" class="md-nav__link">
+ Config
+ </a>
+
+</li>
+
<li class="md-nav__item">
<a href="#streampipes.model.resource.resource.Resource.convert_to_pandas_representation" class="md-nav__link">
convert_to_pandas_representation
@@ -2355,6 +2369,45 @@ the Python representation (both serialized and deserialized) and Java representa
+<div class="doc doc-object doc-class">
+
+
+
+<h3 id="streampipes.model.resource.resource.Resource.Config" class="doc doc-heading">
+ <code>Config</code>
+
+
+<a href="#streampipes.model.resource.resource.Resource.Config" class="headerlink" title="Permanent link">¶</a></h3>
+
+
+ <div class="doc doc-contents ">
+
+
+ <p>Configuration class for Pydantic.
+Defines alias generator to convert field names from camelCase (API) to snake_case (Python codebase).</p>
+
+
+
+
+ <div class="doc doc-children">
+
+
+
+
+
+
+
+
+
+
+
+ </div>
+
+ </div>
+
+
+</div>
+
<div class="doc doc-object doc-function">
diff --git a/docs-python/dev/reference/model/resource/version/index.html b/docs-python/dev/reference/model/resource/version/index.html
index afd97cf9f..4a3b2f58f 100644
--- a/docs-python/dev/reference/model/resource/version/index.html
+++ b/docs-python/dev/reference/model/resource/version/index.html
@@ -2169,11 +2169,25 @@
<nav class="md-nav" aria-label="Version">
<ul class="md-nav__list">
+ <li class="md-nav__item">
+ <a href="#streampipes.model.resource.version.Version.Config" class="md-nav__link">
+ Config
+ </a>
+
+</li>
+
<li class="md-nav__item">
<a href="#streampipes.model.resource.version.Version.convert_to_pandas_representation" class="md-nav__link">
convert_to_pandas_representation
</a>
+</li>
+
+ <li class="md-nav__item">
+ <a href="#streampipes.model.resource.version.Version.to_dict" class="md-nav__link">
+ to_dict
+ </a>
+
</li>
<li class="md-nav__item">
@@ -2259,11 +2273,25 @@
<nav class="md-nav" aria-label="Version">
<ul class="md-nav__list">
+ <li class="md-nav__item">
+ <a href="#streampipes.model.resource.version.Version.Config" class="md-nav__link">
+ Config
+ </a>
+
+</li>
+
<li class="md-nav__item">
<a href="#streampipes.model.resource.version.Version.convert_to_pandas_representation" class="md-nav__link">
convert_to_pandas_representation
</a>
+</li>
+
+ <li class="md-nav__item">
+ <a href="#streampipes.model.resource.version.Version.to_dict" class="md-nav__link">
+ to_dict
+ </a>
+
</li>
<li class="md-nav__item">
@@ -2373,6 +2401,45 @@
+<div class="doc doc-object doc-class">
+
+
+
+<h3 id="streampipes.model.resource.version.Version.Config" class="doc doc-heading">
+ <code>Config</code>
+
+
+<a href="#streampipes.model.resource.version.Version.Config" class="headerlink" title="Permanent link">¶</a></h3>
+
+
+ <div class="doc doc-contents ">
+
+
+ <p>Configuration class for Pydantic.
+Defines alias generator to convert field names from camelCase (API) to snake_case (Python codebase).</p>
+
+
+
+
+ <div class="doc doc-children">
+
+
+
+
+
+
+
+
+
+
+
+ </div>
+
+ </div>
+
+
+</div>
+
<div class="doc doc-object doc-function">
@@ -2399,6 +2466,82 @@ to be used when creating a pandas Dataframe.</p>
+<h3 id="streampipes.model.resource.version.Version.to_dict" class="doc doc-heading">
+ <code class="highlight language-python"><span class="n">to_dict</span><span class="p">(</span><span class="n">use_source_names</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span></code>
+
+<a href="#streampipes.model.resource.version.Version.to_dict" class="headerlink" title="Permanent link">¶</a></h3>
+
+
+ <div class="doc doc-contents ">
+
+ <p>Returns the resource in dictionary representation.</p>
+
+
+
+ <table>
+ <thead>
+ <tr>
+ <th><b>PARAMETER</b></th>
+ <th><b> DESCRIPTION</b></th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><code>use_source_names</code></td>
+ <td class="doc-param-details">
+ <div class="doc-md-description">
+ <p>Indicates if the dictionary keys are in python representation or
+equally named to the StreamPipes backend</p>
+ </div>
+ <p>
+ <span class="doc-param-default">
+ <b>DEFAULT:</b>
+ <code>True</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>resource</code>
+ </td>
+ <td class="doc-returns-details">
+ <div class="doc-md-description">
+ <p>The resource as dictionary representation</p>
+ </div>
+ <p>
+ <span class="doc-returns-annotation">
+ <b>TYPE:</b>
+ <code><span title="typing.Dict">Dict</span>[str, Any]</code>
+ </span>
+ </p>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+
+ </div>
+
+</div>
+
+
+<div class="doc doc-object doc-function">
+
+
+
<h3 id="streampipes.model.resource.version.Version.validate_backend_version" class="doc doc-heading">
<code class="highlight language-python"><span class="n">validate_backend_version</span><span class="p">(</span><span class="n">backend_version</span><span class="p">)</span></code>
diff --git a/docs-python/dev/search/search_index.json b/docs-python/dev/search/search_index.json
index 2ac931609..1ab6b6cb4 100644
--- a/docs-python/dev/search/search_index.json
+++ b/docs-python/dev/search/search_index.json
@@ -1 +1 @@
-{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"","title":"\ud83c\udfe1 Home","text":"StreamPipes is a self-service (Industrial) IoT toolbox to enable non-technical users to connect, analyze and explore IoT data streams. Apache StreamPipes for Python \ud83d\udc0d <p> Apache StreamPipes meets Python! We are working highly motivated on a Python library to interact with StreamPipes. In this way, we would like to unite the power of StreamP [...]
\ No newline at end of file
+{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"","title":"\ud83c\udfe1 Home","text":"StreamPipes is a self-service (Industrial) IoT toolbox to enable non-technical users to connect, analyze and explore IoT data streams. Apache StreamPipes for Python \ud83d\udc0d <p> Apache StreamPipes meets Python! We are working highly motivated on a Python library to interact with StreamPipes. In this way, we would like to unite the power of StreamP [...]
\ No newline at end of file
diff --git a/docs-python/dev/sitemap.xml b/docs-python/dev/sitemap.xml
index afd08e259..3438035a1 100644
--- a/docs-python/dev/sitemap.xml
+++ b/docs-python/dev/sitemap.xml
@@ -2,247 +2,242 @@
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/</loc>
- <lastmod>2024-05-11</lastmod>
+ <lastmod>2024-05-18</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/getting-started/developing/</loc>
- <lastmod>2024-05-11</lastmod>
+ <lastmod>2024-05-18</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/getting-started/first-steps/</loc>
- <lastmod>2024-05-11</lastmod>
+ <lastmod>2024-05-18</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/getting-started/quickstart/</loc>
- <lastmod>2024-05-11</lastmod>
+ <lastmod>2024-05-18</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/reference/client/client/</loc>
- <lastmod>2024-05-11</lastmod>
+ <lastmod>2024-05-18</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/reference/client/config/</loc>
- <lastmod>2024-05-11</lastmod>
+ <lastmod>2024-05-18</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/reference/client/credential_provider/</loc>
- <lastmod>2024-05-11</lastmod>
+ <lastmod>2024-05-18</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/reference/endpoint/endpoint/</loc>
- <lastmod>2024-05-11</lastmod>
+ <lastmod>2024-05-18</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/reference/endpoint/exceptions/</loc>
- <lastmod>2024-05-11</lastmod>
+ <lastmod>2024-05-18</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/reference/endpoint/api/data_lake_measure/</loc>
- <lastmod>2024-05-11</lastmod>
+ <lastmod>2024-05-18</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/reference/endpoint/api/data_stream/</loc>
- <lastmod>2024-05-11</lastmod>
+ <lastmod>2024-05-18</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/reference/endpoint/api/version/</loc>
- <lastmod>2024-05-11</lastmod>
+ <lastmod>2024-05-18</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/reference/function_zoo/river_function/</loc>
- <lastmod>2024-05-11</lastmod>
+ <lastmod>2024-05-18</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/reference/functions/function_handler/</loc>
- <lastmod>2024-05-11</lastmod>
+ <lastmod>2024-05-18</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/reference/functions/registration/</loc>
- <lastmod>2024-05-11</lastmod>
+ <lastmod>2024-05-18</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/reference/functions/streampipes_function/</loc>
- <lastmod>2024-05-11</lastmod>
+ <lastmod>2024-05-18</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/reference/functions/broker/broker/</loc>
- <lastmod>2024-05-11</lastmod>
+ <lastmod>2024-05-18</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/reference/functions/broker/broker_handler/</loc>
- <lastmod>2024-05-11</lastmod>
+ <lastmod>2024-05-18</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/reference/functions/broker/consumer/</loc>
- <lastmod>2024-05-11</lastmod>
+ <lastmod>2024-05-18</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/reference/functions/broker/output_collector/</loc>
- <lastmod>2024-05-11</lastmod>
+ <lastmod>2024-05-18</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/reference/functions/broker/publisher/</loc>
- <lastmod>2024-05-11</lastmod>
+ <lastmod>2024-05-18</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/reference/functions/broker/kafka/kafka_consumer/</loc>
- <lastmod>2024-05-11</lastmod>
+ <lastmod>2024-05-18</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/reference/functions/broker/kafka/kafka_message_fetcher/</loc>
- <lastmod>2024-05-11</lastmod>
+ <lastmod>2024-05-18</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/reference/functions/broker/kafka/kafka_publisher/</loc>
- <lastmod>2024-05-11</lastmod>
+ <lastmod>2024-05-18</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/reference/functions/broker/nats/nats_consumer/</loc>
- <lastmod>2024-05-11</lastmod>
+ <lastmod>2024-05-18</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/reference/functions/broker/nats/nats_publisher/</loc>
- <lastmod>2024-05-11</lastmod>
+ <lastmod>2024-05-18</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/reference/functions/utils/async_iter_handler/</loc>
- <lastmod>2024-05-11</lastmod>
+ <lastmod>2024-05-18</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/reference/functions/utils/data_stream_context/</loc>
- <lastmod>2024-05-11</lastmod>
+ <lastmod>2024-05-18</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/reference/functions/utils/data_stream_generator/</loc>
- <lastmod>2024-05-11</lastmod>
+ <lastmod>2024-05-18</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/reference/functions/utils/function_context/</loc>
- <lastmod>2024-05-11</lastmod>
+ <lastmod>2024-05-18</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/reference/model/common/</loc>
- <lastmod>2024-05-11</lastmod>
+ <lastmod>2024-05-18</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/reference/model/container/data_lake_measures/</loc>
- <lastmod>2024-05-11</lastmod>
+ <lastmod>2024-05-18</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/reference/model/container/data_streams/</loc>
- <lastmod>2024-05-11</lastmod>
+ <lastmod>2024-05-18</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/reference/model/container/resource_container/</loc>
- <lastmod>2024-05-11</lastmod>
+ <lastmod>2024-05-18</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/reference/model/container/versions/</loc>
- <lastmod>2024-05-11</lastmod>
+ <lastmod>2024-05-18</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/reference/model/resource/data_lake_measure/</loc>
- <lastmod>2024-05-11</lastmod>
+ <lastmod>2024-05-18</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/reference/model/resource/data_series/</loc>
- <lastmod>2024-05-11</lastmod>
+ <lastmod>2024-05-18</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/reference/model/resource/data_stream/</loc>
- <lastmod>2024-05-11</lastmod>
+ <lastmod>2024-05-18</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/reference/model/resource/exceptions/</loc>
- <lastmod>2024-05-11</lastmod>
+ <lastmod>2024-05-18</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/reference/model/resource/function_definition/</loc>
- <lastmod>2024-05-11</lastmod>
+ <lastmod>2024-05-18</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/reference/model/resource/query_result/</loc>
- <lastmod>2024-05-11</lastmod>
+ <lastmod>2024-05-18</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/reference/model/resource/resource/</loc>
- <lastmod>2024-05-11</lastmod>
+ <lastmod>2024-05-18</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/reference/model/resource/version/</loc>
- <lastmod>2024-05-11</lastmod>
- <changefreq>daily</changefreq>
- </url>
- <url>
- <loc>https://streampipes.apache.org/docs/docs/python/latest/latest/scripts/gen_ref_pages/</loc>
- <lastmod>2024-05-11</lastmod>
+ <lastmod>2024-05-18</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/tutorials/1-introduction-to-streampipes-python-client/</loc>
- <lastmod>2024-05-11</lastmod>
+ <lastmod>2024-05-18</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/tutorials/2-extracting-data-from-the-streampipes-data-lake/</loc>
- <lastmod>2024-05-11</lastmod>
+ <lastmod>2024-05-18</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/tutorials/3-getting-live-data-from-the-streampipes-data-stream/</loc>
- <lastmod>2024-05-11</lastmod>
+ <lastmod>2024-05-18</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/tutorials/4-using-online-machine-learning-on-a-streampipes-data-stream/</loc>
- <lastmod>2024-05-11</lastmod>
+ <lastmod>2024-05-18</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://streampipes.apache.org/docs/docs/python/latest/latest/tutorials/5-applying-interoperable-machine-learning-in-streampipes/</loc>
- <lastmod>2024-05-11</lastmod>
+ <lastmod>2024-05-18</lastmod>
<changefreq>daily</changefreq>
</url>
</urlset>
\ No newline at end of file
diff --git a/docs-python/dev/sitemap.xml.gz b/docs-python/dev/sitemap.xml.gz
index 2ad3eb5c8..304694a01 100644
Binary files a/docs-python/dev/sitemap.xml.gz and b/docs-python/dev/sitemap.xml.gz differ