KCLWorkerRunner

Instance Constructors

new KCLWorkerRunner(config: KinesisClientLibConfiguration, checkpointInterval: FiniteDuration = 5 minutes, numRetries: Int = 3, initialize: (String) ⇒ Unit = (_) => (), shutdown: (String, IRecordProcessorCheckpointer, ShutdownReason) ⇒ Unit = (_,_,_) => (), metricsFactory: Option[IMetricsFactory] = None, initialRetryDelay: Duration = 10 seconds, maxRetryDelay: FiniteDuration = 3 minutes)

config
KCL config, @see KCLConfiguration for some useful defaults.
checkpointInterval
how often to save checkpoint to dynamodb
numRetries
how many times to retry operation on exception before giving up
initialize
(ShardId) => Unit : additional code to execute when handler is initialized
shutdown
(ShardId, Checkpointer, ShutdownReason) => Unit : additional code to execute on shutdown
metricsFactory
CloudWatch metrics factory
initialRetryDelay
the initial failed operation retry delay value, defaults to 10 seconds
maxRetryDelay
the maximum failed operation retry delay value, defaults to 3 minutes

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
val checkpointInterval: FiniteDuration

how often to save checkpoint to dynamodb
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
val config: KinesisClientLibConfiguration

KCL config, @see KCLConfiguration for some useful defaults.
def debug(message: ⇒ String, ex: Throwable): Unit

Attributes
protected
Definition Classes
Loggable
def debug(message: ⇒ String): Unit

Attributes
protected
Definition Classes
Loggable
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def error(message: ⇒ String, ex: Throwable): Unit

Attributes
protected
Definition Classes
Loggable
def error(message: ⇒ String): Unit

Attributes
protected
Definition Classes
Loggable
def error(ex: Throwable): Unit

Attributes
protected
Definition Classes
Loggable
def fatal(message: ⇒ String, ex: Throwable): Unit

Attributes
protected
Definition Classes
Loggable
def fatal(message: ⇒ String): Unit

Attributes
protected
Definition Classes
Loggable
def fatal(ex: Throwable): Unit

Attributes
protected
Definition Classes
Loggable
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def info(message: ⇒ String, ex: Throwable): Unit

Attributes
protected
Definition Classes
Loggable
def info(message: ⇒ String): Unit

Attributes
protected
Definition Classes
Loggable
val initialRetryDelay: Duration

the initial failed operation retry delay value, defaults to 10 seconds
val initialize: (String) ⇒ Unit

(ShardId) => Unit : additional code to execute when handler is initialized
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
val maxRetryDelay: FiniteDuration

the maximum failed operation retry delay value, defaults to 3 minutes
val metricsFactory: Option[IMetricsFactory]

CloudWatch metrics factory
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
val numRetries: Int

how many times to retry operation on exception before giving up
def runAsyncSingleRecordProcessor[A](callbackTimeout: FiniteDuration)(processRecord: (A) ⇒ Future[Unit])(implicit executor: ExecutionContext, evReader: KinesisRecordReader[A]): Unit

Run KCL worker with the given asynchronous callback.
Run KCL worker with the given asynchronous callback. Batch will be processed in parallel. You can control the level of parallelism by configuring provided execution context parameter.
callbackTimeout
how long to wait for async call results
processRecord
(Record) => Future[Unit] : async record handler
executor
where to execute record processing functions
evReader
evidence that A has implementation of KinesisRecordReader implicitly available in scope
def runBatchProcessor[A](processRecords: (String, Seq[A], IRecordProcessorCheckpointer) ⇒ Unit)(implicit evReader: KinesisRecordReader[A]): Unit

Run KCL worker with the given callback.
Run KCL worker with the given callback.
processRecords
(ShardId, Records, Checkpointer) => Unit : Kinesis record handler
evReader
evidence that A has implementation of KinesisRecordReader implicitly available in scope
def runSingleRecordProcessor[A](processRecord: (String, A, IRecordProcessorCheckpointer) ⇒ Unit)(implicit evReader: KinesisRecordReader[A]): Unit

