Packages

o

kinesis4cats.kcl.fs2.localstack

LocalstackKCLConsumerFS2

object LocalstackKCLConsumerFS2

Helpers for constructing and leveraging the KCL with Localstack via FS2.

Source
LocalstackKCLConsumerFS2.scala
Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. LocalstackKCLConsumerFS2
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  9. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. def kclConfig[F[_]](streamName: String, appName: String, prefix: Option[String] = None, workerId: String = Utils.randomUUIDString, position: InitialPositionInStreamExtended = InitialPositionInStreamExtended.newInitialPosition(
    InitialPositionInStream.TRIM_HORIZON
    )
    , processConfig: ProcessConfig = KCLConsumerFS2.defaultProcessConfig)
    (implicit F: Async[F], LE: LogEncoders): Resource[F, Config[F]]

    Creates a KCLConsumerFS2.Config that is compliant with Localstack.

    Creates a KCLConsumerFS2.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 with autoCommit set to false

    F

    Async

    LE

    RecordProcessor.LogEncoders

    returns

    KCLConsumerFS2.Config

  12. def kclConfig[F[_]](config: LocalstackConfig, streamName: String, appName: String, workerId: String, position: InitialPositionInStreamExtended, processConfig: ProcessConfig)(implicit F: Async[F], LE: LogEncoders): Resource[F, Config[F]]

    Creates a KCLConsumerFS2.Config that is compliant with Localstack.

    Creates a KCLConsumerFS2.Config that is compliant with Localstack.

    config

    LocalstackConfig

    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

    InitialPositionInStreamExtended

    processConfig

    KCLConsumer.ProcessConfig

    F

    Async

    LE

    RecordProcessor.LogEncoders

    returns

    KCLConsumerFS2.Config

  13. def kclConsumer[F[_]](streamName: String, appName: String, prefix: Option[String] = None, workerId: String = Utils.randomUUIDString, position: InitialPositionInStreamExtended = InitialPositionInStreamExtended.newInitialPosition(
    InitialPositionInStream.TRIM_HORIZON
    )
    , processConfig: ProcessConfig = KCLConsumerFS2.defaultProcessConfig)
    (implicit F: Async[F], P: Parallel[F], LE: LogEncoders): Resource[F, KCLConsumerFS2[F]]

    Runs a KCLConsumerFS2 that is compliant with Localstack.

    Runs a KCLConsumerFS2 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 with autoCommit set to false

    F

    Async

    LE

    RecordProcessor.LogEncoders

    returns

    KCLConsumerFS2 in a Resource

  14. def kclConsumer[F[_]](config: LocalstackConfig, streamName: String, appName: String, workerId: String, position: InitialPositionInStreamExtended, processConfig: ProcessConfig)(implicit F: Async[F], P: Parallel[F], LE: LogEncoders): Resource[F, KCLConsumerFS2[F]]

    Runs a KCLConsumerFS2 that is compliant with Localstack.

    Runs a KCLConsumerFS2 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

    LocalstackConfig

    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

    InitialPositionInStreamExtended

    processConfig

    KCLConsumer.ProcessConfig

    F

    Async

    LE

    RecordProcessor.LogEncoders

    returns

    kinesis4cats.kcl.fs2.KCLConsumerFS2 in a Resource

  15. def kclMultiConfig[F[_]](tracker: MultiStreamTracker, appName: String, prefix: Option[String] = None, workerId: String = Utils.randomUUIDString, processConfig: ProcessConfig = KCLConsumerFS2.defaultProcessConfig)(implicit F: Async[F], LE: LogEncoders): Resource[F, Config[F]]

    Creates a KCLConsumerFS2.Config that is compliant with Localstack.

    Creates a KCLConsumerFS2.Config that is compliant with Localstack.

    tracker

    MultiStreamTracker

    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 Default is TRIM_HORIZON

    processConfig

    KCLConsumer.ProcessConfig Default is ProcessConfig.default with autoCommit set to false

    F

    Async

    LE

    RecordProcessor.LogEncoders

    returns

    KCLConsumerFS2.Config

  16. def kclMultiConfig[F[_]](config: LocalstackConfig, tracker: MultiStreamTracker, appName: String, workerId: String, processConfig: ProcessConfig)(implicit F: Async[F], LE: LogEncoders): Resource[F, Config[F]]

    Creates a KCLConsumerFS2.Config that is compliant with Localstack.

    Creates a KCLConsumerFS2.Config that is compliant with Localstack.

    config

    LocalstackConfig

    tracker

    MultiStreamTracker

    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

    KCLConsumer.ProcessConfig

    F

    Async

    LE

    RecordProcessor.LogEncoders

    returns

    KCLConsumerFS2.Config

  17. def kclMultiConsumer[F[_]](tracker: MultiStreamTracker, appName: String, prefix: Option[String] = None, workerId: String = Utils.randomUUIDString, processConfig: ProcessConfig = KCLConsumerFS2.defaultProcessConfig)(implicit F: Async[F], P: Parallel[F], LE: LogEncoders): Resource[F, KCLConsumerFS2[F]]

    Runs a KCLConsumerFS2 that is compliant with Localstack.

    Runs a KCLConsumerFS2 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

    MultiStreamTracker

    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 with autoCommit set to false

    F

    Async

    LE

    RecordProcessor.LogEncoders

    returns

    KCLConsumerFS2 in a Resource

  18. def kclMultiConsumer[F[_]](config: LocalstackConfig, tracker: MultiStreamTracker, appName: String, workerId: String, processConfig: ProcessConfig)(implicit F: Async[F], P: Parallel[F], LE: LogEncoders): Resource[F, KCLConsumerFS2[F]]

    Runs a KCLConsumerFS2 that is compliant with Localstack.

    Runs a KCLConsumerFS2 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

    LocalstackConfig

    tracker

    MultiStreamTracker

    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

    KCLConsumer.ProcessConfig

    F

    Async

    LE

    RecordProcessor.LogEncoders

    returns

    kinesis4cats.kcl.fs2.KCLConsumerFS2 in a Resource

  19. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  21. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  22. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  23. def toString(): String
    Definition Classes
    AnyRef → Any
  24. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  25. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  26. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

Inherited from AnyRef

Inherited from Any

Ungrouped