software.amazon.kinesis.processor

Interface StreamTracker

All Known Subinterfaces:

MultiStreamTracker

All Known Implementing Classes:

SingleStreamTracker

public interface StreamTracker

Interface for stream trackers. KCL will periodically probe this interface to learn about the new and old streams.

Field Summary

Fields

Modifier and Type	Field and Description
static InitialPositionInStreamExtended	DEFAULT_POSITION_IN_STREAM Default position to begin consuming records from a Kinesis stream.

Method Summary

Modifier and Type	Method and Description
default StreamConfig	createStreamConfig(StreamIdentifier streamIdentifier) Returns a new StreamConfig for the provided stream identifier.
FormerStreamsLeasesDeletionStrategy	formerStreamsLeasesDeletionStrategy() Strategy to delete leases of old streams in the lease table.
boolean	isMultiStream() Returns true if this application should accommodate the consumption of more than one Kinesis stream.
default InitialPositionInStreamExtended	orphanedStreamInitialPositionInStream() The position for getting records from an "orphaned" stream that is in the lease table but not tracked Default assumes that the stream no longer need to be tracked, so use LATEST for faster shard end.
List<StreamConfig>	streamConfigList() Returns the list of stream config, to be processed by the current application.

Field Detail

DEFAULT_POSITION_IN_STREAM

static final InitialPositionInStreamExtended DEFAULT_POSITION_IN_STREAM

Default position to begin consuming records from a Kinesis stream.

See Also:

orphanedStreamInitialPositionInStream()

Method Detail

streamConfigList

List<StreamConfig> streamConfigList()

Returns the list of stream config, to be processed by the current application. Note that the streams list CAN be changed during the application runtime. This method will be called periodically by the KCL to learn about the change in streams to process.

Returns:

List of StreamConfig

formerStreamsLeasesDeletionStrategy

FormerStreamsLeasesDeletionStrategy formerStreamsLeasesDeletionStrategy()

Strategy to delete leases of old streams in the lease table. Note that the strategy CANNOT be changed during the application runtime.

Returns:

StreamsLeasesDeletionStrategy

orphanedStreamInitialPositionInStream

default InitialPositionInStreamExtended orphanedStreamInitialPositionInStream()

The position for getting records from an "orphaned" stream that is in the lease table but not tracked Default assumes that the stream no longer need to be tracked, so use LATEST for faster shard end.

Default value: InitialPositionInStream.LATEST

createStreamConfig

default StreamConfig createStreamConfig(StreamIdentifier streamIdentifier)

Returns a new StreamConfig for the provided stream identifier.

Parameters:

streamIdentifier - stream for which to create a new config

isMultiStream

boolean isMultiStream()

Returns true if this application should accommodate the consumption of more than one Kinesis stream.

This method must be consistent. Varying the returned value will have indeterminate, and likely problematic, effects on stream processing.