fs2-aws-kinesis
API
Generated with
fs2-aws-kinesis/fs2.aws/fs2.aws.kinesis

fs2.aws.kinesis

package fs2.aws.kinesis

Members list

Packages

package fs2.aws.kinesis.models

Type members

Classlikes

case class CommittableRecord(shardId: String, recordProcessorStartingSequenceNumber: ExtendedSequenceNumber, millisBehindLatest: Long, record: KinesisClientRecord, recordProcessor: ChunkedRecordProcessor, checkpointer: RecordProcessorCheckpointer, lastRecordSemaphore: Semaphore, isLastInShard: Boolean)

A message type from Kinesis which has not yet been commited or checkpointed.

A message type from Kinesis which has not yet been commited or checkpointed.

Value parameters

checkpointer

reference to the checkpointer used to commit this record

millisBehindLatest

ms behind the latest record, used to detect if the consumer is lagging the producer

record

the original record document from Kinesis

recordProcessor

reference to the record processor that is responsible for processing this message

shardId

the unique identifier for the shard from which this record originated

Attributes

Constructor

create a new commitable record with a name and age.

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object CommittableRecord

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
object DefaultKinesisStreamBuilder

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
class DefaultKinesisStreamBuilder[F[_]] extends KinesisStreamBuilder[F]

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
case object FanOut extends RetrievalMode

Attributes

Supertypes
trait Singleton
trait Product
trait Mirror
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Self type
FanOut.type
trait Kinesis[F[_]]

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class GenericKinesis[F]
object Kinesis

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
Kinesis.type
class KinesisCheckpointSettings

Settings for configuring the Kinesis checkpointer pipe

Settings for configuring the Kinesis checkpointer pipe

Value parameters

maxBatchSize

the maximum number of records to aggregate before checkpointing the cluster of records. Passing 1 means checkpoint on every record

maxBatchWait

the maximum amount of time to wait before checkpointing the cluster of records

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
object KinesisCheckpointSettings

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
class KinesisConsumerSettings

Settings for configuring the Kinesis consumer

Settings for configuring the Kinesis consumer

Value parameters

appName

name of the application which the KCL daemon should assume

bufferSize

size of the internal buffer used when reading messages from Kinesis

region

AWS region in which the Kinesis stream resides. Defaults to US-EAST-1

retrievalMode

FanOut (push) or Polling (pull). Defaults to FanOut (the new default in KCL 2.x).

streamName

name of the Kinesis stream to read from

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
object KinesisConsumerSettings

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
abstract class KinesisStreamBuilder[F[_]]

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
case object Polling extends RetrievalMode

Attributes

Supertypes
trait Singleton
trait Product
trait Mirror
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Self type
Polling.type
sealed trait RetrievalMode

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
object FanOut.type
object Polling.type
object publisher

fs2 Streams for publishing data to AWS Kinesis streams

fs2 Streams for publishing data to AWS Kinesis streams

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
publisher.type
Generated with