`airflow.contrib.sensors.redis_pub_sub_sensor`¶

Module Contents¶

class airflow.contrib.sensors.redis_pub_sub_sensor.RedisPubSubSensor(channels, redis_conn_id, *args, **kwargs)[source]¶

Redis sensor for reading a message from pub sub channels

poke(self, context)[source]¶

Check for message on subscribed channels and write to xcom the message with key message

An example of message {'type': 'message', 'pattern': None, 'channel': b'test', 'data': b'hello'}

Parameters: context (dict) – the context object
Returns: True if message (with type ‘message’) is available or False if not