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

fs2.aws.dynamodb

package fs2.aws.dynamodb

Members list

Packages

package fs2.aws.dynamodb.models

Type members

Classlikes

case class CommittableRecord(shardId: String, recordProcessorStartingSequenceNumber: ExtendedSequenceNumber, millisBehindLatest: Long, record: RecordAdapter, recordProcessor: RecordProcessor, checkpointer: IRecordProcessorCheckpointer, inFlightRecordsPhaser: Phaser)

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 DefaultDynamoStreamBuilder

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
class DefaultDynamoStreamBuilder[F[_]] extends DynamoDBStreamBuilder[F]

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
trait DynamoDB[F[_]]

Attributes

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

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
DynamoDB.type
abstract class DynamoDBStreamBuilder[F[_]]

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
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 KinesisStreamSettings

Settings for configuring the Kinesis consumer stream

Settings for configuring the Kinesis consumer stream

Value parameters

bufferSize

size of the internal buffer used when reading messages from Kinesis

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
object KinesisStreamSettings

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
class RecordProcessor(cb: CommittableRecord => Unit) extends IRecordProcessor

Concrete implementation of the AWS RecordProcessor interface. Wraps incoming records into CommitableRecord types to allow for downstream checkpointing

Concrete implementation of the AWS RecordProcessor interface. Wraps incoming records into CommitableRecord types to allow for downstream checkpointing

Value parameters

cb

callback function to run on record receive, passing the new CommittableRecord

Attributes

Constructor

create a new instance with a callback function to perform on record receive

Supertypes
trait IRecordProcessor
class Object
trait Matchable
class Any
trait StreamScan[F[_]]

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
object StreamScan

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
StreamScan.type
Generated with