Skip to main content

Google Cloud Pub/Sub Distribution Channels

Receive real-time system notifications via Google Cloud Pub/Sub.

Jon Tam avatar
Written by Jon Tam
Updated over 2 years ago

You can receive new notifications via Pub/Sub. Follow the steps below to configure Pub/Sub for receiving update notifications and staying informed about the health and quality of your data.

You can configure as many Pub/Sub channels as you would like. When you add multiple Pub/Sub channels to a Notification Rule, you will receive multiple notifications, one per each Pub/Sub topic specified in the rule.

Create a Pub/Sub Distribution Channel

To create a Pub/Sub distribution channel, complete these steps:

  1. Go to the Channels menu of your account ⚙️ Settings.

  2. Select Pub/Sub.

  3. Click on the Add new Pub/Sub channel button.

  4. Give your channel a unique Channel display name so you can later easily locate it.

  5. Provide a fully qualified Google Cloud Pub/Sub Topic name. Pub/Sub topic names have the following format:

    projects/[PROJECT_ID]/topics/[TOPIC]

  6. Click on the Add Pub/Sub button on the dialog to save the new Pub/Sub distribution channel.

Edit a Pub/Sub Distribution Channel

To edit a Pub/Sub distribution channel, complete these steps:

  1. Go to the Channels menu of your account ⚙️ Settings.

  2. Select Pub/Sub.

  3. Locate the Pub/Sub distribution channel you would like to modify.

  4. Click on the ... menu located at the end of the distribution channel row, and click on the ✏️ Edit option.

  5. Make changes. You have the flexibility to change the following:

    • Channel display name

    • Topic name

  6. Click the Update button on the dialog to save your changes.

Enable and Disable a Pub/Sub Distribution Channel

To enable or disable a Pub/Sub distribution channel, complete these steps:

  1. Go to the Channels menu of your account ⚙️ Settings.

  2. Select Pub/Sub.

  3. Locate the Pub/Sub distribution channel you would like to enable or disable.

  4. Modify the on/off toggle located next to the Pub/Sub distribution channel.

Delete a Pub/Sub Distribution Channel

To delete a Pub/Sub distribution channel, complete these steps:

  1. Go to the Channels menu of your account ⚙️ Settings.

  2. Select Pub/Sub.

  3. Locate the Pub/Sub distribution channel you would like to delete.

  4. Click on the ... menu located at the end of the distribution channel row, and click on the Delete option. This action cannot be undone.

Troubleshooting Pub/Sub Distribution Channels

To delete a Pub/Sub distribution channel it should not be in use by any Notification Rules. If you attempt to delete a Pub/Sub distribution channel assigned to one or more Notification Rules, deleting the Pub/Sub channel will fail with the "Channel is currently assigned to one or more rules" error.

You have two alternatives to resolve this issue. Remove all dependencies on this Pub/Sub channel and substitute with alternative distribution channels, or remove the notification rules that depend on it.

Go to the Rules menu, and locate the notification rule(s) that use this Pub/Sub distribution channel. Substitute this Pub/Sub channel with an alternative distribution channel. You can select another Pub/Sub channel or an alternative protocol such as SQS, Webhook, or Email. Alternatively, you can delete all notification rules that use this Pub/Sub channel. After successfully removing notification rules that depend on this Pub/Sub channel, you will be able to delete it.

Closing Thoughts

You have to have an Editor or an Admin role to configure Pub/Sub Distribution Channels for data products in your organization.

See also:

Did this answer your question?