org.apache.spark.streaming.pubsub.PubsubUtils.scala Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of spark-streaming-pubsub_2.11
The newest version!
/*
 * 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.
 */

package org.apache.spark.streaming.pubsub

import org.apache.spark.storage.StorageLevel
import org.apache.spark.streaming.StreamingContext
import org.apache.spark.streaming.api.java.JavaReceiverInputDStream
import org.apache.spark.streaming.api.java.JavaStreamingContext
import org.apache.spark.streaming.dstream.ReceiverInputDStream

object PubsubUtils {

  /**
   * Create an input stream that receives messages pushed by a Pub/Sub publisher
   * using service account authentication
   *
   * If topic is given, and the subscription doesn't exist,
   * create subscription by the given name.
   * Note: This Receiver will only receive the message arrived after the subscription created.
   * If topic is not given, throw not found exception when it doesn't exist
   *
   * @param ssc             StreamingContext object
   * @param project         Google cloud project id
   * @param topic           Topic name for creating subscription if need
   * @param subscription    Subscription name to subscribe to
   * @param credentials     SparkGCPCredentials to use for authenticating
   * @param storageLevel    RDD storage level
   * @param autoAcknowledge Auto acknowledge incoming messages
   * @return
   */
  def createStream(
      ssc: StreamingContext,
      project: String,
      topic: Option[String],
      subscription: String,
      credentials: SparkGCPCredentials,
      storageLevel: StorageLevel,
      autoAcknowledge: Boolean = true): ReceiverInputDStream[SparkPubsubMessage] = {
    ssc.withNamedScope("pubsub stream") {

      new PubsubInputDStream(
        ssc,
        project,
        topic,
        subscription,
        credentials,
        storageLevel,
        autoAcknowledge)
    }
  }

  /**
   * Create an input stream that receives messages pushed by a Pub/Sub publisher
   * using given credential
   *
   * Throw not found exception if the subscription doesn't exist
   *
   * @param jssc         JavaStreamingContext object
   * @param project      Google cloud project id
   * @param subscription Subscription name to subscribe to
   * @param credentials  SparkGCPCredentials to use for authenticating
   * @param storageLevel RDD storage level
   * @return
   */
  def createStream(jssc: JavaStreamingContext, project: String, subscription: String,
      credentials: SparkGCPCredentials, storageLevel: StorageLevel
      ): JavaReceiverInputDStream[SparkPubsubMessage] = {
    createStream(jssc.ssc, project, None, subscription, credentials, storageLevel)
  }

  /**
   * Create an input stream that receives messages pushed by a Pub/Sub publisher
   * using given credential
   *
   * Throw not found exception if the subscription doesn't exist
   *
   * @param jssc         JavaStreamingContext object
   * @param project      Google cloud project id
   * @param subscription Subscription name to subscribe to
   * @param credentials  SparkGCPCredentials to use for authenticating
   * @param storageLevel RDD storage level
   * @param autoAcknowledge Auto acknowledge incoming messages
   * @return
   */
  def createStream(jssc: JavaStreamingContext, project: String, subscription: String,
      credentials: SparkGCPCredentials, storageLevel: StorageLevel, autoAcknowledge: Boolean
      ): JavaReceiverInputDStream[SparkPubsubMessage] = {
    createStream(jssc.ssc, project, None, subscription, credentials, storageLevel, autoAcknowledge)
  }

  /**
   * Create an input stream that receives messages pushed by a Pub/Sub publisher
   * using given credential
   *
   * If the subscription doesn't exist, create subscription by the given name.
   * Note: This Receiver will only receive the message arrived after the subscription created.
   *
   * @param jssc            JavaStreamingContext object
   * @param project         Google cloud project id
   * @param topic           Topic name for creating subscription if need
   * @param subscription    Subscription name to subscribe to
   * @param credentials     SparkGCPCredentials to use for authenticating
   * @param storageLevel    RDD storage level
   * @return
   */
  def createStream(jssc: JavaStreamingContext,
      project: String, topic: String, subscription: String,
      credentials: SparkGCPCredentials, storageLevel: StorageLevel
  ): JavaReceiverInputDStream[SparkPubsubMessage] = {
    createStream(jssc.ssc, project, Some(topic), subscription, credentials, storageLevel)
  }
}