Add documentation for packages - 2024-10-27

docs-archive/apache-airflow-providers-airbyte/4.0.0/.buildinfo

@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: a939d71873c293aaab6e8eb0c108e528
+config: 8d9eb13f6bdcda1470dee79ed84aef8c
 tags: 645f666f9bcd5a90fca523b33c5a78b7

docs-archive/apache-airflow-providers-airbyte/4.0.0/_api/airflow/providers/airbyte/hooks/airbyte/index.html

@@ -654,7 +654,7 @@ <h3>Attributes<a class="headerlink" href="#attributes" title="Permalink to this
 <dl class="py class">
 <dt class="sig sig-object py" id="airflow.providers.airbyte.hooks.airbyte.AirbyteHook">
 <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">airflow.providers.airbyte.hooks.airbyte.</span></span><span class="sig-name descname"><span class="pre">AirbyteHook</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">airbyte_conn_id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'airbyte_default'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">api_version</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'v1'</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../../_modules/airflow/providers/airbyte/hooks/airbyte.html#AirbyteHook"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#airflow.providers.airbyte.hooks.airbyte.AirbyteHook" title="Permalink to this definition">¶</a></dt>
-<dd><p>Bases: <a class="reference external" href="/docs/apache-airflow/stable/_api/airflow/hooks/base/index.html#airflow.hooks.base.BaseHook" title="(in apache-airflow v2.10.0.dev0)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">airflow.hooks.base.BaseHook</span></code></a></p>
+<dd><p>Bases: <a class="reference external" href="/docs/apache-airflow/stable/_api/airflow/hooks/base/index.html#airflow.hooks.base.BaseHook" title="(in apache-airflow v3.0.0.dev0)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">airflow.hooks.base.BaseHook</span></code></a></p>
 <p>Hook for Airbyte API.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters</dt>

docs-archive/apache-airflow-providers-airbyte/4.0.0/_api/airflow/providers/airbyte/sensors/airbyte/index.html

@@ -636,7 +636,7 @@ <h3>Classes<a class="headerlink" href="#classes" title="Permalink to this headin
 <dl class="py class">
 <dt class="sig sig-object py" id="airflow.providers.airbyte.sensors.airbyte.AirbyteJobSensor">
 <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">airflow.providers.airbyte.sensors.airbyte.</span></span><span class="sig-name descname"><span class="pre">AirbyteJobSensor</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">airbyte_job_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">deferrable</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">conf.getboolean('operators',</span> <span class="pre">'default_deferrable',</span> <span class="pre">fallback=False)</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">airbyte_conn_id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'airbyte_default'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">api_version</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'v1'</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../../_modules/airflow/providers/airbyte/sensors/airbyte.html#AirbyteJobSensor"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#airflow.providers.airbyte.sensors.airbyte.AirbyteJobSensor" title="Permalink to this definition">¶</a></dt>
-<dd><p>Bases: <a class="reference external" href="/docs/apache-airflow/stable/_api/airflow/sensors/base/index.html#airflow.sensors.base.BaseSensorOperator" title="(in apache-airflow v2.10.0.dev0)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">airflow.sensors.base.BaseSensorOperator</span></code></a></p>
+<dd><p>Bases: <a class="reference external" href="/docs/apache-airflow/stable/_api/airflow/sensors/base/index.html#airflow.sensors.base.BaseSensorOperator" title="(in apache-airflow v3.0.0.dev0)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">airflow.sensors.base.BaseSensorOperator</span></code></a></p>
 <p>Check for the state of a previously submitted Airbyte job.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters</dt>

docs-archive/apache-airflow-providers-airbyte/4.0.0/_api/airflow/providers/airbyte/triggers/airbyte/index.html

@@ -635,7 +635,7 @@ <h3>Classes<a class="headerlink" href="#classes" title="Permalink to this headin
 <dl class="py class">
 <dt class="sig sig-object py" id="airflow.providers.airbyte.triggers.airbyte.AirbyteSyncTrigger">
 <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">airflow.providers.airbyte.triggers.airbyte.</span></span><span class="sig-name descname"><span class="pre">AirbyteSyncTrigger</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">job_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">conn_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">end_time</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">poll_interval</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../../_modules/airflow/providers/airbyte/triggers/airbyte.html#AirbyteSyncTrigger"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#airflow.providers.airbyte.triggers.airbyte.AirbyteSyncTrigger" title="Permalink to this definition">¶</a></dt>
-<dd><p>Bases: <a class="reference external" href="/docs/apache-airflow/stable/_api/airflow/triggers/base/index.html#airflow.triggers.base.BaseTrigger" title="(in apache-airflow v2.10.0.dev0)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">airflow.triggers.base.BaseTrigger</span></code></a></p>
+<dd><p>Bases: <a class="reference external" href="/docs/apache-airflow/stable/_api/airflow/triggers/base/index.html#airflow.triggers.base.BaseTrigger" title="(in apache-airflow v3.0.0.dev0)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">airflow.triggers.base.BaseTrigger</span></code></a></p>
 <p>Triggers Airbyte Sync, makes an asynchronous HTTP call to get the status via a job ID.</p>
 <p>This trigger is designed to initiate and monitor the status of Airbyte Sync jobs. It
 makes use of asynchronous communication to check the progress of a job run over time.</p>

