API Reference
=============

Details about the libraries made available to tests through use of
the StreamSets Test Framework are documented below. These
APIs can be divided into those related to StreamSets Data Collector, StreamSets Transformer,
StreamSets Control Hub, Environments, and Utility functions.

StreamSets Data Collector
-------------------------

Main interface
^^^^^^^^^^^^^^
.. automodule:: streamsets.testframework.sdc
    :members:

Models
^^^^^^
.. automodule:: streamsets.testframework.sdc_models
    :members:


Fixtures
^^^^^^^^
.. automodule:: streamsets.testframework.conftest
    :members: sdc_builder, sdc_executor, sdc_builder_hook, sdc_common_hook, sdc_executor_hook


StreamSets Control Hub
----------------------

Main interface
^^^^^^^^^^^^^^
.. automodule:: streamsets.testframework.sch
    :members:

Models
^^^^^^
.. automodule:: streamsets.testframework.sch_models
    :members:


Fixtures
^^^^^^^^
.. automodule:: streamsets.testframework.conftest_sch
    :members: sch_authoring_sdc, sch_authoring_transformer, sch_session


StreamSets Transformer
----------------------

Main interface
^^^^^^^^^^^^^^
.. automodule:: streamsets.testframework.st
    :members:

Models
^^^^^^
.. automodule:: streamsets.testframework.st_models
    :members:


Fixtures
^^^^^^^^
.. automodule:: streamsets.testframework.conftest_st
    :members: st_builder, st_builder_hook, st_common_hook, st_executor

Common for StreamSets Data Collector, Transformer and Control Hub
-----------------------------------------------------------------

Environments - Core APIs
^^^^^^^^^^^^^^^^^^^^^^^^
.. automodule:: streamsets.testframework.environments.aws
    :members:

.. automodule:: streamsets.testframework.environments.azure
    :members:

.. automodule:: streamsets.testframework.environments.cassandra
    :members:

.. automodule:: streamsets.testframework.environments.cloudera
    :members:

.. automodule:: streamsets.testframework.environments.confluent
    :members:

.. automodule:: streamsets.testframework.environments.couchbase
    :members:

.. automodule:: streamsets.testframework.environments.databases
    :members:

.. automodule:: streamsets.testframework.environments.elasticsearch
    :members:

.. automodule:: streamsets.testframework.environments.gcp
    :members:

.. automodule:: streamsets.testframework.environments.hortonworks
    :members:

.. automodule:: streamsets.testframework.environments.http
    :members:

.. automodule:: streamsets.testframework.environments.influxdb
    :members:

.. automodule:: streamsets.testframework.environments.influxdb2
    :members:

.. automodule:: streamsets.testframework.environments.jms
    :members:

.. automodule:: streamsets.testframework.environments.kafka
    :members:

.. automodule:: streamsets.testframework.environments.ldap
    :members:

.. automodule:: streamsets.testframework.environments.mapr
    :members:

.. automodule:: streamsets.testframework.environments.mongodb
    :members:

.. automodule:: streamsets.testframework.environments.mqtt
    :members:

.. automodule:: streamsets.testframework.environments.opcua
    :members:

.. automodule:: streamsets.testframework.environments.pulsar
    :members:

.. automodule:: streamsets.testframework.environments.rabbitmq
    :members:

.. automodule:: streamsets.testframework.environments.redis
    :members:

.. automodule:: streamsets.testframework.environments.salesforce
    :members:

.. automodule:: streamsets.testframework.environments.solr
    :members:

.. automodule:: streamsets.testframework.environments.tcp
    :members:

.. automodule:: streamsets.testframework.environments.teradata
    :members:

.. automodule:: streamsets.testframework.credential_stores.azure
    :members:


Environments - Factories
^^^^^^^^^^^^^^^^^^^^^^^^
.. automodule:: streamsets.testframework.environment
    :members:

.. automodule:: streamsets.testframework.credential_store
    :members:


Fixtures
^^^^^^^^
.. automodule:: streamsets.testframework.conftest
    :members: aws, azure, cassandra, cluster, confluent, couchbase, credential_store, database,
        elasticsearch, gcp, http_client, influxdb, influxdb2, jms, mongodb, mqtt_broker, opcua, pulsar, rabbitmq, redis,
        salesforce, solr, teradata

System models
^^^^^^^^^^^^^
.. automodule:: streamsets.testframework.system
   :members:

Utility functions
^^^^^^^^^^^^^^^^^
.. automodule:: streamsets.testframework.utils
   :members: