:py:mod:`GeoHealthCheck.plugins.probe.http`
===========================================

.. py:module:: GeoHealthCheck.plugins.probe.http


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

Classes
~~~~~~~

.. autoapisummary::

   GeoHealthCheck.plugins.probe.http.HttpGet
   GeoHealthCheck.plugins.probe.http.HttpGetQuery
   GeoHealthCheck.plugins.probe.http.HttpPost




.. py:class:: HttpGet


   Bases: :py:obj:`GeoHealthCheck.probe.Probe`

   Do HTTP GET Request, to poll/ping any Resource bare url.

   .. py:attribute:: NAME
      :value: 'HTTP GET Resource URL'

      

   .. py:attribute:: DESCRIPTION
      :value: 'Simple HTTP GET on Resource URL'

      

   .. py:attribute:: RESOURCE_TYPE
      :value: '*:*'

      

   .. py:attribute:: REQUEST_METHOD
      :value: 'GET'

      

   .. py:attribute:: CHECKS_AVAIL

      Checks avail



.. py:class:: HttpGetQuery


   Bases: :py:obj:`HttpGet`

   Do HTTP GET Request, to poll/ping any Resource bare url with query string.

   .. py:attribute:: NAME
      :value: 'HTTP GET Resource URL with query'

      

   .. py:attribute:: DESCRIPTION
      :value: Multiline-String

       .. raw:: html

           <details><summary>Show Value</summary>

       .. code-block:: python

           """
                   HTTP GET Resource URL with
                   ?query string to be user-supplied (without ?)
                   """

       .. raw:: html

           </details>

      

   .. py:attribute:: REQUEST_TEMPLATE
      :value: '?{query}'

      

   .. py:attribute:: PARAM_DEFS

      Param defs



.. py:class:: HttpPost


   Bases: :py:obj:`HttpGet`

   Do HTTP POST Request, to send POST request to
   Resource bare url with POST body.

   .. py:attribute:: NAME
      :value: 'HTTP POST Resource URL with body'

      

   .. py:attribute:: DESCRIPTION
      :value: Multiline-String

       .. raw:: html

           <details><summary>Show Value</summary>

       .. code-block:: python

           """
                   HTTP POST to Resource URL with body
                   content(-type) to be user-supplied
                   """

       .. raw:: html

           </details>

      

   .. py:attribute:: REQUEST_METHOD
      :value: 'POST'

      

   .. py:attribute:: REQUEST_HEADERS

      

   .. py:attribute:: REQUEST_TEMPLATE
      :value: '{body}'

      

   .. py:attribute:: PARAM_DEFS

      Param defs


   .. py:method:: get_request_headers()

      Overridden from Probe: construct request_headers
      via parameter substitution from content_type Parameter.