← Google Cloud

New Pub/Sub Messages from Google Cloud API

Pipedream makes it easy to connect APIs for Google Cloud and + other apps remarkably fast.

Trigger workflow on
New Pub/Sub Messages from the Google Cloud API
Next, do this
Connect to 500+ APIs using code and no-code building blocks
No credit card required
Trusted by 200,000+ developers from startups to Fortune 500 companies:
Trusted by 200,000+ developers from startups to Fortune 500 companies

Developers Pipedream

Getting Started

Trigger a workflow on New Pub/Sub Messages with Google Cloud API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

  1. Configure the New Pub/Sub Messages trigger
    1. Connect your Google Cloud account
    2. Configure Pub/Sub Topic Name
  2. Add steps to connect to + APIs using code and no-code building blocks
  3. Deploy the workflow
  4. Send a test event to validate your setup
  5. Turn on the trigger

Details

This is a pre-built, open source component from Pipedream's GitHub repo. The component is developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

New Pub/Sub Messages on Google Cloud
Description:Creates a Pub/Sub topic in your GCP account. Messages published to this topic are emitted from the Pipedream source.
Version:0.0.2
Key:google_cloud-new-pubsub-messages

Code

const google_cloud = require("../../google_cloud.app.js");

module.exports = {
  key: "google_cloud-new-pubsub-messages",
  name: "New Pub/Sub Messages",
  description:
    `Creates a Pub/Sub topic in your GCP account.
    Messages published to this topic are emitted from the Pipedream source.`,
  version: "0.0.2",
  dedupe: "unique", // Dedupe on Pub/Sub message ID
  props: {
    google_cloud,
    http: "$.interface.http",
    db: "$.service.db",
    topic: {
      label: "Pub/Sub Topic Name",
      description:
        `**Pipedream will create a Pub/Sub topic with this name in your account**,
        converting it to a [valid Pub/Sub topic name](https://cloud.google.com/pubsub/docs/admin#resource_names).`,
      type: "string",
    },
  },
  methods: {
    convertNameToValidPubSubTopicName(name) {
      // For valid names, see https://cloud.google.com/pubsub/docs/admin#resource_names
      return name
        // Must not start with `goog`. We add a `pd-` at the beginning if that's the case.
        .replace(/(^goog.*)/g, 'pd-$1')
        // Must start with a letter, otherwise we add `pd-` at the beginning.
        .replace(/^(?![a-zA-Z]+)/, 'pd-')
        // Only certain characters are allowed, the rest will be replaced with a `-`.
        .replace(/[^a-zA-Z0-9_\-\.~\+%]+/g, '-');
    },
  },
  hooks: {
    async activate() {
      const sdkParams = this.google_cloud.sdkParams();
      const { PubSub } = require('@google-cloud/pubsub');
      const pubSubClient = new PubSub(sdkParams);

      const topicName = this.convertNameToValidPubSubTopicName(this.topic);
      console.log(`Creating Pub/Sub topic ${topicName}`);
      const [topic] = await pubSubClient.createTopic(topicName);
      this.db.set('topicName', topic.name);

      const pushEndpoint = this.http.endpoint;
      const subscriptionName = this.convertNameToValidPubSubTopicName(pushEndpoint);
      const subscriptionOptions = {
        pushConfig: {
          pushEndpoint,
        }
      };
      console.log(
        `Subscribing this source's URL to the Pub/Sub topic: ${pushEndpoint}
        (under name ${subscriptionName}).`
      );
      const [subscriptionResult] = await pubSubClient
        .topic(topic.name)
        .createSubscription(subscriptionName, subscriptionOptions);
      this.db.set('subscriptionName', subscriptionResult.name);
    },
    async deactivate() {
      const sdkParams = this.google_cloud.sdkParams();
      const { PubSub } = require('@google-cloud/pubsub');
      const pubSubClient = new PubSub(sdkParams);

      const subscriptionName = this.db.get('subscriptionName');
      if (subscriptionName) {
        await pubSubClient.subscription(subscriptionName).delete();
      }

      const topicName = this.db.get('topicName')
      if (topicName) {
        await pubSubClient.topic(topicName).delete();
      }
    },
  },
  async run(event) {
    const { data, messageId, publishTime } = event.body.message;

    if (!data) {
      console.warn('No message present, exiting');
      return;
    }
    const dataString = Buffer.from(data, 'base64').toString('utf-8');
    const metadata = {
      id: messageId,
      summary: dataString,
      ts: +new Date(publishTime),
    };

    let dataObj;
    try {
      dataObj = JSON.parse(dataString);
    } catch (err) {
      console.error(
        `Couldn't parse message as JSON. Emitting raw message. Error: ${err}`
      );
      dataObj = {
        rawMessage: dataString,
      };
    }
    this.$emit(dataObj, metadata);
  },
};

Configuration

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.
LabelPropTypeDescription
Google Cloudgoogle_cloudappThis component uses the Google Cloud app.
N/Ahttp$.interface.httpThis component uses $.interface.http to generate a unique URL when the component is first instantiated. Each request to the URL will trigger the run() method of the component.
N/Adb$.service.dbThis component uses $.service.db to maintain state between component invocations.
Pub/Sub Topic Nametopicstring

Pipedream will create a Pub/Sub topic with this name in your account,
converting it to a valid Pub/Sub topic name.

Authentication

Google Cloud uses API keys for authentication. When you connect your Google Cloud account, Pipedream securely stores the keys so you can easily authenticate to Google Cloud APIs in both code and no-code steps.

When you create a service account in GCP, you'll be asked to generate a service account key. Create that key and download the key details in JSON format.

Open the key JSON in a text editor, then copy and paste its contents here.

About Google Cloud

The Google Cloud Platform

About Pipedream

Stop writing boilerplate code, struggling with authentication and managing infrastructure. Start connecting APIs with code-level control when you need it — and no code when you don't.

Into to Pipedream
Watch us build a workflow
Watch us build a workflow
4 min
Watch now ➜
"The past few weeks, I truly feel like the clichéd 10x engineer."
@heyellieday
Powerful features that scale
Manage concurrency and execution rate
Manage concurrency and execution rate

Queue up to 10,000 events per workfow and manage the concurrency and rate at which workflows are triggered.

Process large payloads up to 5 terabytes
Process large payloads up to 5 terabytes

Large file support enables you to trigger workflows with any data (e.g., large JSON files, images and videos) up to 5 terabytes.

Return custom responses to HTTP requests
Return custom responses to HTTP requests

Return any JSON-serializable response from an HTTP triggered workflow using $respond().

Use most npm packages
Use most npm packages

To use any npm package, just require() it -- there's no npm install or package.json required.

Maintain state between executions
Maintain state between executions

Use $checkpoint to save state in one workflow invocation and read it the next time your workflow runs.

Pass data between steps
Pass data between steps

Return data from any step to inspect it in a human-friendly way and reference the data in future steps via the steps object.