API
===

Plugins
-------

GwDbValidator
~~~~~~~~~~~~~
.. automodule::  groundwork_validation.plugins.gw_db_validator.gw_db_validator
.. currentmodule:: groundwork_validation.plugins.gw_db_validator.gw_db_validator

.. autoclass:: GwDbValidator
   :members:
   :inherited-members:
   :undoc-members:

Patterns
--------

GwValidatorsPattern
~~~~~~~~~~~~~~~~~~~
.. automodule::  groundwork_validation.patterns.gw_validators_pattern.gw_validators_pattern

.. currentmodule:: groundwork_validation.patterns.gw_validators_pattern.gw_validators_pattern

.. autoclass:: GwValidatorsPattern
   :members:
   :inherited-members:
   :undoc-members:

.. autoclass:: ValidatorsPlugin
   :members:
   :undoc-members:

.. autoclass:: ValidatorsApplication
   :members:
   :undoc-members:

.. autoclass:: Validator
   :members:
   :undoc-members:

GwDbValidatorsPattern
~~~~~~~~~~~~~~~~~~~~~
.. automodule::  groundwork_validation.patterns.gw_db_validators_pattern.gw_db_validators_pattern

.. currentmodule:: groundwork_validation.patterns.gw_db_validators_pattern.gw_db_validators_pattern

.. autoclass:: GwDbValidatorsPattern
   :members:
   :inherited-members:
   :undoc-members:

.. autoclass:: DbValidatorsPlugin
   :members:
   :undoc-members:

.. autoclass:: DbValidatorsApplication
   :members:
   :undoc-members:

.. autoclass:: DbValidator
   :members:
   :undoc-members:

.. autoclass:: ValidationError
   :members:
   :undoc-members:


GwFileValidatorsPattern
~~~~~~~~~~~~~~~~~~~~~~~
.. automodule::  groundwork_validation.patterns.gw_file_validators_pattern.gw_file_validators_pattern

.. currentmodule:: groundwork_validation.patterns.gw_file_validators_pattern.gw_file_validators_pattern

.. autoclass:: GwFileValidatorsPattern
   :members:
   :inherited-members:
   :undoc-members:

.. autoclass:: FileValidatorsPlugin
   :members:
   :undoc-members:


GwCmdValidatorsPattern
~~~~~~~~~~~~~~~~~~~~~~~
.. automodule::  groundwork_validation.patterns.gw_cmd_validators_pattern.gw_cmd_validators_pattern

.. currentmodule:: groundwork_validation.patterns.gw_cmd_validators_pattern.gw_cmd_validators_pattern

.. autoclass:: GwCmdValidatorsPattern
   :members:
   :inherited-members:
   :undoc-members:

.. autoclass:: CmdValidatorsPlugin
   :members:
   :undoc-members:

.. autoclass:: NotAllowedReturnCode
   :members:
   :undoc-members:

.. autoclass:: CommandTimeoutExpired
   :members:
   :undoc-members: