software.amazon.kinesis.retrieval

Class RetrievalConfig

java.lang.Object

software.amazon.kinesis.retrieval.RetrievalConfig

public class RetrievalConfig
extends Object

Used by the KCL to configure the retrieval of records from Kinesis.

Field Summary

Fields

Modifier and Type	Field and Description
static String	KINESIS_CLIENT_LIB_USER_AGENT User agent set when Amazon Kinesis Client Library makes AWS requests.
static String	KINESIS_CLIENT_LIB_USER_AGENT_VERSION

Constructor Summary

Constructors

Constructor and Description
RetrievalConfig(@NonNull software.amazon.awssdk.services.kinesis.KinesisAsyncClient kinesisAsyncClient, @NonNull software.amazon.awssdk.arns.Arn streamArn, @NonNull String applicationName)
RetrievalConfig(@NonNull software.amazon.awssdk.services.kinesis.KinesisAsyncClient kinesisAsyncClient, @NonNull StreamTracker streamTracker, @NonNull String applicationName)
RetrievalConfig(@NonNull software.amazon.awssdk.services.kinesis.KinesisAsyncClient kinesisAsyncClient, @NonNull String streamName, @NonNull String applicationName)

Method Summary

Modifier and Type	Method and Description
RetrievalConfig	initialPositionInStreamExtended(InitialPositionInStreamExtended initialPositionInStreamExtended) Deprecated. Initial stream position is now handled by StreamTracker.
RetrievalFactory	retrievalFactory()
RetrievalConfig	retrievalSpecificConfig(RetrievalSpecificConfig retrievalSpecificConfig)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

KINESIS_CLIENT_LIB_USER_AGENT

public static final String KINESIS_CLIENT_LIB_USER_AGENT

User agent set when Amazon Kinesis Client Library makes AWS requests.

See Also:

Constant Field Values

KINESIS_CLIENT_LIB_USER_AGENT_VERSION

public static final String KINESIS_CLIENT_LIB_USER_AGENT_VERSION

See Also:

Constant Field Values

Constructor Detail

RetrievalConfig

public RetrievalConfig(@NonNull
                       @NonNull software.amazon.awssdk.services.kinesis.KinesisAsyncClient kinesisAsyncClient,
                       @NonNull
                       @NonNull String streamName,
                       @NonNull
                       @NonNull String applicationName)

RetrievalConfig

public RetrievalConfig(@NonNull
                       @NonNull software.amazon.awssdk.services.kinesis.KinesisAsyncClient kinesisAsyncClient,
                       @NonNull
                       @NonNull software.amazon.awssdk.arns.Arn streamArn,
                       @NonNull
                       @NonNull String applicationName)

RetrievalConfig

public RetrievalConfig(@NonNull
                       @NonNull software.amazon.awssdk.services.kinesis.KinesisAsyncClient kinesisAsyncClient,
                       @NonNull
                       @NonNull StreamTracker streamTracker,
                       @NonNull
                       @NonNull String applicationName)

Method Detail

initialPositionInStreamExtended

@Deprecated
public RetrievalConfig initialPositionInStreamExtended(InitialPositionInStreamExtended initialPositionInStreamExtended)

Deprecated. Initial stream position is now handled by StreamTracker.

Convenience method to reconfigure the embedded StreamTracker, but only when not in multi-stream mode.

Parameters:

initialPositionInStreamExtended -

See Also:

StreamTracker.orphanedStreamInitialPositionInStream(), StreamTracker.createStreamConfig(StreamIdentifier)

retrievalSpecificConfig

public RetrievalConfig retrievalSpecificConfig(RetrievalSpecificConfig retrievalSpecificConfig)

retrievalFactory

public RetrievalFactory retrievalFactory()