class KCLConsumer[F[_]] extends AnyRef
- Alphabetic
- By Inheritance
- KCLConsumer
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
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()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- def run(): Resource[F, Unit]
Runs a KCL Consumer in the background as a Resource
Runs a KCL Consumer in the background as a Resource
- returns
Resource that manages the lifecycle of the KCL Consumer
- def runWithDeferredListener(stateToCompleteOn: WorkerState = WorkerState.STARTED): Resource[F, Deferred[F, Unit]]
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
runWithRefListener
, 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 that manages the lifecycle of the KCL Consumer
- def runWithRefListener(): Resource[F, Ref[F, WorkerState]]
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.
- returns
Resource that manages the lifecycle of the KCL Consumer
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- 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()