docs-archive/apache-airflow-providers-airbyte/4.0.0/_modules/tests/system/airbyte/example_airbyte_trigger_job.html

@@ -675,7 +675,7 @@ <h1>Source code for tests.system.airbyte.example_airbyte_trigger_job</h1><div cl
     <span class="c1"># Task dependency created via `XComArgs`:</span>
     <span class="c1">#   async_source_destination &gt;&gt; airbyte_sensor</span>
 
-<span class="kn">from</span> <span class="nn">dev.tests_common.test_utils.system_tests</span> <span class="kn">import</span> <span class="n">get_test_run</span>  <span class="c1"># noqa: E402</span>
+<span class="kn">from</span> <span class="nn">tests_common.test_utils.system_tests</span> <span class="kn">import</span> <span class="n">get_test_run</span>  <span class="c1"># noqa: E402</span>
 
 <span class="c1"># Needed to run the example DAG with pytest (see: tests/system/README.md#run_via_pytest)</span>
 <div class="viewcode-block" id="test_run"><a class="viewcode-back" href="../../../../_api/tests/system/airbyte/example_airbyte_trigger_job/index.html#tests.system.airbyte.example_airbyte_trigger_job.test_run">[docs]</a><span class="n">test_run</span> <span class="o">=</span> <span class="n">get_test_run</span><span class="p">(</span><span class="n">dag</span><span class="p">)</span></div>

docs-archive/apache-airflow-providers-airbyte/4.0.0/security.html

@@ -619,7 +619,7 @@
 <h1>Releasing security patches<a class="headerlink" href="#releasing-security-patches" title="Permalink to this heading">¶</a></h1>
 <p>Airflow providers are released independently from Airflow itself and the information about vulnerabilities
 is published separately. You can upgrade providers independently from Airflow itself, following the
-instructions found in <a class="reference external" href="/docs/apache-airflow/stable/installation/installing-from-pypi.html" title="(in apache-airflow v2.10.0.dev0)"><span>Installation from PyPI</span></a>.</p>
+instructions found in <a class="reference external" href="/docs/apache-airflow/stable/installation/installing-from-pypi.html" title="(in apache-airflow v3.0.0.dev0)"><span>Installation from PyPI</span></a>.</p>
 <p>When we release Provider version, the development is always done from the <code class="docutils literal notranslate"><span class="pre">main</span></code> branch where we prepare
 the next version. The provider uses strict <a class="reference external" href="https://semver.org">SemVer</a> versioning policy. Depending on
 the scope of the change, Provider will get ‘’MAJOR’’ version upgrade when there are

docs-archive/apache-airflow-providers-alibaba/2.9.1/.buildinfo

@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 46f516852bd1ef9825c8d88e73ff69d5
+config: 45e65400749bedfe3ba6cded647b9313
 tags: 645f666f9bcd5a90fca523b33c5a78b7

docs-archive/apache-airflow-providers-alibaba/2.9.1/_api/airflow/providers/alibaba/cloud/hooks/analyticdb_spark/index.html

@@ -707,7 +707,7 @@ <h3>Classes<a class="headerlink" href="#classes" title="Permalink to this headin
 <dl class="py class">
 <dt class="sig sig-object py" id="airflow.providers.alibaba.cloud.hooks.analyticdb_spark.AnalyticDBSparkHook">
 <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">airflow.providers.alibaba.cloud.hooks.analyticdb_spark.</span></span><span class="sig-name descname"><span class="pre">AnalyticDBSparkHook</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">adb_spark_conn_id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'adb_spark_default'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">region</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../../../_modules/airflow/providers/alibaba/cloud/hooks/analyticdb_spark.html#AnalyticDBSparkHook"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#airflow.providers.alibaba.cloud.hooks.analyticdb_spark.AnalyticDBSparkHook" title="Permalink to this definition">¶</a></dt>
-<dd><p>Bases: <a class="reference external" href="/docs/apache-airflow/stable/_api/airflow/hooks/base/index.html#airflow.hooks.base.BaseHook" title="(in apache-airflow v2.10.0.dev0)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">airflow.hooks.base.BaseHook</span></code></a>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">airflow.utils.log.logging_mixin.LoggingMixin</span></code></p>
+<dd><p>Bases: <a class="reference external" href="/docs/apache-airflow/stable/_api/airflow/hooks/base/index.html#airflow.hooks.base.BaseHook" title="(in apache-airflow v3.0.0.dev0)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">airflow.hooks.base.BaseHook</span></code></a>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">airflow.utils.log.logging_mixin.LoggingMixin</span></code></p>
 <p>Hook for AnalyticDB MySQL Spark through the REST API.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters</dt>

