beetaone/http-client-requests repository overview

⁠HTTP Client Requests

⁠Table of Contents

• HTTP Client Requests⁠
  • Table of Contents⁠
  • Description⁠
  • Environment Variables⁠
    • Module Specific⁠
    • Set by the beetaone Agent on the edge-node⁠
  • Input⁠
  • Output⁠

⁠Description

This Module performs repeated HTTP requests (acting as a client) at a specified interval, to the given URL. The returned payload is forwarded to the next module. This module may be used to interact with a single REST API resource endpoint.

NOTE: Only one header is supported.

The Python class, HttpRequest, is an implementation of a simple HTTP client using the aiohttp library. It provides methods for sending a HTTP request and polling a URL at a specified interval. The class takes in a URL, method, authentication token, payload, and header as parameters. The class also contains some error handling, such as checking if the URL is valid and raising an error if the method is not one of the allowed values. The send_request method sends the HTTP request and returns the response. The poll method repeatedly sends the request and forwards the response.

⁠Environment Variables

⁠Module Specific

The following module configurations can be provided in a data service designer section on beetaone platform:

⁠Set by the beetaone Agent on the edge-node

Other features required for establishing the inter-container communication between modules in a data service are set by beetaone agent.

⁠Input

HTTP response body

⁠Output

Output of this module is a string or JSON, as specified by the user.