Class KinesisFlow

A container for factory methods used to build Akka.NET Streams flows to an Amazon Kinesis streams. Flows can be used to send data to Kinesis streams. They handle acknowledgments, retries and rate limiting necessary to fit into AWS Kinesis constraints.

Inheritance

Object

KinesisFlow

Inherited Members

Object.Equals(Object)

Object.Equals(Object, Object)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ReferenceEquals(Object, Object)

Object.ToString()

Namespace: Akka.Streams.Kinesis

Assembly: Akka.Streams.Kinesis.dll

Syntax

public static class KinesisFlow

Methods

| Improve this Doc View Source

ByPartitionAndBytes(String, KinesisFlowSettings, Func<IAmazonKinesis>)

Creates a flow that produces and inserts records to Amazon Kinsesis for a given (partition-key, message-payload) pair.

Declaration

public static Flow<(string, ByteString), PutRecordsResultEntry, NotUsed> ByPartitionAndBytes(string streamName, KinesisFlowSettings settings = null, Func<IAmazonKinesis> client = null)

Parameters

Type	Name	Description
String	streamName	Name of a stream. It must be present before using it.
KinesisFlowSettings	settings
Func<Amazon.Kinesis.IAmazonKinesis>	client	Amazon Kinesis client factory. After materialization, current Akka.NET Stream will take responsibility for managing that client, disposing it once stream will be stopped.

Returns

Type	Description
Akka.Streams.Dsl.Flow<System.ValueTuple<String, Akka.IO.ByteString>, Amazon.Kinesis.Model.PutRecordsResultEntry, Akka.NotUsed>

| Improve this Doc View Source

ByPartitionAndData(String, KinesisFlowSettings, Func<IAmazonKinesis>)

Creates a flow that produces and inserts records to Amazon Kinsesis for a given (partition-key, message-payload) pair.

Declaration

public static Flow<(string, MemoryStream), PutRecordsResultEntry, NotUsed> ByPartitionAndData(string streamName, KinesisFlowSettings settings = null, Func<IAmazonKinesis> client = null)

Parameters

Type	Name	Description
String	streamName	Name of a stream. It must be present before using it.
KinesisFlowSettings	settings
Func<Amazon.Kinesis.IAmazonKinesis>	client	Amazon Kinesis client factory. After materialization, current Akka.NET Stream will take responsibility for managing that client, disposing it once stream will be stopped.

Returns

Type	Description
Akka.Streams.Dsl.Flow<System.ValueTuple<String, MemoryStream>, Amazon.Kinesis.Model.PutRecordsResultEntry, Akka.NotUsed>

| Improve this Doc View Source

Create(String, KinesisFlowSettings, Func<IAmazonKinesis>)

Creates a default flow used to send raw records to Amazon Kinesis.

Declaration

public static Flow<PutRecordsRequestEntry, PutRecordsResultEntry, NotUsed> Create(string streamName, KinesisFlowSettings settings = null, Func<IAmazonKinesis> client = null)

Parameters

Type	Name	Description
String	streamName	Name of a stream. It must be present before using it.
KinesisFlowSettings	settings
Func<Amazon.Kinesis.IAmazonKinesis>	client	Amazon Kinesis client factory. After materialization, current Akka.NET Stream will take responsibility for managing that client, disposing it once stream will be stopped.

Returns

Type	Description
Akka.Streams.Dsl.Flow<Amazon.Kinesis.Model.PutRecordsRequestEntry, Amazon.Kinesis.Model.PutRecordsResultEntry, Akka.NotUsed>