`airflow.providers.redis.sensors.redis_pub_sub`¶

Module Contents¶

Redis sensor for reading a message from pub sub channels

class airflow.providers.redis.sensors.redis_pub_sub.RedisPubSubSensor(*, channels, redis_conn_id, **kwargs)[source]¶

Redis sensor for reading a message from pub sub channels

Parameters

channels (Union[List[str], str]) -- The channels to be subscribed to (templated)
redis_conn_id (str) -- the redis connection id

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 (airflow.utils.context.Context) -- the context object
Returns: True if message (with type 'message') is available or False if not
Return type: bool