airflow.providers.common.messaging.providers.base_provider¶

Classes¶

BaseMessageQueueProvider

Base class defining a provider supported by operators/triggers of common-messaging provider.

Module Contents¶

class airflow.providers.common.messaging.providers.base_provider.BaseMessageQueueProvider[source]¶

Base class defining a provider supported by operators/triggers of common-messaging provider.

To add a new provider supported by the provider, create a new class extending this base class and add it to MESSAGE_QUEUE_PROVIDERS.

abstract queue_matches(queue)[source]¶

Return whether a given queue (string) matches a specific provider’s pattern.

This function must be as specific as possible to avoid collision with other providers. Functions in this provider should NOT overlap with each other in their matching criteria.

Parameters:: queue (str) – The queue identifier

abstract trigger_class()[source]¶

Trigger class to use when queue_matches returns True.

abstract trigger_kwargs(queue, **kwargs)[source]¶

Parameters passed to the instance of trigger_class.

Parameters:: queue (str) – The queue identifier