docs-archive/apache-airflow-providers-alibaba/2.9.1/_api/airflow/providers/alibaba/cloud/hooks/oss/index.html

@@ -691,7 +691,7 @@ <h3>Attributes<a class="headerlink" href="#attributes" title="Permalink to this
 <dl class="py class">
 <dt class="sig sig-object py" id="airflow.providers.alibaba.cloud.hooks.oss.OSSHook">
 <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">airflow.providers.alibaba.cloud.hooks.oss.</span></span><span class="sig-name descname"><span class="pre">OSSHook</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">region</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">oss_conn_id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'oss_default'</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../../../_modules/airflow/providers/alibaba/cloud/hooks/oss.html#OSSHook"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#airflow.providers.alibaba.cloud.hooks.oss.OSSHook" title="Permalink to this definition">¶</a></dt>
-<dd><p>Bases: <a class="reference external" href="/docs/apache-airflow/stable/_api/airflow/hooks/base/index.html#airflow.hooks.base.BaseHook" title="(in apache-airflow v2.10.0.dev0)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">airflow.hooks.base.BaseHook</span></code></a></p>
+<dd><p>Bases: <a class="reference external" href="/docs/apache-airflow/stable/_api/airflow/hooks/base/index.html#airflow.hooks.base.BaseHook" title="(in apache-airflow v3.0.0.dev0)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">airflow.hooks.base.BaseHook</span></code></a></p>
 <p>Interact with Alibaba Cloud OSS, using the oss2 library.</p>
 <dl class="field-list simple">
 </dl>

docs-archive/apache-airflow-providers-alibaba/2.9.1/_api/airflow/providers/alibaba/cloud/sensors/analyticdb_spark/index.html

@@ -639,7 +639,7 @@ <h3>Classes<a class="headerlink" href="#classes" title="Permalink to this headin
 <dl class="py class">
 <dt class="sig sig-object py" id="airflow.providers.alibaba.cloud.sensors.analyticdb_spark.AnalyticDBSparkSensor">
 <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">airflow.providers.alibaba.cloud.sensors.analyticdb_spark.</span></span><span class="sig-name descname"><span class="pre">AnalyticDBSparkSensor</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">app_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">adb_spark_conn_id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'adb_spark_default'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">region</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../../../_modules/airflow/providers/alibaba/cloud/sensors/analyticdb_spark.html#AnalyticDBSparkSensor"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#airflow.providers.alibaba.cloud.sensors.analyticdb_spark.AnalyticDBSparkSensor" title="Permalink to this definition">¶</a></dt>
-<dd><p>Bases: <a class="reference external" href="/docs/apache-airflow/stable/_api/airflow/sensors/base/index.html#airflow.sensors.base.BaseSensorOperator" title="(in apache-airflow v2.10.0.dev0)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">airflow.sensors.base.BaseSensorOperator</span></code></a></p>
+<dd><p>Bases: <a class="reference external" href="/docs/apache-airflow/stable/_api/airflow/sensors/base/index.html#airflow.sensors.base.BaseSensorOperator" title="(in apache-airflow v3.0.0.dev0)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">airflow.sensors.base.BaseSensorOperator</span></code></a></p>
 <p>Monitor a AnalyticDB Spark session for termination.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters</dt>

docs-archive/apache-airflow-providers-alibaba/2.9.1/_api/airflow/providers/alibaba/cloud/sensors/oss_key/index.html

@@ -639,7 +639,7 @@ <h3>Classes<a class="headerlink" href="#classes" title="Permalink to this headin
 <dl class="py class">
 <dt class="sig sig-object py" id="airflow.providers.alibaba.cloud.sensors.oss_key.OSSKeySensor">
 <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">airflow.providers.alibaba.cloud.sensors.oss_key.</span></span><span class="sig-name descname"><span class="pre">OSSKeySensor</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">bucket_key</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">region</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">bucket_name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">oss_conn_id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'oss_default'</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../../../_modules/airflow/providers/alibaba/cloud/sensors/oss_key.html#OSSKeySensor"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#airflow.providers.alibaba.cloud.sensors.oss_key.OSSKeySensor" title="Permalink to this definition">¶</a></dt>
-<dd><p>Bases: <a class="reference external" href="/docs/apache-airflow/stable/_api/airflow/sensors/base/index.html#airflow.sensors.base.BaseSensorOperator" title="(in apache-airflow v2.10.0.dev0)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">airflow.sensors.base.BaseSensorOperator</span></code></a></p>
+<dd><p>Bases: <a class="reference external" href="/docs/apache-airflow/stable/_api/airflow/sensors/base/index.html#airflow.sensors.base.BaseSensorOperator" title="(in apache-airflow v3.0.0.dev0)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">airflow.sensors.base.BaseSensorOperator</span></code></a></p>
 <p>Waits for a key (a file-like instance on OSS) to be present in an OSS bucket.</p>
 <p>OSS being a key/value, it does not support folders. The path is just a key resource.</p>
 <dl class="field-list simple">