com.kdgregory.log4j.aws.internal.kinesis

Class KinesisWriterConfig

java.lang.Object

com.kdgregory.log4j.aws.internal.kinesis.KinesisWriterConfig

public class KinesisWriterConfig
extends Object

Holds configuration for the LogWriter. This is a simple struct, with writable fields (because config can change). It is not exposed to the outside world.

Field Summary

Fields

Modifier and Type	Field and Description
boolean	autoCreate
long	batchDelay
String	clientEndpoint
String	clientFactoryMethod
MessageQueue.DiscardAction	discardAction
int	discardThreshold
String	partitionKey
int	partitionKeyLength
Integer	retentionPeriod
int	shardCount
String	streamName

Constructor Summary

Constructors

Constructor and Description
KinesisWriterConfig(String streamName, String partitionKey, int partitionKeyLength, long batchDelay, int discardThreshold, MessageQueue.DiscardAction discardAction, String clientFactoryMethod, String clientEndpoint, boolean autoCreate, int shardCount, Integer retentionPeriod)

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

streamName

public String streamName

partitionKey

public String partitionKey

partitionKeyLength

public int partitionKeyLength

batchDelay

public long batchDelay

discardThreshold

public int discardThreshold

discardAction

public MessageQueue.DiscardAction discardAction

clientFactoryMethod

public String clientFactoryMethod

clientEndpoint

public String clientEndpoint

autoCreate

public boolean autoCreate

shardCount

public int shardCount

retentionPeriod

public Integer retentionPeriod

Constructor Detail

KinesisWriterConfig

public KinesisWriterConfig(String streamName,
                           String partitionKey,
                           int partitionKeyLength,
                           long batchDelay,
                           int discardThreshold,
                           MessageQueue.DiscardAction discardAction,
                           String clientFactoryMethod,
                           String clientEndpoint,
                           boolean autoCreate,
                           int shardCount,
                           Integer retentionPeriod)

Parameters:

streamName - Name of the stream where messages will be written.

partitionKey - Partition key for messages written to stream. If blank we'll generate a random partition key for each message.

partitionKeyLength - Length of the partition key in bytes, after conversion to UTF-8. Used to calculate message packing.

batchDelay - Number of milliseconds to wait for messages to be ready to send.

discardThreshold - Maximum number of messages to retain if unable to send.

discardAction - What to do with unsent messages over the threshold.

clientFactoryMethod - Possibly-null FQN of a static method to create client.

clientEndpoint - Possibly-null endpoint for client.

autoCreate - If true, stream will be created if it doesn't already exist. If false, writer will fail to start.

shardCount - Number of shards to use when creating the stream (ignored if stream already exists).

retentionPeriod - Retention period to use when creating the stream (ignored if stream already exists); null indicates use the default retention period.