Run KCL worker with the given callback.
Run KCL worker with the given callback. Simple single-threaded execution, access to shard ID and checkpointer.
processRecord
(ShardId, Record, Checkpointer) => Unit : Kinesis record handler
evReader
evidence that A has implementation of KinesisRecordReader implicitly available in scope
val shutdown: (String, IRecordProcessorCheckpointer, ShutdownReason) ⇒ Unit

(ShardId, Checkpointer, ShutdownReason) => Unit : additional code to execute on shutdown
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def trace(message: ⇒ String, ex: Throwable): Unit

Attributes
protected
Definition Classes
Loggable
def trace(message: ⇒ String): Unit

Attributes
protected
Definition Classes
Loggable
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
def warn(message: ⇒ String, ex: Throwable): Unit

Attributes
protected
Definition Classes
Loggable
def warn(message: ⇒ String): Unit

Attributes
protected
Definition Classes
Loggable
def withCheckpointInterval(cpi: FiniteDuration): KCLWorkerRunner

Override default checkpointInterval.
def withInitialize(init: (String) ⇒ Unit): KCLWorkerRunner

Override default (NOOP) init function.
def withMetricsFactory(factory: IMetricsFactory): KCLWorkerRunner
def withNumRetries(n: Int): KCLWorkerRunner

Override default num retries.
def withShutdown(sd: (String, IRecordProcessorCheckpointer, ShutdownReason) ⇒ Unit): KCLWorkerRunner

Override default (NOOP) shutdown function.

Related Doc: package client

Instance Constructors

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

val checkpointInterval: FiniteDuration

def clone(): AnyRef

val config: KinesisClientLibConfiguration

def debug(message: ⇒ String, ex: Throwable): Unit

def debug(message: ⇒ String): Unit

final def eq(arg0: AnyRef): Boolean

def error(message: ⇒ String, ex: Throwable): Unit

def error(message: ⇒ String): Unit

def error(ex: Throwable): Unit

def fatal(message: ⇒ String, ex: Throwable): Unit

def fatal(message: ⇒ String): Unit

def fatal(ex: Throwable): Unit

def finalize(): Unit

final def getClass(): Class[_]

def info(message: ⇒ String, ex: Throwable): Unit

def info(message: ⇒ String): Unit

val initialRetryDelay: Duration

val initialize: (String) ⇒ Unit

final def isInstanceOf[T0]: Boolean

val maxRetryDelay: FiniteDuration

val metricsFactory: Option[IMetricsFactory]

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

val numRetries: Int

def runAsyncSingleRecordProcessor[A](callbackTimeout: FiniteDuration)(processRecord: (A) ⇒ Future[Unit])(implicit executor: ExecutionContext, evReader: KinesisRecordReader[A]): Unit

def runBatchProcessor[A](processRecords: (String, Seq[A], IRecordProcessorCheckpointer) ⇒ Unit)(implicit evReader: KinesisRecordReader[A]): Unit

def runSingleRecordProcessor[A](processRecord: (String, A, IRecordProcessorCheckpointer) ⇒ Unit)(implicit evReader: KinesisRecordReader[A]): Unit

val shutdown: (String, IRecordProcessorCheckpointer, ShutdownReason) ⇒ Unit

final def synchronized[T0](arg0: ⇒ T0): T0

def trace(message: ⇒ String, ex: Throwable): Unit

def trace(message: ⇒ String): Unit

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

def warn(message: ⇒ String, ex: Throwable): Unit

def warn(message: ⇒ String): Unit

def withCheckpointInterval(cpi: FiniteDuration): KCLWorkerRunner

def withInitialize(init: (String) ⇒ Unit): KCLWorkerRunner

def withMetricsFactory(factory: IMetricsFactory): KCLWorkerRunner

def withNumRetries(n: Int): KCLWorkerRunner

def withShutdown(sd: (String, IRecordProcessorCheckpointer, ShutdownReason) ⇒ Unit): KCLWorkerRunner

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from Loggable

Inherited from AnyRef

Inherited from Any

Ungrouped