A library for reading data from Google Cloud Pub/Sub using Spark Streaming.


Using SBT:

libraryDependencies += "org.apache.bahir" %% "spark-streaming-pubsub" % "2.1.3"

Using Maven:


This library can also be added to Spark jobs launched through spark-shell or spark-submit by using the --packages command line option. For example, to include it when starting the spark shell:

$ bin/spark-shell --packages org.apache.bahir:spark-streaming-pubsub_2.11:2.1.3

Unlike using --jars, using --packages ensures that this library and its dependencies will be added to the classpath. The --packages argument can also be used with bin/spark-submit.


First you need to create credential by SparkGCPCredentials, it support four type of credentials

  • application default SparkGCPCredentials.builder.build()
  • json type service account SparkGCPCredentials.builder.jsonServiceAccount(PATH_TO_JSON_KEY).build()
  • p12 type service account SparkGCPCredentials.builder.p12ServiceAccount(PATH_TO_P12_KEY, EMAIL_ACCOUNT).build()
  • metadata service account(running on dataproc) SparkGCPCredentials.builder.metadataServiceAccount().build()

Scala API

val lines = PubsubUtils.createStream(ssc, projectId, subscriptionName, credential, ..)

Java API

JavaDStream<SparkPubsubMessage> lines = PubsubUtils.createStream(jssc, projectId, subscriptionName, credential...)

See end-to-end examples at Google Cloud Pubsub Examples

Unit Test

To run the PubSub test cases, you need to generate Google API service account key files and set the corresponding environment variable to enable the test.

To generate a service account key file with PubSub permission

  1. Go to Google API Console
  2. Choose the Credentials Tab> Create credentials button> Service account key
  3. Fill the account name, assign Role> Pub/Sub> Pub/Sub Editor and check the option Furnish a private key to create one. You need to create one for JSON key file, another for P12.
  4. The account email is the Service account ID

Setting the environment variables and run test

mvn clean package -DskipTests -pl streaming-pubsub

export GCP_TEST_JSON_KEY_PATH=/path/to/pubsub/credential/files/Apache-Bahir-PubSub-1234abcd.json
export GCP_TEST_P12_KEY_PATH=/path/to/pubsub/credential/files/Apache-Bahir-PubSub-5678efgh.p12

mvn test -pl streaming-pubsub