public ShardSettings(string streamName, string shardId, ShardIteratorType shardIteratorType, TimeSpan refreshInterval, int limit, string startingSequenceNumber = null, DateTime? atTimestamp = default(DateTime? ))

Parameters

Type	Name	Description
String	streamName
String	shardId
Amazon.Kinesis.ShardIteratorType	shardIteratorType
TimeSpan	refreshInterval
Int32	limit
String	startingSequenceNumber
Nullable<DateTime>	atTimestamp

Properties

| Improve this Doc View Source

AtTimestamp

Declaration

public DateTime? AtTimestamp { get; }

Property Value

Type	Description
Nullable<DateTime>

| Improve this Doc View Source

Limit

KinesisSource is polling Amazon Kinesis in batches. This value must be between 0 and 10 000. Default value: 500

Declaration

public int Limit { get; }

Property Value

Type	Description
Int32

| Improve this Doc View Source

RefreshInterval

KinesisSource is polling Amazon Kinesis accordingly to a given interval. Default value: 1 second.

Declaration

public TimeSpan RefreshInterval { get; }

Property Value

Type	Description
TimeSpan

| Improve this Doc View Source

ShardId

Shard identifier for a given stream. To merge data from multiple kinesis shards, you can use Akka.Streams.Dsl.SourceOperations.Merge``3(Akka.Streams.Dsl.Source{``0,``2},Akka.Streams.IGraph{Akka.Streams.SourceShape{``1},``2},System.Boolean) method.

Declaration

public string ShardId { get; }

Property Value

Type	Description
String

| Improve this Doc View Source

ShardIteratorType

Type of shard iterator defined for Amazon Kinesis client. Default value: Amazon.Kinesis.ShardIteratorType.LATEST

Declaration

public ShardIteratorType ShardIteratorType { get; }

Property Value

Type	Description
Amazon.Kinesis.ShardIteratorType

| Improve this Doc View Source

StartingSequenceNumber

A starting sequence number, from which the source should continue fetching the data. Default value: null

Declaration

public string StartingSequenceNumber { get; }

Property Value

Type	Description
String

| Improve this Doc View Source

StreamName

Name of a stream to start receiving data from.

Declaration

public string StreamName { get; }

Property Value

Type	Description
String

Methods

| Improve this Doc View Source

Create(String, String)

Creates a new instance of ShardSettings class.

Declaration

public static ShardSettings Create(string streamName, string shardId)

Parameters

Type	Name	Description
String	streamName	Name of Amazon Kinesis stream. It must be already present.
String	shardId	Name of an Amazon Kinesis shard in context of stream with provided `streamName`.

Returns

Type	Description
ShardSettings

| Improve this Doc View Source

WithAtTimestamp(DateTime)

Declaration

public ShardSettings WithAtTimestamp(DateTime atTimestamp)

Parameters

Type	Name	Description
DateTime	atTimestamp

Returns

Type	Description
ShardSettings

| Improve this Doc View Source

WithLimit(Int32)

Declaration

public ShardSettings WithLimit(int limit)

Parameters

Type	Name	Description
Int32	limit

Returns

Type	Description
ShardSettings

| Improve this Doc View Source

WithRefreshInterval(TimeSpan)

Declaration

public ShardSettings WithRefreshInterval(TimeSpan refreshInterval)

Parameters

Type	Name	Description
TimeSpan	refreshInterval

Returns

Type	Description
ShardSettings

| Improve this Doc View Source

WithShardIteratorType(ShardIteratorType)

Declaration

public ShardSettings WithShardIteratorType(ShardIteratorType shardIteratorType)

Parameters

Type	Name	Description
Amazon.Kinesis.ShardIteratorType	shardIteratorType

Returns

Type	Description
ShardSettings

| Improve this Doc View Source

WithStartingSequenceNumber(String)

Declaration

public ShardSettings WithStartingSequenceNumber(string startingSequenceNumber)

Parameters

Type	Name	Description
String	startingSequenceNumber

Returns

Type	Description
ShardSettings