Add documentation for packages - 2024-05-01 (#1009)

* Add documentation for packages - 2024-05-01

* Fix duplicate entry in jira

* Exclude microsoft.azure and pinecone providers

* fix pinecone

* exclude google

docs-archive/apache-airflow-providers-airbyte/3.8.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: 90ad28a66de18c7dceddba6048a6dc8e
+tags: 645f666f9bcd5a90fca523b33c5a78b7

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

@@ -0,0 +1,157 @@
+:py:mod:`airflow.providers.airbyte.hooks.airbyte`
+=================================================
+
+.. py:module:: airflow.providers.airbyte.hooks.airbyte
+
+
+Module Contents
+---------------
+
+Classes
+~~~~~~~
+
+.. autoapisummary::
+
+   airflow.providers.airbyte.hooks.airbyte.AirbyteHook
+
+
+
+
+Attributes
+~~~~~~~~~~
+
+.. autoapisummary::
+
+   airflow.providers.airbyte.hooks.airbyte.T
+
+
+.. py:data:: T
+
+   
+
+.. py:class:: AirbyteHook(airbyte_conn_id = 'airbyte_default', api_version = 'v1', api_type = 'config')
+
+
+   Bases: :py:obj:`airflow.providers.http.hooks.http.HttpHook`
+
+   Hook for Airbyte API.
+
+   :param airbyte_conn_id: Optional. The name of the Airflow connection to get
+       connection information for Airbyte. Defaults to "airbyte_default".
+   :param api_version: Optional. Airbyte API version. Defaults to "v1".
+   :param api_type: Optional. The type of Airbyte API to use. Either "config" or "cloud". Defaults to "config".
+
+   .. py:attribute:: conn_name_attr
+      :value: 'airbyte_conn_id'
+
+
+
+   .. py:attribute:: default_conn_name
+      :value: 'airbyte_default'
+
+
+
+   .. py:attribute:: conn_type
+      :value: 'airbyte'
+
+
+
+   .. py:attribute:: hook_name
+      :value: 'Airbyte'
+
+
+
+   .. py:attribute:: RUNNING
+      :value: 'running'
+
+
+
+   .. py:attribute:: SUCCEEDED
+      :value: 'succeeded'
+
+
+
+   .. py:attribute:: CANCELLED
+      :value: 'cancelled'
+
+
+
+   .. py:attribute:: PENDING
+      :value: 'pending'
+
+
+
+   .. py:attribute:: FAILED
+      :value: 'failed'
+
+
+
+   .. py:attribute:: ERROR
+      :value: 'error'
+
+
+
+   .. py:attribute:: INCOMPLETE
+      :value: 'incomplete'
+
+
+
+   .. py:method:: get_headers_tenants_from_connection()
+      :async:
+
+      Get Headers, tenants from the connection details.
+
+
+   .. py:method:: get_job_details(job_id)
+      :async:
+
+      Use Http async call to retrieve metadata for a specific job of an Airbyte Sync.
+
+      :param job_id: The ID of an Airbyte Sync Job.
+
+
+   .. py:method:: get_job_status(job_id)
+      :async:
+
+      Retrieve the status for a specific job of an Airbyte Sync.
+
+      :param job_id: The ID of an Airbyte Sync Job.
+
+
+   .. py:method:: wait_for_job(job_id, wait_seconds = 3, timeout = 3600)
+
+      Poll 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(connection_id)
+
+      Submit a job to a Airbyte server.
+
+      :param connection_id: Required. The ConnectionId of the Airbyte Connection.
+
+
+   .. py:method:: get_job(job_id)
+
+      Get the resource representation for a job in Airbyte.
+
+      :param job_id: Required. Id of the Airbyte job
+
+
+   .. py:method:: cancel_job(job_id)
+
+      Cancel the job when task is cancelled.
+
+      :param job_id: Required. Id of the Airbyte job
+
+
+   .. py:method:: test_connection()
+
+      Tests the Airbyte connection by hitting the health API.
+
+
+

docs-archive/apache-airflow-providers-airbyte/3.8.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.8.0/_sources/_api/airflow/providers/airbyte/index.rst.txt

@@ -0,0 +1,26 @@
+:py:mod:`airflow.providers.airbyte`
+===================================
+
+.. py:module:: airflow.providers.airbyte
+
+
+Subpackages
+-----------
+.. toctree::
+   :titlesonly:
+   :maxdepth: 3
+
+   hooks/index.rst
+   operators/index.rst
+   sensors/index.rst
+   triggers/index.rst
+
+
+Package Contents
+----------------
+
+.. py:data:: __version__
+   :value: '3.8.0'
+
+
+

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

@@ -0,0 +1,74 @@
+: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, deferrable = conf.getboolean('operators', 'default_deferrable', fallback=False), api_version = 'v1', api_type = 'config', wait_seconds = 3, timeout = 3600, **kwargs)
+
+
+   Bases: :py:obj:`airflow.models.BaseOperator`
+
+   Submits 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: Optional. The name of the Airflow connection to get connection
+       information for Airbyte. Defaults to "airbyte_default".
+   :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. Defaults to False.
+   :param deferrable: Run operator in the deferrable mode.
+   :param api_version: Optional. Airbyte API version. Defaults to "v1".
+   :param api_type: Optional. The type of Airbyte API to use. Either "config" or "cloud". Defaults to "config".
+   :param wait_seconds: Optional. Number of seconds between checks. Only used when ``asynchronous`` is False.
+       Defaults to 3 seconds.
+   :param timeout: Optional. The amount of time, in seconds, to wait for the request to complete.
+       Only used when ``asynchronous`` is False. Defaults to 3600 seconds (or 1 hour).
+
+   .. py:attribute:: template_fields
+      :type: Sequence[str]
+      :value: ('connection_id',)
+
+
+
+   .. py:attribute:: ui_color
+      :value: '#6C51FD'
+
+
+
+   .. py:method:: execute(context)
+
+      Create Airbyte Job and wait to finish.
+
+
+   .. py:method:: execute_complete(context, event = None)
+
+      Invoke this callback when the trigger fires; return immediately.
+
+      Relies on trigger to throw an exception, otherwise it assumes execution was
+      successful.
+
+
+   .. py:method:: on_kill()
+
+      Cancel the job if task is cancelled.
+
+
+

