Packages

c

fs2.aws.kinesis.Kinesis

GenericKinesis

abstract class GenericKinesis[F[_]] extends Kinesis[F]

Linear Supertypes
Kinesis[F], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. GenericKinesis
  2. Kinesis
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new GenericKinesis()(implicit arg0: Async[F], arg1: Concurrent[F])

Abstract Value Members

  1. abstract def readChunkedFromKinesisStream(consumerConfig: KinesisConsumerSettings): 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

    consumerConfig

    configuration parameters for the KCL

    returns

    an infinite fs2 Stream that emits Kinesis Records Chunks

    Definition Classes
    Kinesis

Concrete 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(checkpointSettings: KinesisCheckpointSettings): 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

    checkpointSettings

    configure maxBatchSize and maxBatchWait time before triggering a checkpoint

    returns

    a stream of Record types representing checkpointed messages

    Definition Classes
    GenericKinesisKinesis
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  9. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  14. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  15. def readFromKinesisStream(consumerConfig: KinesisConsumerSettings): 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

    consumerConfig

    configuration parameters for the KCL

    returns

    an infinite fs2 Stream that emits Kinesis Records

    Definition Classes
    Kinesis
  16. def readFromKinesisStream(appName: String, streamName: String): 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

    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

    Definition Classes
    Kinesis
  17. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  18. def toString(): String
    Definition Classes
    AnyRef → Any
  19. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  20. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  21. 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

    (Since version 9)

Inherited from Kinesis[F]

Inherited from AnyRef

Inherited from Any

Ungrouped