com.kdgregory.logging.aws.kinesis

Class KinesisWriterConfig

java.lang.Object

com.kdgregory.logging.aws.internal.AbstractWriterConfig<KinesisWriterConfig>

com.kdgregory.logging.aws.kinesis.KinesisWriterConfig

All Implemented Interfaces:

Cloneable

public class KinesisWriterConfig
extends AbstractWriterConfig<KinesisWriterConfig>

Configuration for KinesisLogWriter.

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEFAULT_AUTO_CREATE
static long	DEFAULT_INITIALIZATION_TIMEOUT
static String	DEFAULT_PARTITION_KEY
static int	DEFAULT_SHARD_COUNT

Fields inherited from class com.kdgregory.logging.aws.internal.AbstractWriterConfig

DEFAULT_BATCH_DELAY, DEFAULT_DISCARD_ACTION, DEFAULT_DISCARD_THRESHOLD, DEFAULT_ENABLE_BATCH_LOGGING, DEFAULT_IS_SYNCHRONOUS, DEFAULT_TRUNCATE_OVERSIZE, DEFAULT_USE_SHUTDOWN_HOOK

Constructor Summary

Constructors

Constructor and Description
KinesisWriterConfig()

Method Summary

Modifier and Type	Method and Description
boolean	getAutoCreate()
String	getPartitionKey()
PartitionKeyHelper	getPartitionKeyHelper() Returns the object that manages partition keys; use this rather than directly accessing the key.
Integer	getRetentionPeriod()
int	getShardCount()
String	getStreamName()
KinesisWriterConfig	setAutoCreate(boolean value)
KinesisWriterConfig	setPartitionKey(String value)
KinesisWriterConfig	setRetentionPeriod(Integer value)
KinesisWriterConfig	setShardCount(int value)
KinesisWriterConfig	setStreamName(String value)
List<String>	validate() Validates the configuration, returning a list of any validation errors.

Methods inherited from class com.kdgregory.logging.aws.internal.AbstractWriterConfig

clone, getAssumedRole, getBatchDelay, getClientEndpoint, getClientFactoryMethod, getClientRegion, getDiscardAction, getDiscardThreshold, getEnableBatchLogging, getInitializationTimeout, getSynchronousMode, getTruncateOversizeMessages, getUseShutdownHook, setAssumedRole, setBatchDelay, setClientEndpoint, setClientFactoryMethod, setClientRegion, setDiscardAction, setDiscardThreshold, setEnableBatchLogging, setInitializationTimeout, setSynchronousMode, setTruncateOversizeMessages, setUseShutdownHook

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_INITIALIZATION_TIMEOUT

public static final long DEFAULT_INITIALIZATION_TIMEOUT

See Also:

Constant Field Values

DEFAULT_PARTITION_KEY

public static final String DEFAULT_PARTITION_KEY

See Also:

Constant Field Values

DEFAULT_AUTO_CREATE

public static final boolean DEFAULT_AUTO_CREATE

See Also:

Constant Field Values

DEFAULT_SHARD_COUNT

public static final int DEFAULT_SHARD_COUNT

See Also:

Constant Field Values

Constructor Detail

KinesisWriterConfig

public KinesisWriterConfig()

Method Detail

getStreamName

public String getStreamName()

setStreamName

public KinesisWriterConfig setStreamName(String value)

getPartitionKey

public String getPartitionKey()

setPartitionKey

public KinesisWriterConfig setPartitionKey(String value)

getAutoCreate

public boolean getAutoCreate()

setAutoCreate

public KinesisWriterConfig setAutoCreate(boolean value)

getShardCount

public int getShardCount()

setShardCount

public KinesisWriterConfig setShardCount(int value)

getRetentionPeriod

public Integer getRetentionPeriod()

setRetentionPeriod

public KinesisWriterConfig setRetentionPeriod(Integer value)

validate

public List<String> validate()

Validates the configuration, returning a list of any validation errors. An empty list indicates a valid config.

getPartitionKeyHelper

public PartitionKeyHelper getPartitionKeyHelper()

Returns the object that manages partition keys; use this rather than directly accessing the key.