GeoHealthCheck.result
=====================

.. py:module:: GeoHealthCheck.result


Classes
-------

.. autoapisummary::

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


Functions
---------

.. autoapisummary::

   GeoHealthCheck.result.push_result


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

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

   Bases: :py:obj:`object`


   Base class for results for Resource or Probe.


   .. py:attribute:: success
      :value: True



   .. py:attribute:: message
      :value: 'OK'



   .. py:attribute:: start_time
      :value: None



   .. py:attribute:: end_time
      :value: None



   .. py:attribute:: response_time_secs
      :value: -1



   .. py:attribute:: response_time_str
      :value: -1



   .. py:attribute:: results
      :value: []



   .. py:attribute:: results_failed
      :value: []



   .. py:method:: add_result(result)


   .. py:method:: get_report()


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


   .. py:method:: start()


   .. py:method:: stop()


   .. py:method:: __str__()


.. 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:attribute:: resource


   .. 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:attribute:: probe


   .. py:attribute:: probe_vars


   .. 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:attribute:: check


   .. py:attribute:: check_vars


   .. py:attribute:: parameters


   .. py:method:: get_report()


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