Skip to content

Latest commit

 

History

History
61 lines (44 loc) · 1.99 KB

README.md

File metadata and controls

61 lines (44 loc) · 1.99 KB
Raw

BroadwayCloudPubSub

CI

A Google Cloud Pub/Sub connector for Broadway.

Documentation can be found at https://hexdocs.pm/broadway_cloud_pub_sub.

This project provides:

  • BroadwayCloudPubSub.Producer - A GenStage producer that continuously receives messages from a Pub/Sub subscription acknowledges them after being successfully processed.
  • BroadwayCloudPubSub.Client - A generic behaviour to implement Pub/Sub clients.
  • BroadwayCloudPubSub.PullClient - Default REST client used by BroadwayCloudPubSub.Producer.

Installation

Add :broadway_cloud_pub_sub to the list of dependencies in mix.exs:

def deps do
  [
    {:broadway_cloud_pub_sub, "~> 0.9.0"},
    {:goth, "~> 1.3"}
  ]
end

Note the goth package, which handles Google Authentication, is required for the default token generator.

Usage

Configure Broadway with one or more producers using BroadwayCloudPubSub.Producer:

Broadway.start_link(MyBroadway,
  name: MyBroadway,
  producer: [
    module: {BroadwayCloudPubSub.Producer,
      goth: MyGoth,
      subscription: "projects/my-project/subscriptions/my-subscription"
    }
  ]
)

License

Copyright 2019 Michael Crumm
Copyright 2020 Dashbit

Licensed 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.