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()

6.  val commitRecords: Pipe[F, CommittableRecord[F], CommittableRecord[F]]

   A Pipe definition that users can leverage to commit the records after they have completed processing.

   A Pipe definition that users can leverage to commit the records after they have completed processing.

   returns

   Pipe for committing records.

7.  final def eq(arg0: AnyRef): Boolean

   Definition Classes

   AnyRef

8.  def equals(arg0: AnyRef): Boolean

   Definition Classes

   AnyRef → Any

9.  def finalize(): Unit

   Attributes

   protected[lang]

   Definition Classes

   AnyRef

   Annotations

   @throws(classOf[java.lang.Throwable])

10.  final def getClass(): Class[_ <: AnyRef]

    Definition Classes

    AnyRef → Any

    Annotations

    @native()

11.  def hashCode(): Int

    Definition Classes

    AnyRef → Any

    Annotations

    @native()

12.  final def isInstanceOf[T0]: Boolean

    Definition Classes

    Any

13.  final def ne(arg0: AnyRef): Boolean

    Definition Classes

    AnyRef

14.  final def notify(): Unit

    Definition Classes

    AnyRef

    Annotations

    @native()

15.  final def notifyAll(): Unit

    Definition Classes

    AnyRef

    Annotations

    @native()

16.  def stream(): Resource[F, Stream[F, CommittableRecord[F]]]

    Runs a KCL Consumer as an fs2.Stream

    Runs a KCL Consumer as an fs2.Stream

    returns

    fs2.Stream that manages the lifecycle of the KCL Consumer

17.  def streamWithDeferredListener(stateToCompleteOn: WorkerState = WorkerState.STARTED): Resource[F, StreamAndDeferred[F]]

    Runs a KCL Consumer in the background as a Resource.

    Runs a KCL Consumer in the background as a Resource. This exposes the WorkerState which can be used as a means to determine if the KCL Consumer is running. A common use case for this is to service healthcheck endpoints when running these in an orchestration service (e.g. Kubernetes or AWS ECS) or running tests that require the consumer to be up before an assertion is checked.

    Unlike streamWithRefListener, this method uses a Deferred instance. This is useful when you only need to react when the KCL has reached a specific state 1 time (e.g. wait to produce to a stream until the consumer is started)

    stateToCompleteOn

    WorkerState to expect when completing the Deferred. Default is STARTED.

    returns

    Resource containing an fs2.Stream and Deferred

18.  def streamWithRefListener(): Resource[F, StreamAndRef[F]]

    Runs a KCL Consumer as an fs2.Stream.

    Runs a KCL Consumer as an fs2.Stream. This exposes the WorkerState which can be used as a means to determine if the KCL Consumer is running. A common use case for this is to service healthcheck endpoints when running these in an orchestration service (e.g. Kubernetes or AWS ECS) or running tests that require the consumer to be up before an assertion is checked.

    returns

    Resource containing an fs2.Stream and Deferred

19.  final def synchronized[T0](arg0: => T0): T0

    Definition Classes

    AnyRef

20.  def toString(): String

    Definition Classes

    AnyRef → Any

21.  final def wait(): Unit

    Definition Classes

    AnyRef

    Annotations

    @throws(classOf[java.lang.InterruptedException])

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

    Definition Classes

    AnyRef

    Annotations

    @throws(classOf[java.lang.InterruptedException])

23.  final def wait(arg0: Long): Unit

    Definition Classes

    AnyRef

    Annotations

    @throws(classOf[java.lang.InterruptedException]) @native()