Github user budde commented on a diff in the pull request:
https://github.com/apache/spark/pull/17250#discussion_r107318157
--- Diff:
external/kinesis-asl/src/main/scala/org/apache/spark/streaming/kinesis/KinesisInputDStream.scala
---
@@ -71,7 +75,256 @@ private[kinesis] class KinesisInputDStream[T: ClassTag](
override def getReceiver(): Receiver[T] = {
new KinesisReceiver(streamName, endpointUrl, regionName,
initialPositionInStream,
- checkpointAppName, checkpointInterval, storageLevel, messageHandler,
- kinesisCredsProvider)
+ checkpointAppName, checkpointInterval, _storageLevel, messageHandler,
+ kinesisCredsProvider, dynamoDBCredsProvider, cloudWatchCredsProvider)
}
}
+
+@InterfaceStability.Stable
+object KinesisInputDStream {
+ /**
+ * Builder for [[KinesisInputDStream]] instances.
+ *
+ * @since 2.2.0
+ */
+ @InterfaceStability.Stable
+ class Builder {
+ // Required params
+ private var streamingContext: Option[StreamingContext] = None
+ private var streamName: Option[String] = None
+ private var checkpointAppName: Option[String] = None
+
+ // Params with defaults
+ private var endpointUrl: Option[String] = None
+ private var regionName: Option[String] = None
+ private var initialPositionInStream: Option[InitialPositionInStream] =
None
+ private var checkpointInterval: Option[Duration] = None
+ private var storageLevel: Option[StorageLevel] = None
+ private var kinesisCredsProvider:
Option[SerializableCredentialsProvider] = None
+ private var dynamoDBCredsProvider:
Option[SerializableCredentialsProvider] = None
+ private var cloudWatchCredsProvider:
Option[SerializableCredentialsProvider] = None
+
+ /**
+ * Sets the StreamingContext that will be used to construct the
Kinesis DStream. This is a
+ * required parameter.
+ *
+ * @param ssc [[StreamingContext]] used to construct Kinesis DStreams
+ * @return Reference to this [[KinesisInputDStream.Builder]]
+ */
+ def streamingContext(ssc: StreamingContext): Builder = {
+ streamingContext = Option(ssc)
+ this
+ }
+
+ /**
+ * Sets the StreamingContext that will be used to construct the
Kinesis DStream. This is a
+ * required parameter.
+ *
+ * @param jssc [[JavaStreamingContext]] used to construct Kinesis
DStreams
+ * @return Reference to this [[KinesisInputDStream.Builder]]
+ */
+ def streamingContext(jssc: JavaStreamingContext): Builder = {
+ streamingContext = Option(jssc.ssc)
+ this
+ }
+
+ /**
+ * Sets the name of the Kinesis stream that the DStream will read
from. This is a required
+ * parameter.
+ *
+ * @param streamName Name of Kinesis stream that the DStream will read
from
+ * @return Reference to this [[KinesisInputDStream.Builder]]
+ */
+ def streamName(streamName: String): Builder = {
+ this.streamName = Option(streamName)
+ this
+ }
+
+ /**
+ * Sets the KCL application name to use when checkpointing state to
DynamoDB. This is a
+ * required parameter.
+ *
+ * @param appName Value to use for the KCL app name (used when
creating the DynamoDB checkpoint
+ * table and when writing metrics to CloudWatch)
+ * @return Reference to this [[KinesisInputDStream.Builder]]
+ */
+ def checkpointAppName(appName: String): Builder = {
+ checkpointAppName = Option(appName)
+ this
+ }
+
+ /**
+ * Sets the AWS Kinesis endpoint URL. Defaults to
"https://kinesis.us-east-1.amazonaws.com"; if
+ * no custom value is specified
+ *
+ * @param url Kinesis endpoint URL to use
+ * @return Reference to this [[KinesisInputDStream.Builder]]
+ */
+ def endpointUrl(url: String): Builder = {
+ endpointUrl = Option(url)
+ this
+ }
+
+ /**
+ * Sets the AWS region to construct clients for. Defaults to
"us-east-1" if no custom value
+ * is specified.
+ *
+ * @param regionName Name of AWS region to use (e.g. "us-west-2")
+ * @return Reference to this [[KinesisInputDStream.Builder]]
+ */
+ def regionName(regionName: String): Builder = {
+ this.regionName = Option(regionName)
+ this
+ }
+
+ /**
+ * Sets the initial position data is read from in the Kinesis stream.
Defaults to
+ * [[InitialPositionInStream.LATEST]] if no custom value is specified.
+ *
+ * @param initialPosition InitialPositionInStream value specifying
where Spark Streaming
+ * will start reading records in the Kinesis
stream from
+ * @return Reference to this [[KinesisInputDStream.Builder]]
+ */
+ def initialPositionInStream(initialPosition: InitialPositionInStream):
Builder = {
+ initialPositionInStream = Option(initialPosition)
+ this
+ }
+
+ /**
+ * Sets how often the KCL application state is checkpointed to
DynamoDB. Defaults to the Spark
+ * Streaming batch interval if no custom value is specified.
+ *
+ * @param interval [[Duration]] specifying how often the KCL state
should be checkpointed to
+ * DynamoDB.
+ * @return Reference to this [[KinesisInputDStream.Builder]]
+ */
+ def checkpointInterval(interval: Duration): Builder = {
+ checkpointInterval = Option(interval)
+ this
+ }
+
+ /**
+ * Sets the storage level of the blocks for the DStream created.
Defaults to
+ * [[StorageLevel.MEMORY_AND_DISK_2]] if no custom value is specified.
+ *
+ * @param storageLevel [[StorageLevel]] to use for the DStream data
blocks
+ * @return Reference to this [[KinesisInputDStream.Builder]]
+ */
+ def storageLevel(storageLevel: StorageLevel): Builder = {
+ this.storageLevel = Option(storageLevel)
+ this
+ }
+
+ /**
+ * Sets the [[SerializableCredentialsProvider]] to use for
authenticating to the AWS Kinesis
+ * endpoint. Defaults to [[DefaultCredentialsProvider]] if no custom
value is specified.
+ *
+ * @param credentials [[SerialziableCredentialsProvider]] to use for
Kinesis authentication
+ */
+ def kinesisCredentials(credentials: SerializableCredentialsProvider):
Builder = {
+ kinesisCredsProvider = Option(credentials)
+ this
+ }
+
+ /**
+ * Sets the [[SerializableCredentialsProvider]] to use for
authenticating to the AWS DynamoDB
+ * endpoint. Will use the same credentials used for AWS Kinesis if no
custom value is set.
+ *
+ * @param credentials [[SerialziableCredentialsProvider]] to use for
DynamoDB authentication
+ */
+ def dynamoDBCredentials(credentials: SerializableCredentialsProvider):
Builder = {
+ dynamoDBCredsProvider = Option(credentials)
+ this
+ }
+
+ /**
+ * Sets the [[SerializableCredentialsProvider]] to use for
authenticating to the AWS CloudWatch
+ * endpoint. Will use the same credentials used for AWS Kinesis if no
custom value is set.
+ *
+ * @param credentials [[SerialziableCredentialsProvider]] to use for
CloudWatch authentication
+ */
+ def cloudWatchCredentials(credentials:
SerializableCredentialsProvider): Builder = {
+ cloudWatchCredsProvider = Option(credentials)
+ this
+ }
+
+ /**
+ * Create a new instance of [[KinesisInputDStream]] with configured
parameters and the provided
+ * message handler.
+ *
+ * @param handler Function converting [[Record]] instances read by the
KCL to DStream type [[T]]
+ * @return Instance of [[KinesisInputDStream]] constructed with
configured parameters
+ */
+ def buildWithMessageHandler[T: ClassTag](
+ handler: Record => T): KinesisInputDStream[T] = {
+ val ssc = getRequiredParam(streamingContext, "streamingContext")
+ new KinesisInputDStream(
+ ssc,
+ getRequiredParam(streamName, "streamName"),
+ endpointUrl.getOrElse(DEFAULT_KINESIS_ENDPOINT_URL),
+ regionName.getOrElse(DEFAULT_KINESIS_REGION_NAME),
+
initialPositionInStream.getOrElse(DEFAULT_INITIAL_POSITION_IN_STREAM),
+ getRequiredParam(checkpointAppName, "checkpointAppName"),
+ checkpointInterval.getOrElse(ssc.graph.batchDuration),
+ storageLevel.getOrElse(DEFAULT_STORAGE_LEVEL),
+ handler,
+ kinesisCredsProvider.getOrElse(DefaultCredentialsProvider),
+ dynamoDBCredsProvider,
+ cloudWatchCredsProvider)
+ }
+
+ /**
+ * Create a new instance of [[KinesisInputDStream]] with configured
parameters and using the
+ * default message handler, which returns [[Array[Byte]]].
+ *
+ * @return Instance of [[KinesisInputDStream]] constructed with
configured parameters
+ */
+ def build(): KinesisInputDStream[Array[Byte]] =
buildWithMessageHandler(defaultMessageHandler)
+
+ private def getRequiredParam[T](param: Option[T], paramName: String):
T = param.getOrElse {
+ throw new IllegalArgumentException(s"No value provided for required
parameter $paramName")
+ }
+
+ private def buildSTSCredentials(
+ stsRoleArn: String,
+ stsSessionName: String,
+ stsExternalId: Option[String] = None,
+ awsKeypair: Option[(String, String)] = None):
STSCredentialsProvider = {
+ val baseCredentials = STSCredentialsProvider(
+ stsRoleArn = stsRoleArn,
+ stsSessionName = stsSessionName,
+ stsExternalId = stsExternalId)
+ awsKeypair match {
+ case Some((accessKey, secretKey)) =>
+ baseCredentials.copy(
+ longLivedCredsProvider = BasicCredentialsProvider(accessKey,
secretKey))
+ case None =>
+ baseCredentials
+ }
+ }
+ }
+
+ /**
+ * Creates a [[KinesisInputDStream.Builder]] for constructing
[[KinesisInputDStream]] instances.
+ *
+ * @since 2.2.0
+ *
+ * @return [[KinesisInputDStream.Builder]] instance
+ */
+ def builder: Builder = new Builder
+
+ private[kinesis] def defaultMessageHandler(record: Record): Array[Byte]
= {
+ if (record == null) return null
+ val byteBuffer = record.getData()
+ val byteArray = new Array[Byte](byteBuffer.remaining())
+ byteBuffer.get(byteArray)
+ byteArray
+ }
+
+ private[kinesis] val DEFAULT_KINESIS_ENDPOINT_URL: String
+ = "https://kinesis.us-east-1.amazonaws.com";
+ private[kinesis] val DEFAULT_KINESIS_REGION_NAME: String = "us-east-1"
+ private[kinesis] val DEFAULT_INITIAL_POSITION_IN_STREAM:
InitialPositionInStream
+ = InitialPositionInStream.LATEST
--- End diff --
Will fix. Sorry I keep doing this :-/
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscr...@spark.apache.org
For additional commands, e-mail: reviews-h...@spark.apache.org
