com.amazonaws.mobileconnectors.kinesis.kinesisrecorder

Class KinesisRecorderConfig

java.lang.Object

com.amazonaws.mobileconnectors.kinesis.kinesisrecorder.KinesisRecorderConfig

public class KinesisRecorderConfig
extends java.lang.Object

Allows configuration of certain KinesisRecorder parameters, such as maxStoargeSize.

Constructor Summary

Constructors

Constructor and Description
KinesisRecorderConfig() Construct an instance of KinesisRecorderConfig which has default values of maxStorageSize = 5MiB; and a default ClientConfiguration.
KinesisRecorderConfig(ClientConfiguration clientConfiguration) Construct an instance of KinesisRecorderConfig which has default values of maxStorageSize = 5MiB; and the specified ClientConfiguration.
KinesisRecorderConfig(KinesisRecorderConfig other) Creates a copy of the passed in KinesisRecorderConfig.

Method Summary

Modifier and Type	Method and Description
ClientConfiguration	getClientConfiguration() Returns the client configuration the Kinesis Recorder will use when making requests to Amazon Kinesis.
DeadLetterListener	getDeadLetterListener() Returns the DeadLetterListener that will respond to records being dropped.
long	getMaxStorageSize()
java.lang.String	getPartitionKey() Returns the partition key.
KinesisRecorderConfig	withDeadLetterListener(DeadLetterListener deadLetterListener) Sets the DeadLetterListener that will respond to records being dropped.
KinesisRecorderConfig	withMaxStorageSize(long maxStorage) Sets the max storage in bytes that KinesisRecorder is allowed to use.
KinesisRecorderConfig	withPartitionKey(java.lang.String partKey) Optionally set partition key.

Methods inherited from class java.lang.Object

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

Constructor Detail

KinesisRecorderConfig

public KinesisRecorderConfig()

Construct an instance of KinesisRecorderConfig which has default values of maxStorageSize = 5MiB; and a default ClientConfiguration.

KinesisRecorderConfig

public KinesisRecorderConfig(ClientConfiguration clientConfiguration)

Construct an instance of KinesisRecorderConfig which has default values of maxStorageSize = 5MiB; and the specified ClientConfiguration.

Parameters:

clientConfiguration - The client configuration used when making requests to Amazon Kinesis

KinesisRecorderConfig

public KinesisRecorderConfig(KinesisRecorderConfig other)

Creates a copy of the passed in KinesisRecorderConfig.

Parameters:

other - the KinesisRecorderConfig to copy.

Method Detail

withPartitionKey

public KinesisRecorderConfig withPartitionKey(java.lang.String partKey)

Optionally set partition key.

Parameters:

partKey - the partition key.

Returns:

This class for chaining

withMaxStorageSize

public KinesisRecorderConfig withMaxStorageSize(long maxStorage)

Sets the max storage in bytes that KinesisRecorder is allowed to use. Requests saved that exceed the max storage limit will be dropped.

Parameters:

maxStorage - the maximum storage.

Returns:

This class for chaining

getMaxStorageSize

public long getMaxStorageSize()

Returns:

The current max storage in bytes that KinesisRecorder is allowed to use.

getDeadLetterListener

public DeadLetterListener getDeadLetterListener()

Returns the DeadLetterListener that will respond to records being dropped.

Returns:

the DeadLetterListener that will respond to records being dropped.

withDeadLetterListener

public KinesisRecorderConfig withDeadLetterListener(DeadLetterListener deadLetterListener)

Sets the DeadLetterListener that will respond to records being dropped.

Parameters:

deadLetterListener - responds to records being dropped.

Returns:

This class for chaining.

getClientConfiguration

public ClientConfiguration getClientConfiguration()

Returns the client configuration the Kinesis Recorder will use when making requests to Amazon Kinesis.

Returns:

The client configuration

getPartitionKey

public java.lang.String getPartitionKey()

Returns the partition key.

Returns:

the partition key.