shubham22 commented on code in PR #46694: URL: https://github.com/apache/airflow/pull/46694#discussion_r1953998635
########## providers/common/msgq/README.rst: ########## @@ -0,0 +1,101 @@ + + .. Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + .. http://www.apache.org/licenses/LICENSE-2.0 + + .. Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. + + .. NOTE! THIS FILE IS AUTOMATICALLY GENERATED AND WILL BE OVERWRITTEN! + + .. IF YOU WANT TO MODIFY TEMPLATE FOR THIS FILE, YOU SHOULD MODIFY THE TEMPLATE + `PROVIDER_README_TEMPLATE.rst.jinja2` IN the `dev/breeze/src/airflow_breeze/templates` DIRECTORY + + +Package ``apache-airflow-providers-common-msgq`` + +Release: ``0.1.0`` + + + +Provider package +---------------- + +This is a provider package for ``common.msgq`` provider. All classes for this provider package +are in ``airflow.providers.common.msgq`` python package. + +This provider package is intended to serve as a common abstraction on top of popular message queue +providers such as Apache Kafka, Amazon SQS, and Google PubSub. + +The expectation is that a common provider abstraction for message queues is especially useful for +Event Driven Scheduling, which is being introduced as part of Airflow 3.0. Based on conversations +with users of Apache Airflow, these Events for publishing of Data Assets are very often broadcast +over a publish and subscribe mechanism. The underlying technology used for this publish and subscribe +mechanism varies by environment, but Apache Kafka, Amazon SQS, and Google PubSub are commonly used. + + +Expected usage would be something on the lines below:: + + trigger = = MsgQueueSensorTrigger(msg_queue="https://sqs.us-east-1.amazonaws.com/722404908466/Test";) Review Comment: I believe this should be `MessageQueueTrigger(msg_queue...)` as the trigger class name is MessageQueueTrigger. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
