object LocalstackKCLConsumer
Helpers for constructing and leveraging the KPL with Localstack.
- Alphabetic
- By Inheritance
- LocalstackKCLConsumer
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Type Members
- final case class ConfigWithResults[F[_]](kclConfig: Config[F], resultsQueue: Queue[F, CommittableRecord[F]]) extends Product with Serializable
- final case class DeferredWithResults[F[_]](deferred: Deferred[F, Unit], resultsQueue: Queue[F, CommittableRecord[F]]) extends Product with Serializable
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
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @IntrinsicCandidate()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @IntrinsicCandidate()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def kclConfig[F[_]](streamName: String, appName: String, prefix: Option[String] = None, workerId: String = Utils.randomUUIDString, position: InitialPositionInStreamExtended = InitialPositionInStreamExtended.newInitialPosition(
InitialPositionInStream.TRIM_HORIZON
), processConfig: ProcessConfig = KCLConsumer.ProcessConfig.default)(cb: (List[CommittableRecord[F]]) => F[Unit])(implicit F: Async[F], LE: LogEncoders): Resource[F, Config[F]]Creates a KCLConsumer.Config that is compliant with Localstack.
Creates a KCLConsumer.Config that is compliant with Localstack.
- streamName
Name of stream to consume
- appName
Application name for the consumer. Used for the dynamodb table name as well as the metrics namespace.
- prefix
Optional prefix for parsing configuration. Default to None
- workerId
Unique identifier for the worker. Default is a random UUID
- position
InitialPositionInStreamExtended Default is TRIM_HORIZON
- processConfig
KCLConsumer.ProcessConfig Default is
ProcessConfig.default- cb
User-defined callback function for processing records
- F
- LE
- returns
- def kclConfig[F[_]](config: LocalstackConfig, streamName: String, appName: String, workerId: String, position: InitialPositionInStreamExtended, processConfig: ProcessConfig)(cb: (List[CommittableRecord[F]]) => F[Unit])(implicit F: Async[F], LE: LogEncoders): Resource[F, Config[F]]
Creates a KCLConsumer.Config that is compliant with Localstack.
Creates a KCLConsumer.Config that is compliant with Localstack.
- config
- streamName
Name of stream to consume
- appName
Application name for the consumer. Used for the dynamodb table name as well as the metrics namespace.
- workerId
Unique identifier for the worker. Typically a UUID.
- position
- processConfig
- cb
User-defined callback function for processing records
- F
- LE
- returns
- def kclConfigWithResults[F[_]](streamName: String, appName: String, prefix: Option[String] = None, workerId: String = Utils.randomUUIDString, position: InitialPositionInStreamExtended = InitialPositionInStreamExtended.newInitialPosition(
InitialPositionInStream.TRIM_HORIZON
), processConfig: ProcessConfig = KCLConsumer.ProcessConfig.default, resultsQueueSize: Int = 50)(cb: (List[CommittableRecord[F]]) => F[Unit])(implicit F: Async[F], LE: LogEncoders): Resource[F, ConfigWithResults[F]]Creates a KCLConsumer.Config that is compliant with Localstack.
Creates a KCLConsumer.Config that is compliant with Localstack. Also creates a results queue for the consumer to stick results into. Helpful when confirming data that has been produced to a stream.
- streamName
Name of stream to consume
- appName
Application name for the consumer. Used for the dynamodb table name as well as the metrics namespace.
- prefix
Optional prefix for parsing configuration. Default to None
- workerId
Unique identifier for the worker. Default to random UUID
- position
- processConfig
KCLConsumer.ProcessConfig Default is
ProcessConfig.default- resultsQueueSize
Bounded size of the Queue. Default to 50.
- cb
User-defined callback function for processing records. This will run after the records are enqueued into the results queue
- F
- LE
- returns
- def kclConfigWithResults[F[_]](config: LocalstackConfig, streamName: String, appName: String, workerId: String, position: InitialPositionInStreamExtended, processConfig: ProcessConfig, resultsQueueSize: Int)(cb: (List[CommittableRecord[F]]) => F[Unit])(implicit F: Async[F], LE: LogEncoders): Resource[F, ConfigWithResults[F]]
Creates a KCLConsumer.Config that is compliant with Localstack.
Creates a KCLConsumer.Config that is compliant with Localstack. Also creates a results queue for the consumer to stick results into. Helpful when confirming data that has been produced to a stream.
- config
- streamName
Name of stream to consume
- appName
Application name for the consumer. Used for the dynamodb table name as well as the metrics namespace.
- workerId
Unique identifier for the worker. Typically a UUID.
- position
- processConfig
- resultsQueueSize
Bounded size of the Queue
- cb
User-defined callback function for processing records. This will run after the records are enqueued into the results queue
- F
- LE
- returns
- def kclConsumer[F[_]](streamName: String, appName: String, prefix: Option[String] = None, workerId: String = Utils.randomUUIDString, position: InitialPositionInStreamExtended = InitialPositionInStreamExtended.newInitialPosition(
InitialPositionInStream.TRIM_HORIZON
), processConfig: ProcessConfig = KCLConsumer.ProcessConfig.default)(cb: (List[CommittableRecord[F]]) => F[Unit])(implicit F: Async[F], LE: LogEncoders): Resource[F, Deferred[F, Unit]]Runs a KCLConsumer that is compliant with Localstack.
Runs a KCLConsumer that is compliant with Localstack. Also exposes a Deferred that will complete when the consumer has started processing records. Useful for allowing tests time for the consumer to start before processing the stream.
- streamName
Name of stream to consume
- appName
Application name for the consumer. Used for the dynamodb table name as well as the metrics namespace.
- prefix
Optional prefix for parsing configuration. Default to None
- workerId
Unique identifier for the worker. Default to a random UUID.
- position
InitialPositionInStreamExtended. Default to TRIM_HORIZON
- processConfig
KCLConsumer.ProcessConfig Default is
ProcessConfig.default- cb
User-defined callback function for processing records
- F
- LE
- returns
Deferred in a Resource, which completes when the consumer has started processing records
- def kclConsumer[F[_]](config: LocalstackConfig, streamName: String, appName: String, workerId: String, position: InitialPositionInStreamExtended, processConfig: ProcessConfig)(cb: (List[CommittableRecord[F]]) => F[Unit])(implicit F: Async[F], LE: LogEncoders): Resource[F, Deferred[F, Unit]]
Runs a KCLConsumer that is compliant with Localstack.
Runs a KCLConsumer that is compliant with Localstack. Also exposes a Deferred that will complete when the consumer has started processing records. Useful for allowing tests time for the consumer to start before processing the stream.
- config
- streamName
Name of stream to consume
- appName
Application name for the consumer. Used for the dynamodb table name as well as the metrics namespace.
- workerId
Unique identifier for the worker. Typically a UUID.
- position
- processConfig
- cb
User-defined callback function for processing records
- F
- LE
- returns
Deferred in a Resource, which completes when the consumer has started processing records
- def kclConsumerWithResults[F[_]](streamName: String, appName: String, prefix: Option[String] = None, workerId: String = Utils.randomUUIDString, position: InitialPositionInStreamExtended = InitialPositionInStreamExtended.newInitialPosition(
InitialPositionInStream.TRIM_HORIZON
), processConfig: ProcessConfig = KCLConsumer.ProcessConfig.default, resultsQueueSize: Int = 50)(cb: (List[CommittableRecord[F]]) => F[Unit])(implicit F: Async[F], LE: LogEncoders): Resource[F, DeferredWithResults[F]]Runs a KCLConsumer that is compliant with Localstack.
Runs a KCLConsumer that is compliant with Localstack. Exposes a Deferred that will complete when the consumer has started processing records, as well as a Queue for tracking the received records. Useful for allowing tests time for the consumer to start before processing the stream, and testing those records that have been received.
- streamName
Name of stream to consume
- appName
Application name for the consumer. Used for the dynamodb table name as well as the metrics namespace.
- prefix
Optional prefix for parsing configuration. Default to None
- workerId
Unique identifier for the worker. Default to a random UUID
- position
InitialPositionInStreamExtended. Default to TRIM_HORIZON.
- processConfig
KCLConsumer.ProcessConfig Default is
ProcessConfig.default- resultsQueueSize
Bounded size of the Queue. Default to 50.
- cb
User-defined callback function for processing records
- F
- LE
- returns
DeferredWithResults in a Resource, which completes when the consumer has started processing records
- def kclConsumerWithResults[F[_]](config: LocalstackConfig, streamName: String, appName: String, workerId: String, position: InitialPositionInStreamExtended, processConfig: ProcessConfig, resultsQueueSize: Int)(cb: (List[CommittableRecord[F]]) => F[Unit])(implicit F: Async[F], LE: LogEncoders): Resource[F, DeferredWithResults[F]]
Runs a KCLConsumer that is compliant with Localstack.
Runs a KCLConsumer that is compliant with Localstack. Exposes a Deferred that will complete when the consumer has started processing records, as well as a Queue for tracking the received records. Useful for allowing tests time for the consumer to start before processing the stream, and testing those records that have been received.
- config
- streamName
Name of stream to consume
- appName
Application name for the consumer. Used for the dynamodb table name as well as the metrics namespace.
- workerId
Unique identifier for the worker. Typically a UUID.
- position
- processConfig
- resultsQueueSize
Bounded size of the Queue.
- cb
User-defined callback function for processing records
- F
- LE
- returns
DeferredWithResults in a Resource, which completes when the consumer has started processing records
- def kclMultiConfig[F[_]](tracker: MultiStreamTracker, appName: String, prefix: Option[String] = None, workerId: String = Utils.randomUUIDString, processConfig: ProcessConfig = KCLConsumer.ProcessConfig.default)(cb: (List[CommittableRecord[F]]) => F[Unit])(implicit F: Async[F], LE: LogEncoders): Resource[F, Config[F]]
Creates a KCLConsumer.Config that is compliant with Localstack.
Creates a KCLConsumer.Config that is compliant with Localstack.
- tracker
- appName
Application name for the consumer. Used for the dynamodb table name as well as the metrics namespace.
- prefix
Optional prefix for parsing configuration. Default to None
- workerId
Unique identifier for the worker. Default is a random UUID
- processConfig
KCLConsumer.ProcessConfig Default is
ProcessConfig.default- cb
User-defined callback function for processing records
- F
- LE
- returns
- def kclMultiConfig[F[_]](config: LocalstackConfig, tracker: MultiStreamTracker, appName: String, workerId: String, processConfig: ProcessConfig)(cb: (List[CommittableRecord[F]]) => F[Unit])(implicit F: Async[F], LE: LogEncoders): Resource[F, Config[F]]
Creates a KCLConsumer.Config that is compliant with Localstack.
Creates a KCLConsumer.Config that is compliant with Localstack. Meant to be used with multi-stream consumers.
- config
- tracker
- appName
Application name for the consumer. Used for the dynamodb table name as well as the metrics namespace.
- workerId
Unique identifier for the worker. Typically a UUID.
- processConfig
- cb
User-defined callback function for processing records
- F
- LE
- returns
- def kclMultiConfigWithResults[F[_]](tracker: MultiStreamTracker, appName: String, prefix: Option[String] = None, workerId: String = Utils.randomUUIDString, processConfig: ProcessConfig = KCLConsumer.ProcessConfig.default, resultsQueueSize: Int = 50)(cb: (List[CommittableRecord[F]]) => F[Unit])(implicit F: Async[F], LE: LogEncoders): Resource[F, ConfigWithResults[F]]
Creates a KCLConsumer.Config that is compliant with Localstack.
Creates a KCLConsumer.Config that is compliant with Localstack. Also creates a results queue for the consumer to stick results into. Helpful when confirming data that has been produced to a stream.
- tracker
- appName
Application name for the consumer. Used for the dynamodb table name as well as the metrics namespace.
- prefix
Optional prefix for parsing configuration. Default to None
- workerId
Unique identifier for the worker. Default to random UUID
- processConfig
KCLConsumer.ProcessConfig Default is
ProcessConfig.default- resultsQueueSize
Bounded size of the Queue. Default to 50.
- cb
User-defined callback function for processing records. This will run after the records are enqueued into the results queue
- F
- LE
- returns
- def kclMultiConfigWithResults[F[_]](config: LocalstackConfig, tracker: MultiStreamTracker, appName: String, workerId: String, processConfig: ProcessConfig, resultsQueueSize: Int)(cb: (List[CommittableRecord[F]]) => F[Unit])(implicit F: Async[F], LE: LogEncoders): Resource[F, ConfigWithResults[F]]
Creates a KCLConsumer.Config that is compliant with Localstack.
Creates a KCLConsumer.Config that is compliant with Localstack. Also creates a results queue for the consumer to stick results into. Helpful when confirming data that has been produced to a stream. Intended to be used for testing a multi-stream consumer.
- config
- tracker
- appName
Application name for the consumer. Used for the dynamodb table name as well as the metrics namespace.
- workerId
Unique identifier for the worker. Typically a UUID.
- processConfig
- resultsQueueSize
Bounded size of the Queue
- cb
User-defined callback function for processing records. This will run after the records are enqueued into the results queue
- F
- LE
- returns
- def kclMultiConsumer[F[_]](tracker: MultiStreamTracker, appName: String, prefix: Option[String] = None, workerId: String = Utils.randomUUIDString, processConfig: ProcessConfig = KCLConsumer.ProcessConfig.default)(cb: (List[CommittableRecord[F]]) => F[Unit])(implicit F: Async[F], LE: LogEncoders): Resource[F, Deferred[F, Unit]]
Runs a KCLConsumer that is compliant with Localstack.
Runs a KCLConsumer that is compliant with Localstack. Also exposes a Deferred that will complete when the consumer has started processing records. Useful for allowing tests time for the consumer to start before processing the stream.
- tracker
- appName
Application name for the consumer. Used for the dynamodb table name as well as the metrics namespace.
- prefix
Optional prefix for parsing configuration. Default to None
- workerId
Unique identifier for the worker. Default to a random UUID.
- processConfig
KCLConsumer.ProcessConfig Default is
ProcessConfig.default- cb
User-defined callback function for processing records
- F
- LE
- returns
Deferred in a Resource, which completes when the consumer has started processing records
- def kclMultiConsumer[F[_]](config: LocalstackConfig, tracker: MultiStreamTracker, appName: String, workerId: String, processConfig: ProcessConfig)(cb: (List[CommittableRecord[F]]) => F[Unit])(implicit F: Async[F], LE: LogEncoders): Resource[F, Deferred[F, Unit]]
Runs a KCLConsumer that is compliant with Localstack.
Runs a KCLConsumer that is compliant with Localstack. Also exposes a Deferred that will complete when the consumer has started processing records. Useful for allowing tests time for the consumer to start before processing the stream.
- config
- tracker
- appName
Application name for the consumer. Used for the dynamodb table name as well as the metrics namespace.
- workerId
Unique identifier for the worker. Typically a UUID.
- processConfig
- cb
User-defined callback function for processing records
- F
- LE
- returns
Deferred in a Resource, which completes when the consumer has started processing records
- def kclMultiConsumerWithResults[F[_]](tracker: MultiStreamTracker, appName: String, prefix: Option[String] = None, workerId: String = Utils.randomUUIDString, processConfig: ProcessConfig = KCLConsumer.ProcessConfig.default, resultsQueueSize: Int = 50)(cb: (List[CommittableRecord[F]]) => F[Unit])(implicit F: Async[F], LE: LogEncoders): Resource[F, DeferredWithResults[F]]
Runs a KCLConsumer that is compliant with Localstack.
Runs a KCLConsumer that is compliant with Localstack. Exposes a Deferred that will complete when the consumer has started processing records, as well as a Queue for tracking the received records. Useful for allowing tests time for the consumer to start before processing the stream, and testing those records that have been received.
- tracker
- appName
Application name for the consumer. Used for the dynamodb table name as well as the metrics namespace.
- prefix
Optional prefix for parsing configuration. Default to None
- workerId
Unique identifier for the worker. Default to a random UUID Default to TRIM_HORIZON.
- processConfig
KCLConsumer.ProcessConfig Default is
ProcessConfig.default- resultsQueueSize
Bounded size of the Queue. Default to 50.
- cb
User-defined callback function for processing records
- F
- LE
- returns
DeferredWithResults in a Resource, which completes when the consumer has started processing records
- def kclMultiConsumerWithResults[F[_]](config: LocalstackConfig, tracker: MultiStreamTracker, appName: String, workerId: String, processConfig: ProcessConfig, resultsQueueSize: Int)(cb: (List[CommittableRecord[F]]) => F[Unit])(implicit F: Async[F], LE: LogEncoders): Resource[F, DeferredWithResults[F]]
Runs a KCLConsumer that is compliant with Localstack.
Runs a KCLConsumer that is compliant with Localstack. Exposes a Deferred that will complete when the consumer has started processing records, as well as a Queue for tracking the received records. Useful for allowing tests time for the consumer to start before processing the stream, and testing those records that have been received.
- config
- tracker
- appName
Application name for the consumer. Used for the dynamodb table name as well as the metrics namespace.
- workerId
Unique identifier for the worker. Typically a UUID.
- processConfig
- resultsQueueSize
Bounded size of the Queue.
- cb
User-defined callback function for processing records
- F
- LE
- returns
DeferredWithResults in a Resource, which completes when the consumer has started processing records
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @IntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @IntrinsicCandidate()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])