:py:mod:`GeoHealthCheck.result`
===============================

.. py:module:: GeoHealthCheck.result


Module Contents
---------------

Classes
~~~~~~~

.. autoapisummary::

   GeoHealthCheck.result.Result
   GeoHealthCheck.result.ResourceResult
   GeoHealthCheck.result.ProbeResult
   GeoHealthCheck.result.CheckResult



Functions
~~~~~~~~~

.. autoapisummary::

   GeoHealthCheck.result.push_result



.. py:class:: Result(success=True, message='OK')


   Bases: :py:obj:`object`

   Base class for results for Resource or Probe.

   .. py:method:: add_result(result)


   .. py:method:: get_report()


   .. py:method:: set(success, message)


   .. py:method:: start()


   .. py:method:: stop()


   .. py:method:: __str__()

      Return str(self).



.. py:class:: ResourceResult(resource)


   Bases: :py:obj:`Result`

   Holds result data from a single Resource: one Resource, N Probe(Results).
   Provides Run data.

   .. py:attribute:: REPORT_VERSION
      :value: '1'

      

   .. py:method:: get_report()



.. py:class:: ProbeResult(probe, probe_vars)


   Bases: :py:obj:`Result`

   Holds result data from a single Probe: one Probe, N Checks.


   .. py:method:: get_report()



.. py:class:: CheckResult(check, check_vars, success=True, message='OK')


   Bases: :py:obj:`Result`

   Holds result data from a single Check.

   .. py:method:: get_report()



.. py:function:: push_result(obj, result, val, msg, new_result_name)