HttpSensorAsync
Astronomer ProvidersExecutes a HTTP GET statement and returns False on failure caused by 404 Not Found or response_check returning False.
Access Instructions
Install the Astronomer Providers provider package into your Airflow environment.
Import the module into your DAG file and instantiate it with your desired params.
Parameters
http_conn_idstrThe Connection ID to run the sensor against
methodstrThe HTTP request method to use
endpointRequiredstrThe relative part of the full url
request_paramsa dictionary of string key/value pairsThe parameters to be added to the GET url
headersa dictionary of string key/value pairsThe HTTP headers to be added to the GET request
response_checkA lambda or defined function.A check against the ‘requests’ response object. The callable takes the response object as the first positional argument and optionally any number of keyword arguments available in the context dictionary. It should return True for ‘pass’ and False otherwise. Currently if this parameter is specified then sync version of the sensor will be used.
extra_optionsA dictionary of options, where key is string and value depends on the option that’s being modified.Extra options for the ‘requests’ library, see the ‘requests’ documentation (options to modify timeout, ssl, etc.)
tcp_keep_aliveEnable TCP Keep Alive for the connection.
tcp_keep_alive_idleThe TCP Keep Alive Idle parameter (corresponds to socket.TCP_KEEPIDLE).
tcp_keep_alive_countThe TCP Keep Alive count parameter (corresponds to socket.TCP_KEEPCNT)
tcp_keep_alive_intervalThe TCP Keep Alive interval parameter (corresponds to socket.TCP_KEEPINTVL)
Documentation
Executes a HTTP GET statement and returns False on failure caused by 404 Not Found or response_check returning False.
Note
If response_check is passed, the sync version of the sensor will be used.
The response check can access the template context to the operator:
def response_check(response, task_instance):# The task_instance is injected, so you can pull data form xcom# Other context variables such as dag, ds, execution_date are also available.xcom_data = task_instance.xcom_pull(task_ids="pushing_task")# In practice you would do something more sensible with this data..print(xcom_data)return TrueHttpSensorAsync(task_id="my_http_sensor", ..., response_check=response_check)