Packages

object KCLConsumer

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

Type Members

  1. final case class Config[F[_]] extends Product with Serializable

    Config class for the KCLConsumer

  2. final case class ProcessConfig(raiseOnError: Boolean, recordProcessorConfig: RecordProcessor.Config, callProcessRecordsEvenForEmptyRecordList: Option[Boolean]) extends Product with Serializable

    Helper class to hold configuration for the ProcessorConfig construction

    Helper class to hold configuration for the ProcessorConfig construction

    raiseOnError

    Whether the RecordProcessor should raise exceptions or simply log them. It is recommended to set this to true. See this issue for more information.

    recordProcessorConfig

    RecordProcessor.Config

    callProcessRecordsEvenForEmptyRecordList

    Determines if processRecords() should run on the record processor for empty record lists. Default None.

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. def apply[F[_]](checkpointConfig: CheckpointConfig, coordinatorConfig: CoordinatorConfig, leaseManagementConfig: LeaseManagementConfig, lifecycleConfig: LifecycleConfig, metricsConfig: MetricsConfig, retrievalConfig: RetrievalConfig, processConfig: ProcessConfig = ProcessConfig.default)(cb: (List[CommittableRecord[F]]) => F[Unit])(implicit F: Async[F], encoders: LogEncoders): Resource[F, KCLConsumer[F]]

    Low-level constructor for the KCLConsumer.

    Low-level constructor for the KCLConsumer.

    checkpointConfig

    CheckpointConfig

    coordinatorConfig

    CoordinatorConfig

    leaseManagementConfig

    LeaseManagementConfig

    lifecycleConfig

    LifecycleConfig

    metricsConfig

    MetricsConfig

    retrievalConfig

    RetrievalConfig

    processConfig

    KCLConsumer.ProcessConfig

    cb

    Function to process CommittableRecords received from Kinesis

    F

    Async instance

    encoders

    RecordProcessor.LogEncoders for encoding structured logs

    returns

    Resource containing the KCLConsumer

  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  7. def configsBuilder[F[_]](kinesisClient: KinesisAsyncClient, dynamoClient: DynamoDbAsyncClient, cloudWatchClient: CloudWatchAsyncClient, streamTracker: StreamTracker, appName: String, workerId: String = Utils.randomUUIDString, processConfig: ProcessConfig = ProcessConfig.default)(cb: (List[CommittableRecord[F]]) => F[Unit])(tfn: (Config[F]) => Config[F] = (x: Config[F]) => x)(implicit F: Async[F], encoders: LogEncoders): Resource[F, KCLConsumer[F]]

    Constructor for the KCLConsumer that leverages the ConfigsBuilder from the KCL.

    Constructor for the KCLConsumer that leverages the ConfigsBuilder from the KCL. This is a simpler entry-point for creating the configuration, and provides a transform function to add any custom configuration that was not covered by the default

    kinesisClient

    KinesisAsyncClient

    dynamoClient

    DynamoDbAsyncClient

    cloudWatchClient

    CloudWatchClient

    streamTracker

    StreamTracker to use, which defines the name of the stream(s) and the initial position within them

    appName

    Name of the application. Usually also the dynamo table name for checkpoints

    workerId

    Unique identifier for a single instance of this consumer. Default is a random UUID.

    processConfig

    KCLConsumer.ProcessConfig

    cb

    Function to process CommittableRecords received from Kinesis

    tfn

    Function to update the KCLConsumer.Config. Useful for overriding defaults.

    F

    Async instance

    encoders

    RecordProcessor.LogEncoders for encoding structured logs

  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  10. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  11. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  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() @IntrinsicCandidate()
  15. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  16. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  17. def toString(): String
    Definition Classes
    AnyRef → Any
  18. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  19. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  20. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  21. object Config extends Serializable
  22. object ProcessConfig extends Serializable

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