Packages

o

fs2.aws.kinesis

consumer

object consumer

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. consumer
  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 checkpointRecords[F[_]](checkpointSettings: KinesisCheckpointSettings = KinesisCheckpointSettings.defaultInstance, parallelism: Int = 10)(implicit arg0: ConcurrentEffect[F], arg1: Timer[F]): Pipe[F, CommittableRecord, KinesisClientRecord]

    Pipe to checkpoint records in Kinesis, marking them as processed Groups records by shard id, so that each shard is subject to its own clustering of records After accumulating maxBatchSize or reaching maxBatchWait for a respective shard, the latest record is checkpointed By design, all records prior to the checkpointed record are also checkpointed in Kinesis

    Pipe to checkpoint records in Kinesis, marking them as processed Groups records by shard id, so that each shard is subject to its own clustering of records After accumulating maxBatchSize or reaching maxBatchWait for a respective shard, the latest record is checkpointed By design, all records prior to the checkpointed record are also checkpointed in Kinesis

    F

    effect type of the fs2 stream

    checkpointSettings

    configure maxBatchSize and maxBatchWait time before triggering a checkpoint

    returns

    a stream of Record types representing checkpointed messages

  6. def checkpointRecords_[F[_]](checkpointSettings: KinesisCheckpointSettings = KinesisCheckpointSettings.defaultInstance)(implicit F: ConcurrentEffect[F], timer: Timer[F]): Pipe[F, CommittableRecord, Unit]

    Sink to checkpoint records in Kinesis, marking them as processed Groups records by shard id, so that each shard is subject to its own clustering of records After accumulating maxBatchSize or reaching maxBatchWait for a respective shard, the latest record is checkpointed By design, all records prior to the checkpointed record are also checkpointed in Kinesis

    Sink to checkpoint records in Kinesis, marking them as processed Groups records by shard id, so that each shard is subject to its own clustering of records After accumulating maxBatchSize or reaching maxBatchWait for a respective shard, the latest record is checkpointed By design, all records prior to the checkpointed record are also checkpointed in Kinesis

    F

    effect type of the fs2 stream

    checkpointSettings

    configure maxBatchSize and maxBatchWait time before triggering a checkpoint

    returns

    a Sink that accepts a stream of CommittableRecords

  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  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() @HotSpotIntrinsicCandidate()
  11. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  12. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  13. def mkDefaultKinesisClient(settings: KinesisConsumerSettings): KinesisAsyncClient
  14. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  16. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  17. def readChunkedFromKinesisStream[F[_]](consumerConfig: KinesisConsumerSettings, kinesisClient: KinesisAsyncClient)(implicit arg0: ConcurrentEffect[F], arg1: ContextShift[F]): Stream[F, Chunk[CommittableRecord]]

    Initialize a worker and start streaming records from a Kinesis stream On stream finish (due to error or other), worker will be shutdown

    Initialize a worker and start streaming records from a Kinesis stream On stream finish (due to error or other), worker will be shutdown

    F

    effect type of the fs2 stream

    consumerConfig

    configuration parameters for the KCL

    kinesisClient

    preconfigured kineiss klient, usefull when you need STS access

    returns

    an infinite fs2 Stream that emits Kinesis Records Chunks

  18. def readChunkedFromKinesisStream[F[_]](consumerConfig: KinesisConsumerSettings)(implicit arg0: ConcurrentEffect[F], arg1: ContextShift[F]): Stream[F, Chunk[CommittableRecord]]

    Initialize a worker and start streaming records from a Kinesis stream On stream finish (due to error or other), worker will be shutdown

    Initialize a worker and start streaming records from a Kinesis stream On stream finish (due to error or other), worker will be shutdown

    F

    effect type of the fs2 stream

    consumerConfig

    configuration parameters for the KCL

    returns

    an infinite fs2 Stream that emits Kinesis Records Chunks

  19. def readFromKinesisStream[F[_]](consumerConfig: KinesisConsumerSettings, kinesisClient: KinesisAsyncClient)(implicit arg0: ConcurrentEffect[F], arg1: ContextShift[F]): Stream[F, CommittableRecord]

    Initialize a worker and start streaming records from a Kinesis stream On stream finish (due to error or other), worker will be shutdown

    Initialize a worker and start streaming records from a Kinesis stream On stream finish (due to error or other), worker will be shutdown

    F

    effect type of the fs2 stream

    consumerConfig

    configuration parameters for the KCL

    kinesisClient

    preconfigured kineiss klient, usefull when you need STS access

    returns

    an infinite fs2 Stream that emits Kinesis Records

  20. def readFromKinesisStream[F[_]](appName: String, streamName: String, kinesisClient: KinesisAsyncClient)(implicit arg0: ConcurrentEffect[F], arg1: ContextShift[F], rt: RaiseThrowable[F]): Stream[F, CommittableRecord]

    Intialize a worker and start streaming records from a Kinesis stream On stream finish (due to error or other), worker will be shutdown

    Intialize a worker and start streaming records from a Kinesis stream On stream finish (due to error or other), worker will be shutdown

    F

    effect type of the fs2 stream

    appName

    name of the Kinesis application. Used by KCL when resharding

    streamName

    name of the Kinesis stream to consume from

    kinesisClient

    preconfigured kineiss klient, usefull when you need STS access

    returns

    an infinite fs2 Stream that emits Kinesis Records

  21. def readFromKinesisStream[F[_]](consumerConfig: KinesisConsumerSettings)(implicit arg0: ConcurrentEffect[F], arg1: ContextShift[F]): Stream[F, CommittableRecord]

    Initialize a worker and start streaming records from a Kinesis stream On stream finish (due to error or other), worker will be shutdown

    Initialize a worker and start streaming records from a Kinesis stream On stream finish (due to error or other), worker will be shutdown

    F

    effect type of the fs2 stream

    consumerConfig

    configuration parameters for the KCL

    returns

    an infinite fs2 Stream that emits Kinesis Records

  22. def readFromKinesisStream[F[_]](appName: String, streamName: String)(implicit arg0: ConcurrentEffect[F], arg1: ContextShift[F], rt: RaiseThrowable[F]): Stream[F, CommittableRecord]

    Intialize a worker and start streaming records from a Kinesis stream On stream finish (due to error or other), worker will be shutdown

    Intialize a worker and start streaming records from a Kinesis stream On stream finish (due to error or other), worker will be shutdown

    F

    effect type of the fs2 stream

    appName

    name of the Kinesis application. Used by KCL when resharding

    streamName

    name of the Kinesis stream to consume from

    returns

    an infinite fs2 Stream that emits Kinesis Records

  23. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  24. def toString(): String
    Definition Classes
    AnyRef → Any
  25. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  26. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  27. 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