Add documentation for packages - 2022-07-13 (apache#638)

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

@@ -0,0 +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: cbaa7f1992627c92ed63955b2a438bd6
+tags: 645f666f9bcd5a90fca523b33c5a78b7

docs-archive/apache-airflow-providers-airbyte/3.1.0/_sources/_api/airflow/providers/airbyte/example_dags/example_airbyte_trigger_job/index.rst.txt

@@ -0,0 +1,19 @@
+:py:mod:`airflow.providers.airbyte.example_dags.example_airbyte_trigger_job`
+============================================================================
+
+.. py:module:: airflow.providers.airbyte.example_dags.example_airbyte_trigger_job
+
+.. autoapi-nested-parse::
+
+   Example DAG demonstrating the usage of the AirbyteTriggerSyncOperator.
+
+
+
+Module Contents
+---------------
+
+.. py:data:: sync_source_destination
+   
+
+   
+

docs-archive/apache-airflow-providers-airbyte/3.1.0/_sources/_api/airflow/providers/airbyte/example_dags/index.rst.txt

@@ -0,0 +1,15 @@
+:py:mod:`airflow.providers.airbyte.example_dags`
+================================================
+
+.. py:module:: airflow.providers.airbyte.example_dags
+
+
+Submodules
+----------
+.. toctree::
+   :titlesonly:
+   :maxdepth: 1
+
+   example_airbyte_trigger_job/index.rst
+
+

docs-archive/apache-airflow-providers-airbyte/3.1.0/_sources/_api/airflow/providers/airbyte/hooks/airbyte/index.rst.txt

@@ -0,0 +1,121 @@
+:py:mod:`airflow.providers.airbyte.hooks.airbyte`
+=================================================
+
+.. py:module:: airflow.providers.airbyte.hooks.airbyte
+
+
+Module Contents
+---------------
+
+Classes
+~~~~~~~
+
+.. autoapisummary::
+
+   airflow.providers.airbyte.hooks.airbyte.AirbyteHook
+
+
+
+
+.. py:class:: AirbyteHook(airbyte_conn_id = 'airbyte_default', api_version = 'v1')
+
+   Bases: :py:obj:`airflow.providers.http.hooks.http.HttpHook`
+
+   Hook for Airbyte API
+
+   :param airbyte_conn_id: Required. The name of the Airflow connection to get
+       connection information for Airbyte.
+   :param api_version: Optional. Airbyte API version.
+
+   .. py:attribute:: conn_name_attr
+      :annotation: = airbyte_conn_id
+
+
+
+   .. py:attribute:: default_conn_name
+      :annotation: = airbyte_default
+
+
+
+   .. py:attribute:: conn_type
+      :annotation: = airbyte
+
+
+
+   .. py:attribute:: hook_name
+      :annotation: = Airbyte
+
+
+
+   .. py:attribute:: RUNNING
+      :annotation: = running
+
+
+
+   .. py:attribute:: SUCCEEDED
+      :annotation: = succeeded
+
+
+
+   .. py:attribute:: CANCELLED
+      :annotation: = cancelled
+
+
+
+   .. py:attribute:: PENDING
+      :annotation: = pending
+
+
+
+   .. py:attribute:: FAILED
+      :annotation: = failed
+
+
+
+   .. py:attribute:: ERROR
+      :annotation: = error
+
+
+
+   .. py:attribute:: INCOMPLETE
+      :annotation: = incomplete
+
+
+
+   .. py:method:: wait_for_job(self, job_id, wait_seconds = 3, timeout = 3600)
+
+      Helper method which polls a job to check if it finishes.
+
+      :param job_id: Required. Id of the Airbyte job
+      :param wait_seconds: Optional. Number of seconds between checks.
+      :param timeout: Optional. How many seconds wait for job to be ready.
+          Used only if ``asynchronous`` is False.
+
+
+   .. py:method:: submit_sync_connection(self, connection_id)
+
+      Submits a job to a Airbyte server.
+
+      :param connection_id: Required. The ConnectionId of the Airbyte Connection.
+
+
+   .. py:method:: get_job(self, job_id)
+
+      Gets the resource representation for a job in Airbyte.
+
+      :param job_id: Required. Id of the Airbyte job
+
+
+   .. py:method:: cancel_job(self, job_id)
+
+      Cancel the job when task is cancelled
+
+      :param job_id: Required. Id of the Airbyte job
+
+
+   .. py:method:: test_connection(self)
+
+      Tests the Airbyte connection by hitting the health API
+
+
+

docs-archive/apache-airflow-providers-airbyte/3.1.0/_sources/_api/airflow/providers/airbyte/hooks/index.rst.txt

@@ -0,0 +1,15 @@
+:py:mod:`airflow.providers.airbyte.hooks`
+=========================================
+
+.. py:module:: airflow.providers.airbyte.hooks
+
+
+Submodules
+----------
+.. toctree::
+   :titlesonly:
+   :maxdepth: 1
+
+   airbyte/index.rst
+
+

docs-archive/apache-airflow-providers-airbyte/3.1.0/_sources/_api/airflow/providers/airbyte/index.rst.txt

@@ -0,0 +1,18 @@
+:py:mod:`airflow.providers.airbyte`
+===================================
+
+.. py:module:: airflow.providers.airbyte
+
+
+Subpackages
+-----------
+.. toctree::
+   :titlesonly:
+   :maxdepth: 3
+
+   example_dags/index.rst
+   hooks/index.rst
+   operators/index.rst
+   sensors/index.rst
+
+

docs-archive/apache-airflow-providers-airbyte/3.1.0/_sources/_api/airflow/providers/airbyte/operators/airbyte/index.rst.txt

@@ -0,0 +1,57 @@
+:py:mod:`airflow.providers.airbyte.operators.airbyte`
+=====================================================
+
+.. py:module:: airflow.providers.airbyte.operators.airbyte
+
+
+Module Contents
+---------------
+
+Classes
+~~~~~~~
+
+.. autoapisummary::
+
+   airflow.providers.airbyte.operators.airbyte.AirbyteTriggerSyncOperator
+
+
+
+
+.. py:class:: AirbyteTriggerSyncOperator(connection_id, airbyte_conn_id = 'airbyte_default', asynchronous = False, api_version = 'v1', wait_seconds = 3, timeout = 3600, **kwargs)
+
+   Bases: :py:obj:`airflow.models.BaseOperator`
+
+   This operator allows you to submit a job to an Airbyte server to run a integration
+   process between your source and destination.
+
+   .. seealso::
+       For more information on how to use this operator, take a look at the guide:
+       :ref:`howto/operator:AirbyteTriggerSyncOperator`
+
+   :param airbyte_conn_id: Required. The name of the Airflow connection to get connection
+       information for Airbyte.
+   :param connection_id: Required. The Airbyte ConnectionId UUID between a source and destination.
+   :param asynchronous: Optional. Flag to get job_id after submitting the job to the Airbyte API.
+       This is useful for submitting long running jobs and
+       waiting on them asynchronously using the AirbyteJobSensor.
+   :param api_version: Optional. Airbyte API version.
+   :param wait_seconds: Optional. Number of seconds between checks. Only used when ``asynchronous`` is False.
+   :param timeout: Optional. The amount of time, in seconds, to wait for the request to complete.
+       Only used when ``asynchronous`` is False.
+
+   .. py:attribute:: template_fields
+      :annotation: :Sequence[str] = ['connection_id']
+
+
+
+   .. py:method:: execute(self, context)
+
+      Create Airbyte Job and wait to finish
+
+
+   .. py:method:: on_kill(self)
+
+      Cancel the job if task is cancelled
+
+
+

docs-archive/apache-airflow-providers-airbyte/3.1.0/_sources/_api/airflow/providers/airbyte/operators/index.rst.txt

@@ -0,0 +1,15 @@
+:py:mod:`airflow.providers.airbyte.operators`
+=============================================
+
+.. py:module:: airflow.providers.airbyte.operators
+
+
+Submodules
+----------
+.. toctree::
+   :titlesonly:
+   :maxdepth: 1
+
+   airbyte/index.rst
+
+

docs-archive/apache-airflow-providers-airbyte/3.1.0/_sources/_api/airflow/providers/airbyte/sensors/airbyte/index.rst.txt

@@ -0,0 +1,52 @@
+:py:mod:`airflow.providers.airbyte.sensors.airbyte`
+===================================================
+
+.. py:module:: airflow.providers.airbyte.sensors.airbyte
+
+.. autoapi-nested-parse::
+
+   This module contains a Airbyte Job sensor.
+
+
+
+Module Contents
+---------------
+
+Classes
+~~~~~~~
+
+.. autoapisummary::
+
+   airflow.providers.airbyte.sensors.airbyte.AirbyteJobSensor
+
+
+
+
+.. py:class:: AirbyteJobSensor(*, airbyte_job_id, airbyte_conn_id = 'airbyte_default', api_version = 'v1', **kwargs)
+
+   Bases: :py:obj:`airflow.sensors.base.BaseSensorOperator`
+
+   Check for the state of a previously submitted Airbyte job.
+
+   :param airbyte_job_id: Required. Id of the Airbyte job
+   :param airbyte_conn_id: Required. The name of the Airflow connection to get
+       connection information for Airbyte.
+   :param api_version: Optional. Airbyte API version.
+
+   .. py:attribute:: template_fields
+      :annotation: :Sequence[str] = ['airbyte_job_id']
+
+
+
+   .. py:attribute:: ui_color
+      :annotation: = #6C51FD
+
+
+
+   .. py:method:: poke(self, context)
+
+      Function that the sensors defined while deriving this class should
+      override.
+
+
+

docs-archive/apache-airflow-providers-airbyte/3.1.0/_sources/_api/airflow/providers/airbyte/sensors/index.rst.txt

@@ -0,0 +1,15 @@
+:py:mod:`airflow.providers.airbyte.sensors`
+===========================================
+
+.. py:module:: airflow.providers.airbyte.sensors
+
+
+Submodules
+----------
+.. toctree::
+   :titlesonly:
+   :maxdepth: 1
+
+   airbyte/index.rst
+
+