Class KinesisFlowSettings

Immutable settings class to be used by KinesisFlow factory methods.

Inheritance
Object
KinesisFlowSettings
Inherited Members
Namespace: Akka.Streams.Kinesis
Assembly: Akka.Streams.Kinesis.dll
Syntax
public sealed class KinesisFlowSettings

Constructors

| Improve this Doc View Source

KinesisFlowSettings(Int32, Int32, RetryBackoffStrategy, TimeSpan, Int32, Int32, Int32)

Declaration
public KinesisFlowSettings(int parallelism, int maxBatchSize, RetryBackoffStrategy backoffStrategy, TimeSpan retryInitialTimeout, int maxRecordsPerSecond, int maxBytesPerSecond, int maxRetries)
Parameters
Type Name Description
Int32 parallelism
Int32 maxBatchSize
RetryBackoffStrategy backoffStrategy
TimeSpan retryInitialTimeout
Int32 maxRecordsPerSecond
Int32 maxBytesPerSecond
Int32 maxRetries

Fields

| Improve this Doc View Source

Default

Default KinesisFlowSettings, assuming only 1 active shard.

Declaration
public static KinesisFlowSettings Default
Field Value
Type Description
KinesisFlowSettings

Properties

| Improve this Doc View Source

BackoffStrategy

A backoff strategy used when trying to redeliver failed send requests. Default value: Exponential

Declaration
public RetryBackoffStrategy BackoffStrategy { get; }
Property Value
Type Description
RetryBackoffStrategy
| Improve this Doc View Source

MaxBatchSize

Maximum size of a single batch of records send to Amazon Kinesis in a single packet. Default value: 500

Declaration
public int MaxBatchSize { get; }
Property Value
Type Description
Int32
| Improve this Doc View Source

MaxBytesPerSecond

Maximum total messages payload size send each second. This is used to avoid native Amazon Kinesis throttling mechanism, that will not allow to send more data that provided threshold. Default value: 1MB (1 000 000 bytes).

Declaration
public int MaxBytesPerSecond { get; }
Property Value
Type Description
Int32
| Improve this Doc View Source

MaxRecordsPerSecond

Maximum number of records send per second. This is used to avoid native Amazon Kinesis throttling mechanism, that will not allow to send more data that provided threshold. Default value: 1000

Declaration
public int MaxRecordsPerSecond { get; }
Property Value
Type Description
Int32
| Improve this Doc View Source

MaxRetries

Maximum number of retries allowed before stream will fail due to inability to push records. Default value: 5

Declaration
public int MaxRetries { get; }
Property Value
Type Description
Int32
| Improve this Doc View Source

Parallelism

Maximum number of concurrent put requests send to Amazon Kinesis. Default value: 2

Declaration
public int Parallelism { get; }
Property Value
Type Description
Int32
| Improve this Doc View Source

RetryInitialTimeout

Initial delay used before the attempt to redeliver failed put records. For Linear it stays the same. For Exponential it will grow exponentially (factor: 2). Default value: 500ms

Declaration
public TimeSpan RetryInitialTimeout { get; }
Property Value
Type Description
TimeSpan

Methods

| Improve this Doc View Source

WithBackoffStrategy(RetryBackoffStrategy)

Declaration
public KinesisFlowSettings WithBackoffStrategy(RetryBackoffStrategy backoffStrategy)
Parameters
Type Name Description
RetryBackoffStrategy backoffStrategy
Returns
Type Description
KinesisFlowSettings
| Improve this Doc View Source

WithMaxBatchSize(Int32)

Declaration
public KinesisFlowSettings WithMaxBatchSize(int maxBatchSize)
Parameters
Type Name Description
Int32 maxBatchSize
Returns
Type Description
KinesisFlowSettings
| Improve this Doc View Source

WithMaxBytesPerSecond(Int32)

Declaration
public KinesisFlowSettings WithMaxBytesPerSecond(int maxBytesPerSecond)
Parameters
Type Name Description
Int32 maxBytesPerSecond
Returns
Type Description
KinesisFlowSettings
| Improve this Doc View Source

WithMaxRecordsPerSecond(Int32)

Declaration
public KinesisFlowSettings WithMaxRecordsPerSecond(int maxRecordsPerSecond)
Parameters
Type Name Description
Int32 maxRecordsPerSecond
Returns
Type Description
KinesisFlowSettings
| Improve this Doc View Source

WithMaxRetries(Int32)

Declaration
public KinesisFlowSettings WithMaxRetries(int maxRetries)
Parameters
Type Name Description
Int32 maxRetries
Returns
Type Description
KinesisFlowSettings
| Improve this Doc View Source

WithParallelism(Int32)

Declaration
public KinesisFlowSettings WithParallelism(int parallelism)
Parameters
Type Name Description
Int32 parallelism
Returns
Type Description
KinesisFlowSettings
| Improve this Doc View Source

WithPRetryInitialTimeout(TimeSpan)

Declaration
public KinesisFlowSettings WithPRetryInitialTimeout(TimeSpan retryInitialTimeout)
Parameters
Type Name Description
TimeSpan retryInitialTimeout
Returns
Type Description
KinesisFlowSettings