docs-archive/apache-airflow-providers-airbyte/3.8.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.8.0/_sources/_api/airflow/providers/airbyte/sensors/airbyte/index.rst.txt

@@ -0,0 +1,68 @@
+: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, deferrable = conf.getboolean('operators', 'default_deferrable', fallback=False), airbyte_conn_id = 'airbyte_default', api_version = 'v1', api_type = 'config', **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: Optional. The name of the Airflow connection to get
+   :param deferrable: Run sensor in the deferrable mode.
+       connection information for Airbyte. Defaults to "airbyte_default".
+   :param api_version: Optional. Airbyte API version. Defaults to "v1".
+   :param api_type: Optional. The type of Airbyte API to use. Either "config" or "cloud". Defaults to "config".
+
+   .. py:attribute:: template_fields
+      :type: Sequence[str]
+      :value: ('airbyte_job_id',)
+
+
+
+   .. py:attribute:: ui_color
+      :value: '#6C51FD'
+
+
+
+   .. py:method:: poke(context)
+
+      Override when deriving this class.
+
+
+   .. py:method:: execute(context)
+
+      Submit a job which generates a run_id and gets deferred.
+
+
+   .. py:method:: execute_complete(context, event = None)
+
+      Invoke this callback when the trigger fires; return immediately.
+
+      Relies on trigger to throw an exception, otherwise it assumes execution was
+      successful.
+
+
+

docs-archive/apache-airflow-providers-airbyte/3.8.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
+
+